Skip to content

Commit e28cecc

Browse files
authored
Update README.md
1 parent 3a2b0af commit e28cecc

File tree

1 file changed

+26
-11
lines changed

1 file changed

+26
-11
lines changed

README.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,16 @@ The main features of this library are:
99
- 30 available encoders for each architecture
1010
- All backbones have pre-trained weights for faster and better convergence
1111

12-
13-
### Quick start
12+
### Table of content
13+
1. [Quick start](#start)
14+
2. [Models](#models)
15+
1. [Architectires](#architectires)
16+
2. [Encoders](#encoders)
17+
3. [Pretrained weights](#weights)
18+
3. [Installation](#installation)
19+
4. [License](#license)
20+
21+
### Quick start <a name="start"></a>
1422
Since the library is built on the PyTorch framework, created segmentation model is just a PyTorch nn.Module, which can be created as easy as:
1523
```python
1624
import segmentation_models_pytorch as smp
@@ -36,15 +44,15 @@ from segmentation_models_pytorch.encoders import get_preprocessing_fn
3644
preprocess_input = get_preprocessing_fn('renset18', pretrained='imagenet')
3745
```
3846

39-
### Models
47+
### Models <a name="models"></a>
4048

41-
#### Architectires
42-
- Unet
43-
- Linknet
44-
- FPN
45-
- PSPNet
49+
#### Architectires <a name="architectires"></a>
50+
- [Unet](https://arxiv.org/abs/1505.04597)
51+
- [Linknet](https://arxiv.org/abs/1707.03718)
52+
- [FPN](http://presentations.cocodataset.org/COCO17-Stuff-FAIR.pdf)
53+
- [PSPNet](https://arxiv.org/abs/1612.01105)
4654

47-
#### Encoders
55+
#### Encoders <a name="encoders"></a>
4856

4957
| Type | Encoder names |
5058
|------------|-----------------------------------------------------------------|
@@ -57,14 +65,21 @@ preprocess_input = get_preprocessing_fn('renset18', pretrained='imagenet')
5765
| SE-ResNeXt | se_resnext50_32x4d, se_resnext101_32x4d |
5866
| SENet | senet154 | |
5967

60-
#### Weights
68+
#### Weights <a name="weights"></a>
6169

6270
| Weights name | Encoder names |
6371
|--------------|-----------------------|
6472
| imagenet+5k | dpn68b, dpn92, dpn107 |
6573
| imagenet | * all other encoders |
6674

67-
75+
76+
### Installation <a name="installation"></a>
77+
PyPI version is not released yet, to install package from source run following command:
78+
```bash
79+
$ pip install git+https://github.com/qubvel/segmentation_models.pytorch
80+
````
81+
### License <a name="license"></a>
82+
Project is distributed under [MIT License](https://github.com/qubvel/segmentation_models.pytorch/blob/master/LICENSE)
6883

6984
### Run tests
7085
```bash

0 commit comments

Comments
 (0)