Skip to content

Commit 587dd9c

Browse files
committed
adjusting .gitignore
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
1 parent 333f7ec commit 587dd9c

4 files changed

Lines changed: 69 additions & 1 deletion

File tree

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,6 @@ instance/
8888

8989
# Sphinx documentation
9090
docs/_build
91-
docs/apidocs
9291

9392
# PyBuilder
9493
target/

docs/apidocs/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# API Reference
2+
3+
NeMo Emerging Optimizers API reference provides comprehensive technical documentation for all modules, classes, and functions.
4+
5+
```{toctree}
6+
:caption: API Documentation
7+
:hidden:
8+
9+
utils.md
10+
orthogonalized-optimizers.md
11+
```
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
```{eval-rst}
2+
.. role:: hidden
3+
:class: hidden-section
4+
5+
emerging_optimizers.orthogonalized_optimizers
6+
=============================================
7+
8+
.. automodule:: emerging_optimizers.orthogonalized_optimizers
9+
.. currentmodule:: emerging_optimizers.orthogonalized_optimizers
10+
11+
:hidden:`OrthogonalizedOptimizer`
12+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13+
14+
.. autoclass:: OrthogonalizedOptimizer
15+
:members:
16+
17+
:hidden:`Muon`
18+
~~~~~~~~~~~~~~~
19+
20+
.. autoclass:: Muon
21+
:members:
22+
23+
24+
:hidden:`Newton-Schulz`
25+
~~~~~~~~~~~~~~~~~~~~~~~~
26+
.. automodule:: emerging_optimizers.orthogonalized_optimizers.muon_utils
27+
.. currentmodule:: emerging_optimizers.orthogonalized_optimizers.muon_utils
28+
29+
.. autofunction:: newton_schulz
30+
.. autofunction:: newton_schulz_step
31+
.. autofunction:: newton_schulz_tp
32+
```

docs/apidocs/utils.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2+
```{eval-rst}
3+
.. role:: hidden
4+
:class: hidden-section
5+
6+
emerging_optimizers.utils
7+
==========================
8+
9+
.. automodule:: emerging_optimizers.utils
10+
.. currentmodule:: emerging_optimizers.utils
11+
12+
:hidden:`fp32_matmul_precision`
13+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14+
15+
.. autofunction:: fp32_matmul_precision
16+
17+
:hidden:`get_pg_size`
18+
~~~~~~~~~~~~~~~~~~~~~
19+
20+
.. autofunction:: get_pg_size
21+
22+
:hidden:`get_pg_rank`
23+
~~~~~~~~~~~~~~~~~~~~~
24+
25+
.. autofunction:: get_pg_rank
26+
```

0 commit comments

Comments
 (0)