Skip to content

Commit d60d283

Browse files
author
LEFTeyes
committed
upgrade README
1 parent 344ce24 commit d60d283

File tree

2 files changed

+15
-11
lines changed

2 files changed

+15
-11
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ runs/**
77
mine/**
88

99
# *.py
10+
feature.py
1011
try.py
1112

1213
# *.pt weights

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,32 @@
1-
# <center>Warmup Scheduler Pytorch</center>
1+
# Warmup Scheduler Pytorch
22

3-
[![Tests](https://github.com/LEFTeyex/warmup/actions/workflows/tests.yaml/badge.svg)](https://github.com/LEFTeyex/warmup/actions/workflows/tests.yaml)
4-
[![codecov](https://codecov.io/gh/LEFTeyex/warmup/branch/master/graph/badge.svg?token=E90TZPO40B)](https://codecov.io/gh/LEFTeyex/warmup)
5-
[![PyPI version shields.io](https://img.shields.io/pypi/v/warmup-scheduler-pytorch.svg)](https://pypi.org/project/warmup-scheduler-pytorch/)
6-
[![PyPI license](https://img.shields.io/pypi/l/warmup-scheduler-pytorch.svg)](https://pypi.org/project/warmup-scheduler-pytorch/)
7-
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/warmup-scheduler-pytorch.svg)](https://pypi.python.org/pypi/warmup-scheduler-pytorch/)
3+
[![pypi version](https://img.shields.io/pypi/v/warmup-scheduler-pytorch.svg)](https://pypi.org/project/warmup-scheduler-pytorch/)
4+
[![pypi downloads](https://static.pepy.tech/personalized-badge/warmup-scheduler-pytorch?period=total&units=international_system&left_color=grey&right_color=green&left_text=downloads)](https://pypi.org/project/warmup-scheduler-pytorch/)
5+
[![pypi pyversions](https://img.shields.io/pypi/pyversions/warmup-scheduler-pytorch.svg)](https://pypi.python.org/pypi/warmup-scheduler-pytorch/)
6+
7+
[![github license](https://img.shields.io/github/license/LEFTeyex/warmup)](https://github.com/LEFTeyex/warmup/blob/master/LICENSE)
8+
[![github repository size](https://img.shields.io/github/repo-size/LEFTeyex/warmup)](https://github.com/LEFTeyex/warmup)
9+
[![github tests](https://github.com/LEFTeyex/warmup/actions/workflows/tests.yaml/badge.svg)](https://github.com/LEFTeyex/warmup/actions/workflows/tests.yaml)
10+
[![codecov coverage](https://codecov.io/gh/LEFTeyex/warmup/branch/master/graph/badge.svg?token=E90TZPO40B)](https://codecov.io/gh/LEFTeyex/warmup)
811

912
## Description
1013

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.
1215

13-
## setup
16+
## Install
1417

1518
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/)
1720

1821
Then install as follows:
1922

20-
```
23+
```bash
2124
pip install warmup_scheduler_pytorch
2225
```
2326

2427
## Usage
2528

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.
2730

2831
```python
2932
import torch

0 commit comments

Comments
 (0)