Skip to content

Commit 8de62f5

Browse files
authored
Merge pull request #61 from kozistr/docs/readme
[Docs] README
2 parents 3b43172 + 7d73e7c commit 8de62f5

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.rst

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
1+
=================
12
pytorch-optimizer
23
=================
34

4-
| |workflow| |codecov| |Documentation Status| |PyPI version| |PyPi download| |black|
5-
6-
| Bunch of optimizer implementations in PyTorch with clean-code, strict types. Also, including useful optimization ideas.
5+
+--------------+------------------------------------------+
6+
| Build | |workflow| |Documentation Status| |
7+
+--------------+------------------------------------------+
8+
| Quality | |codecov| |black| |
9+
+--------------+------------------------------------------+
10+
| Package | |PyPI version| |PyPI pyversions| |
11+
+--------------+------------------------------------------+
12+
| Status | |PyPi download| |
13+
+--------------+------------------------------------------+
14+
15+
| **pytorch-optimizer** is bunch of optimizer collections in PyTorch. Also, including useful optimization ideas.
716
| Most of the implementations are based on the original paper, but I added some tweaks.
817
| Highly inspired by `pytorch-optimizer <https://github.com/jettify/pytorch-optimizer>`__.
918
@@ -506,6 +515,8 @@ Hyeongchan Kim / `@kozistr <http://kozistr.tech/about>`__
506515
.. |PyPI version| image:: https://badge.fury.io/py/pytorch-optimizer.svg
507516
:target: https://badge.fury.io/py/pytorch-optimizer
508517
.. |PyPi download| image:: https://img.shields.io/pypi/dm/pytorch-optimizer?style=plastic
518+
.. |PyPI pyversions| image:: https://img.shields.io/pypi/pyversions/pytorch-optimizer.svg
519+
:target: https://pypi.python.org/pypi/pytorch-optimizer/
509520
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
510521
.. |codecov| image:: https://codecov.io/gh/kozistr/pytorch_optimizer/branch/main/graph/badge.svg?token=L4K00EA0VD
511522
:target: https://codecov.io/gh/kozistr/pytorch_optimizer

0 commit comments

Comments
 (0)