Skip to content

Commit

Permalink
Add documentation reference to the README.
Browse files Browse the repository at this point in the history
  • Loading branch information
jettify committed Jun 17, 2020
1 parent 4e5548e commit 3c0dd77
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ torch-optimizer
:target: https://deepsource.io/gh/jettify/pytorch-optimizer/?ref=repository-badge


**torch-optimizer** -- collection of optimizers for PyTorch_.

**torch-optimizer** -- collection of optimizers for PyTorch_ compatible with optim_
module.


Simple example
Expand All @@ -38,6 +38,11 @@ Installation process is simple, just::
$ pip install torch_optimizer


Documentation
-------------
https://pytorch-optimizer.rtfd.io


Supported Optimizers
====================

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

0 comments on commit 3c0dd77

Please sign in to comment.