Add document for soap (#21)

skyw · web-flow · commit e40fce8eadfd · 2025-09-25T09:04:47.000-07:00
* add document for soap

Signed-off-by: Hao Wu &lt;skyw@nvidia.com&gt;
diff --git a/docs/apidocs/index.md b/docs/apidocs/index.md
@@ -8,4 +8,6 @@ NeMo Emerging Optimizers API reference provides comprehensive technical document
 
 utils.md
 orthogonalized-optimizers.md
+soap.md
+scalar-optimizers.md
 ```
diff --git a/docs/apidocs/scalar-optimizers.md b/docs/apidocs/scalar-optimizers.md
@@ -0,0 +1,10 @@
+```{eval-rst}
+.. role:: hidden
+    :class: hidden-section
+
+emerging_optimizers.scalar_optimizers
+=====================================
+
+.. automodule:: emerging_optimizers.scalar_optimizers
+    :members:
+```
diff --git a/docs/apidocs/soap.md b/docs/apidocs/soap.md
@@ -0,0 +1,24 @@
+```{eval-rst}
+.. role:: hidden
+    :class: hidden-section
+
+emerging_optimizers.soap
+===================================
+
+.. automodule:: emerging_optimizers.soap.soap
+.. currentmodule:: emerging_optimizers.soap.soap
+
+:hidden:`SOAP`
+~~~~~~~~~~~~~~~
+
+.. autoclass:: SOAP
+    :members:
+
+.. autofunction:: precondition
+
+.. autofunction:: init_kronecker_factors
+
+.. autofunction:: update_kronecker_factors
+
+.. autofunction:: update_eigenbasis_and_momentum
+```
diff --git a/docs/apidocs/utils.md b/docs/apidocs/utils.md
@@ -7,20 +7,11 @@ emerging_optimizers.utils
 ==========================
 
 .. automodule:: emerging_optimizers.utils
-.. currentmodule:: emerging_optimizers.utils
+    :members:
 
-:hidden:`fp32_matmul_precision`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autofunction:: fp32_matmul_precision
-
-:hidden:`get_pg_size`
-~~~~~~~~~~~~~~~~~~~~~
-
-.. autofunction:: get_pg_size
-
-:hidden:`get_pg_rank`
-~~~~~~~~~~~~~~~~~~~~~
-
-.. autofunction:: get_pg_rank
+emerging_optimizers.utils.eig
+=============================
+.. automodule:: emerging_optimizers.utils.eig
+    :members:
 ```
