Skip to content

Commit 57dc6e9

Browse files
committed
add soap utils to doc
Signed-off-by: Hao Wu <skyw@nvidia.com>
1 parent ceb15ec commit 57dc6e9

2 files changed

Lines changed: 12 additions & 1 deletion

File tree

docs/apidocs/soap.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,15 @@ emerging_optimizers.soap
2121
.. autofunction:: update_kronecker_factors
2222
2323
.. autofunction:: update_eigenbasis_and_momentum
24+
25+
emerging_optimizers.soap.soap_utils
26+
=====================================
27+
28+
.. automodule:: emerging_optimizers.soap.soap_utils
29+
:members:
30+
31+
.. autofunction:: _orthogonal_iteration
32+
33+
.. autofunction:: _conjugate
34+
2435
```

emerging_optimizers/soap/soap_utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ def get_eigenbasis_qr(
129129
130130
Args:
131131
kronecker_factor_list: List containing preconditioner (:math:`GG^T` and :math:`G^TG`)
132-
eigenbasis_list: List containing eigenbases (:math:`QL` and :math:`QR`)
132+
eigenbasis_list: List containing eigenbases (:math:`Q_L` and :math:`Q_R`)
133133
exp_avg_sq: inner adam second moment (exp_avg_sq). This tensor is modified in-place.
134134
convert_to_float: If True, preconditioner matrices and their corresponding
135135
orthonormal matrices will be cast to float. Otherwise, they are left in

0 commit comments

Comments
 (0)