@@ -9,8 +9,16 @@ The main features of this library are:
9
9
- 30 available encoders for each architecture
10
10
- All backbones have pre-trained weights for faster and better convergence
11
11
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 >
14
22
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:
15
23
``` python
16
24
import segmentation_models_pytorch as smp
@@ -36,15 +44,15 @@ from segmentation_models_pytorch.encoders import get_preprocessing_fn
36
44
preprocess_input = get_preprocessing_fn(' renset18' , pretrained = ' imagenet' )
37
45
```
38
46
39
- ### Models
47
+ ### Models < a name = " models " ></ a >
40
48
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 )
46
54
47
- #### Encoders
55
+ #### Encoders < a name = " encoders " ></ a >
48
56
49
57
| Type | Encoder names |
50
58
| ------------| -----------------------------------------------------------------|
@@ -57,14 +65,21 @@ preprocess_input = get_preprocessing_fn('renset18', pretrained='imagenet')
57
65
| SE-ResNeXt | se_resnext50_32x4d, se_resnext101_32x4d |
58
66
| SENet | senet154 | |
59
67
60
- #### Weights
68
+ #### Weights < a name = " weights " ></ a >
61
69
62
70
| Weights name | Encoder names |
63
71
| --------------| -----------------------|
64
72
| imagenet+5k | dpn68b, dpn92, dpn107 |
65
73
| imagenet | * all other encoders |
66
74
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)
68
83
69
84
# ## Run tests
70
85
` ` ` bash
0 commit comments