refactor rocALUTION documentation #211
Conversation
| ------------- | ||
| 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 |
There was a problem hiding this comment.
"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.
| 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. |
There was a problem hiding this comment.
"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?
There was a problem hiding this comment.
No, should be https://github.com/ROCmSoftwarePlatform/rocALUTION instead
| @@ -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 | |||
There was a problem hiding this comment.
.. doxygenfunction:: rocalution::ParallelManager::GetGlobalSize
and
.. doxygenfunction:: rocalution::ParallelManager::GetLocalSize
can't be traced in the doxy file. Need to check the correct syntax.
| @@ -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 | |||
| ---------------- | |||
There was a problem hiding this comment.
.. doxygenfunction:: rocalution::ParallelManager::SetGlobalSize
and
.. doxygenfunction:: rocalution::ParallelManager::SetLocalSize
can't be traced in the doxy file, Need to check the correct syntax.
| ============================= | ||
|
|
||
| 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. |
There was a problem hiding this comment.
"rocalution::Preconditioner::Clear()" cannot be resolved.
| ================ | ||
|
|
||
| .. doxygenclass:: rocalution::RugeStuebenAMG | ||
| .. doxygenfunction:: rocalution::RugeStuebenAMG::SetCouplingStrength |
There was a problem hiding this comment.
"rocalution::RugeStuebenAMG::SetCouplingStrength" cannot be resolved.
| .. 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** |
There was a problem hiding this comment.
SetRandomNormal and ExclusiveScan cannot be resolved.
| @@ -336,11 +345,11 @@ File I/O | |||
| Access | |||
| ====== | |||
|
|
|||
| .. doxygenfunction:: rocalution::LocalVector::operator[](int) | |||
| .. doxygenfunction:: rocalution::LocalVector::&operator[](int) | |||
There was a problem hiding this comment.
rocalution::LocalVector::&operator cannot be resolved.
|
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. |
|
@lpaoletti Please review. |
|
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>
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.