Add python doc

rapidsai · Nov 11, 2024 · 80dafb9 · 80dafb9
1 parent 288ea20
commit 80dafb9
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/cpp/include/raft/sparse/solver/lanczos_types.hpp b/cpp/include/raft/sparse/solver/lanczos_types.hpp
@@ -22,10 +22,15 @@ namespace raft::sparse::solver {
 
 template <typename ValueTypeT>
 struct lanczos_solver_config {
+  /** The number of eigenvalues and eigenvectors to compute. Must be 1 <= k < n.*/
   int n_components;
+  /** Maximum number of iteration. */
   int max_iterations;
+  /** The number of Lanczos vectors generated. Must be k + 1 < ncv < n. */
   int ncv;
+  /** Tolerance for residuals ``||Ax - wx||`` */
   ValueTypeT tolerance;
+  /** random seed */
   uint64_t seed;
 };
 

diff --git a/docs/source/pylibraft_api.rst b/docs/source/pylibraft_api.rst
@@ -13,3 +13,4 @@ Python API
    pylibraft_api/matrix.rst
    pylibraft_api/neighbors.rst
    pylibraft_api/random.rst
+   pylibraft_api/sparse.rst
diff --git a/docs/source/pylibraft_api/sparse.rst b/docs/source/pylibraft_api/sparse.rst
@@ -0,0 +1,11 @@
+Sparse
+======
+
+This page provides pylibraft class references for the publicly-exposed elements of the `pylibraft.sparse.linalg.eigsh` package.
+
+
+.. role:: py(code)
+   :language: python
+   :class: highlight
+
+.. autofunction:: pylibraft.sparse.linalg.eigsh