Skip to content

Commit 3c0dd77

Browse files
committed
Add documentation reference to the README.
1 parent 4e5548e commit 3c0dd77

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ torch-optimizer
1515
:target: https://deepsource.io/gh/jettify/pytorch-optimizer/?ref=repository-badge
1616

1717

18-
**torch-optimizer** -- collection of optimizers for PyTorch_.
19-
18+
**torch-optimizer** -- collection of optimizers for PyTorch_ compatible with optim_
19+
module.
2020

2121

2222
Simple example
@@ -38,6 +38,11 @@ Installation process is simple, just::
3838
$ pip install torch_optimizer
3939

4040

41+
Documentation
42+
-------------
43+
https://pytorch-optimizer.rtfd.io
44+
45+
4146
Supported Optimizers
4247
====================
4348

@@ -643,3 +648,4 @@ SGD (PyTorch built-in)
643648
.. _Rastrigin: https://en.wikipedia.org/wiki/Rastrigin_function
644649
.. _Rosenbrock: https://en.wikipedia.org/wiki/Rosenbrock_function
645650
.. _benchmark: https://en.wikipedia.org/wiki/Test_functions_for_optimization
651+
.. _optim: https://pytorch.org/docs/stable/optim.html

0 commit comments

Comments
 (0)