Skip to content

Commit 24f6d38

Browse files
committed
[skip ci] docs: api documentation
1 parent c394b21 commit 24f6d38

File tree

1 file changed

+107
-3
lines changed

1 file changed

+107
-3
lines changed

docs/api.rst

Lines changed: 107 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,23 +62,23 @@ AGC
6262
diffGrad
6363
--------
6464

65-
.. autoclass:: pytorch_optimizer.diffGrad
65+
.. autoclass:: pytorch_optimizer.DiffGrad
6666
:members:
6767

6868
.. _diffRGrad:
6969

7070
diffRGrad
7171
---------
7272

73-
.. autoclass:: pytorch_optimizer.diffRGrad
73+
.. autoclass:: pytorch_optimizer.DiffRGrad
7474
:members:
7575

7676
.. _GC:
7777

7878
GC
7979
--
8080

81-
.. autoclass:: pytorch_optimizer.gradient_centralization
81+
.. autoclass:: pytorch_optimizer.centralize_gradient
8282
:members:
8383

8484
.. _Lamb:
@@ -88,3 +88,107 @@ Lamb
8888

8989
.. autoclass:: pytorch_optimizer.Lamb
9090
:members:
91+
92+
.. _LARS:
93+
94+
LARS
95+
----
96+
97+
.. autoclass:: pytorch_optimizer.LARS
98+
:members:
99+
100+
.. _Lookahead:
101+
102+
Lookahead
103+
---------
104+
105+
.. autoclass:: pytorch_optimizer.Lookahead
106+
:members:
107+
108+
.. _MADGRAD:
109+
110+
MADGRAD
111+
-------
112+
113+
.. autoclass:: pytorch_optimizer.MADGRAD
114+
:members:
115+
116+
.. _Nero:
117+
118+
Nero
119+
----
120+
121+
.. autoclass:: pytorch_optimizer.Nero
122+
:members:
123+
124+
.. _PCGrad:
125+
126+
PCGrad
127+
------
128+
129+
.. autoclass:: pytorch_optimizer.PCGrad
130+
:members:
131+
132+
.. _PNM:
133+
134+
PNM
135+
---
136+
137+
.. autoclass:: pytorch_optimizer.PNM
138+
:members:
139+
140+
.. _RAdam:
141+
142+
RAdam
143+
-----
144+
145+
.. autoclass:: pytorch_optimizer.RAdam
146+
:members:
147+
148+
.. _RaLamb:
149+
150+
RaLamb
151+
------
152+
153+
.. autoclass:: pytorch_optimizer.RaLamb
154+
:members:
155+
156+
.. _Ranger:
157+
158+
Ranger
159+
------
160+
161+
.. autoclass:: pytorch_optimizer.Ranger
162+
:members:
163+
164+
.. _Ranger21:
165+
166+
Ranger21
167+
--------
168+
169+
.. autoclass:: pytorch_optimizer.Ranger21
170+
:members:
171+
172+
.. _SAM:
173+
174+
SAM
175+
---
176+
177+
.. autoclass:: pytorch_optimizer.SAM
178+
:members:
179+
180+
.. _SGDP:
181+
182+
SGDP
183+
----
184+
185+
.. autoclass:: pytorch_optimizer.SGDP
186+
:members:
187+
188+
.. _Shampoo:
189+
190+
Shampoo
191+
-------
192+
193+
.. autoclass:: pytorch_optimizer.Shampoo
194+
:members:

0 commit comments

Comments
 (0)