|
1 | | -# <center>Warmup Scheduler Pytorch</center> |
| 1 | +# Warmup Scheduler Pytorch |
2 | 2 |
|
3 | | -[](https://github.com/LEFTeyex/warmup/actions/workflows/tests.yaml) |
4 | | -[](https://codecov.io/gh/LEFTeyex/warmup) |
5 | | -[](https://pypi.org/project/warmup-scheduler-pytorch/) |
6 | | -[](https://pypi.org/project/warmup-scheduler-pytorch/) |
7 | | -[](https://pypi.python.org/pypi/warmup-scheduler-pytorch/) |
| 3 | +[](https://pypi.org/project/warmup-scheduler-pytorch/) |
| 4 | +[](https://pypi.org/project/warmup-scheduler-pytorch/) |
| 5 | +[](https://pypi.python.org/pypi/warmup-scheduler-pytorch/) |
| 6 | + |
| 7 | +[](https://github.com/LEFTeyex/warmup/blob/master/LICENSE) |
| 8 | +[](https://github.com/LEFTeyex/warmup) |
| 9 | +[](https://github.com/LEFTeyex/warmup/actions/workflows/tests.yaml) |
| 10 | +[](https://codecov.io/gh/LEFTeyex/warmup) |
8 | 11 |
|
9 | 12 | ## Description |
10 | 13 |
|
11 | | -A Warmup Scheduler for Pytorch to make the warmup learning rate change at the beginning of training. |
| 14 | +A Warmup Scheduler in Pytorch to make the learning rate change at the beginning of training for warmup. |
12 | 15 |
|
13 | | -## setup |
| 16 | +## Install |
14 | 17 |
|
15 | 18 | Notice: need to install pytorch>=1.1.0 manually. \ |
16 | | -The official website of pytorch is: https://pytorch.org/ |
| 19 | +The official website is [PyTorch](https://pytorch.org/) |
17 | 20 |
|
18 | 21 | Then install as follows: |
19 | 22 |
|
20 | | -``` |
| 23 | +```bash |
21 | 24 | pip install warmup_scheduler_pytorch |
22 | 25 | ``` |
23 | 26 |
|
24 | 27 | ## Usage |
25 | 28 |
|
26 | | -Detail to see [example.py](example.py) file. |
| 29 | +Detail to see [GitHub example.py](https://github.com/LEFTeyex/warmup/blob/master/example.py) file. |
27 | 30 |
|
28 | 31 | ```python |
29 | 32 | import torch |
|
0 commit comments