refactor rocALUTION documentation #211

SwRaw · 2024-03-29T08:37:03Z

Refactoring all libraries to adhere to the documentation standards that includes following home page format, index style, language improvements, link fixes, navigation, and overall content readability improvements.

SwRaw · 2024-03-29T08:40:54Z

docs/usermanual/linux-installation.rst

 -------------
 Prerequisites
 -------------

- A ROCm enabled platform. `ROCm Documentation <https://rocm.docs.amd.com/>`_ has more information on
-  supported GPUs, Linux distributions, and Windows SKUs. It also has information on how to install ROCm.
+A ROCm enabled platform. For information on supported GPUs, Linux distributions, ROCm installation, and Windows SKUs, refer to `ROCm Documentation <https://rocm.docs.amd.com/>`_.

 -----------------------------
 Installing pre-built packages


"rocALUTION can be installed from AMD ROCm repository <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/tutorial/quick-start.html>_. " The link doesn't look right.

SwRaw · 2024-03-29T12:15:16Z

docs/usermanual/windows-installation.rst

 directory. Only use these two installed files when needed in user code.

 ----------------------------------
-Building and Installing rocALUTION
+Building and installing rocALUTION
 ----------------------------------

 Building from source is not necessary, as rocALUTION can be used after installing the pre-built packages as described above.


"The rocALUTION source code, which is the same as for the ROCm linux distributions, is available at the rocALUTION github page <https://github.com/ROCmSoftwarePlatform/rocSPARSE>_." Is this link correct?

No, should be https://github.com/ROCmSoftwarePlatform/rocALUTION instead

SwRaw · 2024-04-03T12:10:43Z

docs/usermanual/multinode.rst

@@ -147,7 +152,7 @@ When the parallel manager, global matrix or global vector are writing to a file,
  rhs.dat.rank.2
  rhs.dat.rank.3

-Parallel Manager
+Parallel manager


.. doxygenfunction:: rocalution::ParallelManager::GetGlobalSize
and
.. doxygenfunction:: rocalution::ParallelManager::GetLocalSize
can't be traced in the doxy file. Need to check the correct syntax.

SwRaw · 2024-04-03T12:12:10Z

docs/usermanual/multinode.rst

@@ -147,7 +152,7 @@ When the parallel manager, global matrix or global vector are writing to a file,
  rhs.dat.rank.2
  rhs.dat.rank.3

-Parallel Manager
+Parallel manager
 ----------------


.. doxygenfunction:: rocalution::ParallelManager::SetGlobalSize
and
.. doxygenfunction:: rocalution::ParallelManager::SetLocalSize
can't be traced in the doxy file, Need to check the correct syntax.

SwRaw · 2024-04-08T09:09:56Z

docs/api/solvers.rst

 =============================
+
 The :cpp:func:`rocalution::Solver::Clear` function clears all the data which is in the solver, including the associated preconditioner. Thus, the solver is not anymore associated with this preconditioner.

 .. note:: The preconditioner is not deleted (via destructor), only a :cpp:func:`rocalution::Preconditioner::Clear` is called.


"rocalution::Preconditioner::Clear()" cannot be resolved.

SwRaw · 2024-04-08T09:32:07Z

docs/api/solvers.rst

 ================
+
 .. doxygenclass:: rocalution::RugeStuebenAMG
 .. doxygenfunction:: rocalution::RugeStuebenAMG::SetCouplingStrength


"rocalution::RugeStuebenAMG::SetCouplingStrength" cannot be resolved.

SwRaw · 2024-04-09T10:18:30Z

docs/design/functable.rst

-.. note:: If the input matrix is not a CSR matrix, an internal conversion will be performed to CSR format, followed by a back conversion to the previous format after the operation.
-          In this case, a warning message on verbosity level 2 will be printed.
+.. note:: If the input matrix is not a CSR matrix, an internal conversion is performed to CSR format, followed by a back conversion to the previous format after the operation.
+          In this case, a warning message on verbosity level 2 is printed.

 ==================================================================================== =============================================================================== ======== =======
 **LocalMatrix function**                                                             **Comment**                                                                     **Host** **HIP**


SetRandomNormal and ExclusiveScan cannot be resolved.

SwRaw · 2024-04-09T15:18:19Z

docs/usermanual/singlenode.rst

@@ -336,11 +345,11 @@ File I/O
 Access
 ======

-.. doxygenfunction:: rocalution::LocalVector::operator[](int)
+.. doxygenfunction:: rocalution::LocalVector::&operator[](int)


rocalution::LocalVector::&operator cannot be resolved.

SwRaw · 2024-04-10T11:08:04Z

There is a lot of repetition of API content. As we call the same doxyfunction at many places. The solvers and preconditioners are individual files while being a part of API as well. I tried to remove the solvers and preconditioners from API library with a reference to the respective file but then realized that there are many cross-references to the solvers/preconditioners in the API library. Removing these would lead to many broken links so I am keeping them. I still feel the entire documentation needs a lot of rework to remove/reduce redundant content. Instead of calling the doxyfunction, call them at one place and add links to all other places where they are needed.

SwRaw · 2024-04-11T05:35:51Z

@lpaoletti Please review.

jsandham · 2024-04-19T19:47:20Z

This is a great start. Approved.

* refactor rocALUTION * refactor * refactor * refactor * refactor * Update clients.rst * Update singlenode.rst * refactor * Update singlenode.rst * refactor * refactor * Update singlenode.rst * Update singlenode.rst * Update singlenode.rst * Update singlenode.rst * Update singlenode.rst * refactor * Update singlenode.rst * Update linux-installation.rst * refactor * Update windows-installation.rst * refactor doc * refactor doc * Update linux-installation.rst * refactor doc review * Update _toc.yml.in * Update LICENSE.md

* Update links (#238) * Update links * Update Linux_Install_Guide.rst * refactor rocALUTION documentation (#211) * refactor rocALUTION * refactor * refactor * refactor * refactor * Update clients.rst * Update singlenode.rst * refactor * Update singlenode.rst * refactor * refactor * Update singlenode.rst * Update singlenode.rst * Update singlenode.rst * Update singlenode.rst * Update singlenode.rst * refactor * Update singlenode.rst * Update linux-installation.rst * refactor * Update windows-installation.rst * refactor doc * refactor doc * Update linux-installation.rst * refactor doc review * Update _toc.yml.in * Update LICENSE.md --------- Co-authored-by: Lisa <lisajdelaney@gmail.com> Co-authored-by: srawat <120587655+SwRaw@users.noreply.github.com>

* PMIS MPI support (ROCm#100) * mpi to hip backend * MPI enablement for PMIS * MPI RS example * clang-format * example * fix * global Ext+I interpolation (ROCm#112) * unused function * Added PM as argument for aggregation function * added pm for each level to MG class * Added PM as argument for aggregation function ROCm#2 * Added PM as argument for aggregation function ROCm#3 * RS Ext+I added to global matrix * modified example to dump some data for validation - work in progress * RS Ext+I function added to headers * RS Ext+I HIP implementation * RS Ext+I host implementation * Improved PM * global Ext+I kernel update * some multinode improvements (ROCm#118) * added some more useful guards to parallel manager * added CopyFromHostData, CopyToHostData, ExclusiveSum and Sort functionality for vector class ; moved boundary information from vector to matrix ; added GetFormat() to GlobalMatrix class * clang-format * P and R should be OperatorType, not LocalMatrix * clang-format * check if PM is valid when required * added extra function for triple matrix product for simplicity * clang-format * clang-format * skip free when ptr is nullptr * fix memory leak in BaseAMG class * rocsparse_csrgeam added * renamed csr ext+i kernel because it is generally usable * allowing CSR zero matrices with row_offset != nullptr, as well as zero vectors with size == 0 * clang-format * duplicated row column entries throw a warning * copy_x2x() functions added for readability and simplicity * search and replace memcpy with copy fct * search and replace memcpy with copy fct ROCm#2 ; fix for random csr generator to not generate duplicated row col entries * clang-format * fixes * those asserts are wrong * major version bump * OpenMP parallel loop threshold need to be int64_t in order to work with larger structures * Allow basic structures with 64bit entries, e.g. for global indices * nnz should be 64bit ; also restructured RSAMG for readability * vector size need to be 64bit locally - also added inclusive and exclusive sum functionality * 64bit sizes for stencils * host vector implementation changes for 64bit sizes and in/exclusive sum ; host I/O changed to always write 64bit sizes * host stencil 64bit changes * max residual index changed to 64bit accordingly * solvers adjusted for 64bit nnz * int64_t to double conversion * allocation size should always be 64bit ; also added copy_h2h() for simplicity * long and long long communication support added * cleaned up types ; IndexType2 was a stupid name anyway * removed deprecations (major release); enabled global structure support in RSAMG * major changes to PM; added guards for transfers; removed deprecations; fixed int overflows; functionality to generate a PM from global ghost column ids, and a parent PM * matrix conversions 64bit nnz support with guards * host matrix I/O changed to always write 64bit sizes ; backward compatible * host matrix implementations changed to 64bit nnz * RSAMG restructured - global communication should not happen in local implementations ; switched to 64bit sizes * host CSR matrix implementation * hip implementation ; added copy_d2h/h2d/d2d for simplicity, with async flag * adjusted unit tests to removed deprecated functions * RSAMG MPI example updated * fixed sanity assert * doc update * example should work with only 1 process * global routines should work with single process * global transpose operator * using copy_h2h() * _rocalution_sync should force a global barrier, too * improved asynchronous apply / comm / halo apply * accelerator must be available for pinned alloc/free * fixing few compiler warnings * readability * removed the flood of printf on multi gpu systems * adjusted openmp nested (deprecation) to v5.0 * weak scaling examples * distributed laplacian generator * updated rsamg example * updated rsamg mpi example * should use OperatorType, nothing else * fixed RSDirectInterpolation(); fixed const PM issue * updated unit tests * types.hpp generated by cmake ; CSR(64/32) added on host ; moved RSPMIS communication into global matrix class * removed old types.hpp * initial implementation for unordered set and map on hip backend * outsourced RSAMG to improve compilation performance; added async communication for multinode; moved multinode rspmis into globalmatrix; outsourced atomics * clang-format * fix for streams when not building for mpi * SA amg merge fix * fixed missing shared memory size * clang-format * clang-format * typo * clang format * add blockdim to UAAMG benchmark * adjusting unit tests for removed deprecated functions * clang format * test fix * clang-format * std::sort required algorithm header * fixing merge error * merge fix ROCm#2 * header cleaned up * header cleaned up ROCm#2 * fix issue with HIP not being found * free_pinned() does nothing on nullptr * global triple matrix product * proper error message when coarsening fails * fixed a bug in global triplematrixproduct * fixed a typo * fixed compilation issue when HIP=off * fixes COO and CSR conversions on both host and device, and ELL on host only (ROCm#211) * empty matrix conversion fix * host fallback fix for rsamg and triplematprod * Fix documentation failures (ROCm#214) Co-authored-by: jsandham <james.sandham@amd.com> * Add Smoothed Aggregation to amgmpi branch (ROCm#213) * Adding global aggregation to SAAMG (ROCm#166) Co-authored-by: jsandham <james.sandham@amd.com> * Add MPI support for global prolongation to SAAMG (ROCm#171) Co-authored-by: jsandham <james.sandham@amd.com> * Add MPI support for SAAMG global transpose (ROCm#172) * Add MPI support for SAAMG global transpose * Fix failures in greedy aggregation caused by unfilled aggregate_root_nodes array --------- Co-authored-by: jsandham <james.sandham@amd.com> * Add MPI unsmoothed aggregation (ROCm#174) Co-authored-by: jsandham <james.sandham@amd.com> * Adding debug printing to test triple product * Adding debug print statements for testing * Adding more debug printing * Testing * Testing * Testing * Testing * Testing * Testing * Testing * Testing * Testing * Fix floating point fault caused by division by zero * Testing * Testing * Testing * Testing * Testing * Testing * Testing * Fix failures in local matrix when max_nnz_per_row is too high * Testing * Fix bug where we were not using a large enough hash table size * Fix discrepency in host and hip assert in ExtractSubMatrix * Fixing hangs in multinode hip backend * Fix RSAMG documentation warnings * Testing MPI uaamg * Fix testing_local_matrix failure * Remove comments and temporary testing code * PR fixes * PR fixes * PR fixes * Clang formatting --------- Co-authored-by: jsandham <james.sandham@amd.com> * removed unused variables * Add back functions that cannot be removed until next major release (ROCm#216) Co-authored-by: jsandham <james.sandham@amd.com> * fix for very large sizes where local ext matrix exceeds int32 * Remove print statements from saamg testing file --------- Co-authored-by: James Sandham <33790278+jsandham@users.noreply.github.com> Co-authored-by: jsandham <james.sandham@amd.com>

refactor rocALUTION

3ca6463

SwRaw commented Mar 29, 2024

View reviewed changes

SwRaw added 2 commits March 29, 2024 21:13

refactor

454f137

refactor

5fe0c04

SwRaw commented Apr 3, 2024

View reviewed changes

refactor

bf7cd7b

SwRaw commented Apr 8, 2024

View reviewed changes

refactor

27d865a

SwRaw commented Apr 9, 2024

View reviewed changes

Update clients.rst

112bb42

SwRaw marked this pull request as ready for review April 9, 2024 14:51

SwRaw requested review from a team, YvanMokwinski and jsandham as code owners April 9, 2024 14:51

Update singlenode.rst

df331f1

SwRaw commented Apr 9, 2024

View reviewed changes

SwRaw added 11 commits April 9, 2024 21:11

refactor

a3843f0

Update singlenode.rst

e388c71

refactor

a446a42

refactor

65cc4bd

Update singlenode.rst

1181acb

Update singlenode.rst

de2cc73

Update singlenode.rst

cbb2181

Update singlenode.rst

62980ed

Update singlenode.rst

ea250fd

refactor

7cb3819

Update singlenode.rst

8c9777d

Update linux-installation.rst

8534963

refactor

f2c919c

cgmb changed the title ~~refactor rocALUTION~~ refactor rocALUTION documentation Apr 10, 2024

SwRaw requested a review from lpaoletti April 11, 2024 05:36

SwRaw added 7 commits April 12, 2024 10:20

Update windows-installation.rst

41e7635

refactor doc

6941a8a

refactor doc

92b52f4

Update linux-installation.rst

f53b824

refactor doc review

17aec46

Update _toc.yml.in

37f1c93

Update LICENSE.md

b20cd8b

YvanMokwinski approved these changes Apr 19, 2024

View reviewed changes

jsandham approved these changes Apr 19, 2024

View reviewed changes

yhuiYH added the noCI Don't run CI on this PR label Apr 19, 2024

ntrost57 approved these changes Apr 23, 2024

View reviewed changes

ntrost57 merged commit c71fbd2 into ROCm:develop Apr 23, 2024
16 checks passed

SwRaw deleted the swat_rocks branch June 1, 2024 13:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor rocALUTION documentation #211

refactor rocALUTION documentation #211

SwRaw commented Mar 29, 2024

SwRaw Mar 29, 2024

SwRaw Mar 29, 2024

ntrost57 Apr 8, 2024

SwRaw Apr 12, 2024

SwRaw Apr 3, 2024

SwRaw Apr 3, 2024

SwRaw Apr 8, 2024

SwRaw Apr 8, 2024

SwRaw Apr 9, 2024

SwRaw Apr 9, 2024

SwRaw commented Apr 10, 2024

SwRaw commented Apr 11, 2024

jsandham commented Apr 19, 2024

refactor rocALUTION documentation #211

refactor rocALUTION documentation #211

Conversation

SwRaw commented Mar 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SwRaw commented Apr 10, 2024

SwRaw commented Apr 11, 2024

jsandham commented Apr 19, 2024