Skip to content

Commit e3b6330

Browse files
update docs
1 parent daaeeda commit e3b6330

File tree

10 files changed

+145
-23
lines changed

10 files changed

+145
-23
lines changed

README.md

+15-7
Original file line numberDiff line numberDiff line change
@@ -41,22 +41,30 @@ You can star this repository to keep track of the project if it's helpful for yo
4141

4242
#### Supported Encoder
4343

44-
- [ResNet](https://arxiv.org/pdf/1512.03385.pdf)
44+
| Encoder | Model Zoo | Paper Link | Code Snippet |
45+
| :-: | :-: | :-: | :-: |
46+
| ResNet | [click](./docs/modelzoo/mib) | [CVPR 2016](https://arxiv.org/pdf/1512.03385.pdf) | [click](./csseg/modules/models/encoders/resnet.py) |
4547

4648
#### Supported Decoder
4749

48-
- [Deeplabv3](https://arxiv.org/pdf/1706.05587.pdf)
50+
| Decoder | Model Zoo | Paper Link | Code Snippet |
51+
| :-: | :-: | :-: | :-: |
52+
| Deeplabv3 | [click](./docs/modelzoo/mib) | [ArXiv 2017](https://arxiv.org/pdf/1706.05587.pdf) | [click](./csseg/modules/models/decoders/aspphead.py) |
4953

5054
#### Supported Runner
5155

52-
- [MIB](https://github.com/SegmentationBLWX/cssegmentation/tree/main/docs/modelzoo/mib)
53-
- [PLOP](https://github.com/SegmentationBLWX/cssegmentation/tree/main/docs/modelzoo/plop)
54-
- [RCIL]()
56+
| Runner | Model Zoo | Paper Link | Code Snippet |
57+
| :-: | :-: | :-: | :-: |
58+
| MIB | [click](./docs/modelzoo/mib) | [CVPR 2020](https://arxiv.org/pdf/2002.00718.pdf) | [click](./csseg/modules/runners/mib.py) |
59+
| PLOP | [click](./docs/modelzoo/plop) | [CVPR 2021](https://arxiv.org/pdf/2011.11390.pdf) | [click](./csseg/modules/runners/plop.py) |
60+
| RCIL | [click](./docs/modelzoo/rcil) | [CVPR 2022](https://arxiv.org/pdf/2203.05402.pdf) | [click](./csseg/modules/runners/rcil.py) |
5561

5662
#### Supported Datasets
5763

58-
- [ADE20k](https://groups.csail.mit.edu/vision/datasets/ADE20K/)
59-
- [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/)
64+
| Dataset | Project Link | Paper Link | Code Snippet |
65+
| :-: | :-: | :-: | :-: |
66+
| ADE20k | [Click](https://groups.csail.mit.edu/vision/datasets/ADE20K/) | [CVPR 2017](https://arxiv.org/pdf/1608.05442.pdf) | [Click](./csseg/modules/datasets/ade20k.py) |
67+
| PASCAL VOC | [Click](http://host.robots.ox.ac.uk/pascal/VOC/) | [IJCV 2010](http://host.robots.ox.ac.uk/pascal/VOC/pubs/everingham10.pdf) | [Click](./csseg/modules/datasets/voc.py) |
6068

6169

6270
## Citation

docs/modelzoo/mib/README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,14 @@
2424

2525
#### PASCAL VOC
2626

27-
| Backbone | Crop Size | Setting | mIoU | Download |
28-
| :-: | :-: | :-: | :-: | :-: |
29-
| R-101-D8 | 512x512 | 15-5-disjoint | | [cfg]() | [model]() | [log]() |
30-
| R-101-D8 | 512x512 | 15-5-overlapped | | [cfg]() | [model]() | [log]() |
31-
| R-101-D8 | 512x512 | 15-1-disjoint | | [cfg]() | [model]() | [log]() |
32-
| R-101-D8 | 512x512 | 15-1-overlapped | | [cfg]() | [model]() | [log]() |
33-
| R-101-D8 | 512x512 | 10-1-disjoint | | [cfg]() | [model]() | [log]() |
34-
| R-101-D8 | 512x512 | 10-1-overlapped | | [cfg]() | [model]() | [log]() |
27+
| Backbone | Crop Size | Setting | mIoU | Download |
28+
| :-: | :-: | :-: | :-: | :-: |
29+
| R-101-D16 | 512x512 | 15-5-disjoint | | [cfg]() | [modellinks-per-step]() | [log]() |
30+
| R-101-D16 | 512x512 | 15-5-overlapped | | [cfg]() | [modellinks-per-step]() | [log]() |
31+
| R-101-D16 | 512x512 | 15-1-disjoint | | [cfg]() | [modellinks-per-step]() | [log]() |
32+
| R-101-D16 | 512x512 | 15-1-overlapped | | [cfg]() | [modellinks-per-step]() | [log]() |
33+
| R-101-D16 | 512x512 | 10-1-disjoint | | [cfg]() | [modellinks-per-step]() | [log]() |
34+
| R-101-D16 | 512x512 | 10-1-overlapped | | [cfg]() | [modellinks-per-step]() | [log]() |
35+
36+
#### ADE20k
3537

docs/modelzoo/plop/README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,14 @@
2424

2525
#### PASCAL VOC
2626

27-
| Backbone | Crop Size | Setting | mIoU | Download |
28-
| :-: | :-: | :-: | :-: | :-: |
29-
| R-101-D8 | 512x512 | 15-5-disjoint | | [cfg]() | [model]() | [log]() |
30-
| R-101-D8 | 512x512 | 15-5-overlapped | | [cfg]() | [model]() | [log]() |
31-
| R-101-D8 | 512x512 | 15-1-disjoint | | [cfg]() | [model]() | [log]() |
32-
| R-101-D8 | 512x512 | 15-1-overlapped | | [cfg]() | [model]() | [log]() |
33-
| R-101-D8 | 512x512 | 10-1-disjoint | | [cfg]() | [model]() | [log]() |
34-
| R-101-D8 | 512x512 | 10-1-overlapped | | [cfg]() | [model]() | [log]() |
27+
| Backbone | Crop Size | Setting | mIoU | Download |
28+
| :-: | :-: | :-: | :-: | :-: |
29+
| R-101-D16 | 512x512 | 15-5-disjoint | | [cfg]() | [modellinks-per-step]() | [log]() |
30+
| R-101-D16 | 512x512 | 15-5-overlapped | | [cfg]() | [modellinks-per-step]() | [log]() |
31+
| R-101-D16 | 512x512 | 15-1-disjoint | | [cfg]() | [modellinks-per-step]() | [log]() |
32+
| R-101-D16 | 512x512 | 15-1-overlapped | | [cfg]() | [modellinks-per-step]() | [log]() |
33+
| R-101-D16 | 512x512 | 10-1-disjoint | | [cfg]() | [modellinks-per-step]() | [log]() |
34+
| R-101-D16 | 512x512 | 10-1-overlapped | | [cfg]() | [modellinks-per-step]() | [log]() |
35+
36+
#### ADE20k
3537

requirements.txt

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
-r requirements/io.txt
2+
-r requirements/science.txt
3+
-r requirements/optional.txt
4+
-r requirements/terminal.txt

requirements/io.txt

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
pillow
2+
pandas
3+
opencv-python

requirements/nn.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
torch
2+
torchvision

requirements/optional.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
cython
2+
apex

requirements/science.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
numpy
2+
scipy

requirements/terminal.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
tqdm
2+
argparse

setup.py

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
'''
2+
Function:
3+
Setup cssegmentation
4+
Author:
5+
Zhenchao Jin
6+
'''
7+
import os
8+
import re
9+
import sys
10+
import csseg
11+
from setuptools import setup, find_packages
12+
13+
14+
'''readme'''
15+
with open('README.md', 'r', encoding='utf-8') as f:
16+
long_description = f.read()
17+
18+
19+
'''parse the package dependencies listed in a requirements file but strips specific versioning information'''
20+
def parserequirements(fname='requirements.txt', with_version=True):
21+
require_fpath = fname
22+
'''parse information from a line in a requirements text file'''
23+
def parseline(line):
24+
if line.startswith('-r '):
25+
target = line.split(' ')[1]
26+
for info in parserequirefile(target):
27+
yield info
28+
else:
29+
info = {'line': line}
30+
if line.startswith('-e '):
31+
info['package'] = line.split('#egg=')[1]
32+
elif '@git+' in line:
33+
info['package'] = line
34+
else:
35+
pat = '(' + '|'.join(['>=', '==', '>']) + ')'
36+
parts = re.split(pat, line, maxsplit=1)
37+
parts = [p.strip() for p in parts]
38+
info['package'] = parts[0]
39+
if len(parts) > 1:
40+
op, rest = parts[1:]
41+
if ';' in rest:
42+
version, platform_deps = map(str.strip, rest.split(';'))
43+
info['platform_deps'] = platform_deps
44+
else:
45+
version = rest
46+
info['version'] = (op, version)
47+
yield info
48+
'''parse require file'''
49+
def parserequirefile(fpath):
50+
with open(fpath, 'r') as f:
51+
for line in f.readlines():
52+
line = line.strip()
53+
if line and not line.startswith('#'):
54+
for info in parseline(line):
55+
yield info
56+
'''gen packages items'''
57+
def genpackagesitems():
58+
if os.path.exists(require_fpath):
59+
for info in parserequirefile(require_fpath):
60+
parts = [info['package']]
61+
if with_version and 'version' in info:
62+
parts.extend(info['version'])
63+
if not sys.version.startswith('3.4'):
64+
platform_deps = info.get('platform_deps')
65+
if platform_deps is not None:
66+
parts.append(';' + platform_deps)
67+
item = ''.join(parts)
68+
yield item
69+
# parse and return
70+
packages = list(genpackagesitems())
71+
return packages
72+
73+
74+
'''setup'''
75+
setup(
76+
name=csseg.__title__,
77+
version=csseg.__version__,
78+
description=csseg.__description__,
79+
long_description=long_description,
80+
long_description_content_type='text/markdown',
81+
classifiers=[
82+
'License :: OSI Approved :: Apache Software License',
83+
'Programming Language :: Python :: 3',
84+
'Intended Audience :: Developers',
85+
'Operating System :: OS Independent'
86+
],
87+
author=csseg.__author__,
88+
url=csseg.__url__,
89+
author_email=csseg.__email__,
90+
license=csseg.__license__,
91+
include_package_data=True,
92+
install_requires=parserequirements('requirements.txt'),
93+
zip_safe=True,
94+
packages=find_packages()
95+
)

0 commit comments

Comments
 (0)