Skip to content

Commit 5b279fb

Browse files
zhouzaidazhouzaida
authored
[Docs] Refine reamde and installation (#2340)
* [Docs] Simplify README * Simplify README_zh-CN * Update installation docs * Add mmyolo link in README * update introduction * update installation * Update build docs * remove io link in README * update
1 parent cb2eb57 commit 5b279fb

16 files changed

+1862
-979
lines changed

‎README.md

+63-181
Large diffs are not rendered by default.

‎README_zh-CN.md

+62-179
Large diffs are not rendered by default.

‎docker/release/Dockerfile

+5-2
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,8 @@ RUN apt-get update && apt-get install -y libgl1 libglib2.0-0 \
1616
&& rm -rf /var/lib/apt/lists/*
1717

1818
# Install mmcv
19-
ARG MMCV="2.0.0rc1"
20-
RUN pip install openmim && mim install mmcv==${MMCV} && python -c 'import mmcv;print(mmcv.__version__)'
19+
ARG MMCV=""
20+
RUN if [ "${MMCV}" = "" ]; then pip install -U openmim && mim install 'mmcv>=2.0.0rc1'; else pip install -U openmim && mim install mmcv==${MMCV}; fi
21+
22+
# Verify the installation
23+
RUN python -c 'import mmcv;print(mmcv.__version__)'

‎docs/en/_static/version.json

+349
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,349 @@
1+
{
2+
"Linux": [
3+
{
4+
"cuda": "11.6",
5+
"torch": "1.12.x",
6+
"mmcv": [
7+
"2.0.0rc1"
8+
]
9+
},
10+
{
11+
"cuda": "11.5",
12+
"torch": "1.11.x",
13+
"mmcv": [
14+
"2.0.0rc1"
15+
]
16+
},
17+
{
18+
"cuda": "11.3",
19+
"torch": "1.12.x",
20+
"mmcv": [
21+
"2.0.0rc1"
22+
]
23+
},
24+
{
25+
"cuda": "11.3",
26+
"torch": "1.11.x",
27+
"mmcv": [
28+
"2.0.0rc1"
29+
]
30+
},
31+
{
32+
"cuda": "11.3",
33+
"torch": "1.10.x",
34+
"mmcv": [
35+
"2.0.0rc1"
36+
]
37+
},
38+
{
39+
"cuda": "11.1",
40+
"torch": "1.10.x",
41+
"mmcv": [
42+
"2.0.0rc1"
43+
]
44+
},
45+
{
46+
"cuda": "11.1",
47+
"torch": "1.9.x",
48+
"mmcv": [
49+
"2.0.0rc1"
50+
]
51+
},
52+
{
53+
"cuda": "11.1",
54+
"torch": "1.8.x",
55+
"mmcv": [
56+
"2.0.0rc1"
57+
]
58+
},
59+
{
60+
"cuda": "11.0",
61+
"torch": "1.7.x",
62+
"mmcv": [
63+
"2.0.0rc1"
64+
]
65+
},
66+
{
67+
"cuda": "10.2",
68+
"torch": "1.12.x",
69+
"mmcv": [
70+
"2.0.0rc1"
71+
]
72+
},
73+
{
74+
"cuda": "10.2",
75+
"torch": "1.11.x",
76+
"mmcv": [
77+
"2.0.0rc1"
78+
]
79+
},
80+
{
81+
"cuda": "10.2",
82+
"torch": "1.10.x",
83+
"mmcv": [
84+
"2.0.0rc1"
85+
]
86+
},
87+
{
88+
"cuda": "10.2",
89+
"torch": "1.9.x",
90+
"mmcv": [
91+
"2.0.0rc1"
92+
]
93+
},
94+
{
95+
"cuda": "10.2",
96+
"torch": "1.8.x",
97+
"mmcv": [
98+
"2.0.0rc1"
99+
]
100+
},
101+
{
102+
"cuda": "10.2",
103+
"torch": "1.7.x",
104+
"mmcv": [
105+
"2.0.0rc1"
106+
]
107+
},
108+
{
109+
"cuda": "10.2",
110+
"torch": "1.6.x",
111+
"mmcv": [
112+
"2.0.0rc1"
113+
]
114+
},
115+
{
116+
"cuda": "10.1",
117+
"torch": "1.8.x",
118+
"mmcv": [
119+
"2.0.0rc1"
120+
]
121+
},
122+
{
123+
"cuda": "10.1",
124+
"torch": "1.7.x",
125+
"mmcv": [
126+
"2.0.0rc1"
127+
]
128+
},
129+
{
130+
"cuda": "10.1",
131+
"torch": "1.6.x",
132+
"mmcv": [
133+
"2.0.0rc1"
134+
]
135+
},
136+
{
137+
"cuda": "9.2",
138+
"torch": "1.7.x",
139+
"mmcv": [
140+
"2.0.0rc1"
141+
]
142+
},
143+
{
144+
"cuda": "9.2",
145+
"torch": "1.6.x",
146+
"mmcv": [
147+
"2.0.0rc1"
148+
]
149+
},
150+
{
151+
"cuda": "cpu",
152+
"torch": "1.12.x",
153+
"mmcv": [
154+
"2.0.0rc1"
155+
]
156+
},
157+
{
158+
"cuda": "cpu",
159+
"torch": "1.11.x",
160+
"mmcv": [
161+
"2.0.0rc1"
162+
]
163+
},
164+
{
165+
"cuda": "cpu",
166+
"torch": "1.10.x",
167+
"mmcv": [
168+
"2.0.0rc1"
169+
]
170+
},
171+
{
172+
"cuda": "cpu",
173+
"torch": "1.9.x",
174+
"mmcv": [
175+
"2.0.0rc1"
176+
]
177+
},
178+
{
179+
"cuda": "cpu",
180+
"torch": "1.8.x",
181+
"mmcv": [
182+
"2.0.0rc1"
183+
]
184+
},
185+
{
186+
"cuda": "cpu",
187+
"torch": "1.7.x",
188+
"mmcv": [
189+
"2.0.0rc1"
190+
]
191+
},
192+
{
193+
"cuda": "cpu",
194+
"torch": "1.6.x",
195+
"mmcv": [
196+
"2.0.0rc1"
197+
]
198+
}
199+
],
200+
"Windows": [
201+
{
202+
"cuda": "11.6",
203+
"torch": "1.12.x",
204+
"mmcv": [
205+
"2.0.0rc1"
206+
]
207+
},
208+
{
209+
"cuda": "11.5",
210+
"torch": "1.11.x",
211+
"mmcv": [
212+
"2.0.0rc1"
213+
]
214+
},
215+
{
216+
"cuda": "11.3",
217+
"torch": "1.12.x",
218+
"mmcv": [
219+
"2.0.0rc1"
220+
]
221+
},
222+
{
223+
"cuda": "11.3",
224+
"torch": "1.11.x",
225+
"mmcv": [
226+
"2.0.0rc1"
227+
]
228+
},
229+
{
230+
"cuda": "11.3",
231+
"torch": "1.10.x",
232+
"mmcv": [
233+
"2.0.0rc1"
234+
]
235+
},
236+
{
237+
"cuda": "11.1",
238+
"torch": "1.10.x",
239+
"mmcv": [
240+
"2.0.0rc1"
241+
]
242+
},
243+
{
244+
"cuda": "11.1",
245+
"torch": "1.9.x",
246+
"mmcv": [
247+
"2.0.0rc1"
248+
]
249+
},
250+
{
251+
"cuda": "11.1",
252+
"torch": "1.8.x",
253+
"mmcv": [
254+
"2.0.0rc1"
255+
]
256+
},
257+
{
258+
"cuda": "10.2",
259+
"torch": "1.10.x",
260+
"mmcv": [
261+
"2.0.0rc1"
262+
]
263+
},
264+
{
265+
"cuda": "10.2",
266+
"torch": "1.9.x",
267+
"mmcv": [
268+
"2.0.0rc1"
269+
]
270+
},
271+
{
272+
"cuda": "10.2",
273+
"torch": "1.8.x",
274+
"mmcv": [
275+
"2.0.0rc1"
276+
]
277+
},
278+
{
279+
"cuda": "10.2",
280+
"torch": "1.6.x",
281+
"mmcv": [
282+
"2.0.0rc1"
283+
]
284+
},
285+
{
286+
"cuda": "10.1",
287+
"torch": "1.8.x",
288+
"mmcv": [
289+
"2.0.0rc1"
290+
]
291+
},
292+
{
293+
"cuda": "10.1",
294+
"torch": "1.6.x",
295+
"mmcv": [
296+
"2.0.0rc1"
297+
]
298+
},
299+
{
300+
"cuda": "cpu",
301+
"torch": "1.12.x",
302+
"mmcv": [
303+
"2.0.0rc1"
304+
]
305+
},
306+
{
307+
"cuda": "cpu",
308+
"torch": "1.11.x",
309+
"mmcv": [
310+
"2.0.0rc1"
311+
]
312+
},
313+
{
314+
"cuda": "cpu",
315+
"torch": "1.10.x",
316+
"mmcv": [
317+
"2.0.0rc1"
318+
]
319+
},
320+
{
321+
"cuda": "cpu",
322+
"torch": "1.9.x",
323+
"mmcv": [
324+
"2.0.0rc1"
325+
]
326+
},
327+
{
328+
"cuda": "cpu",
329+
"torch": "1.8.x",
330+
"mmcv": [
331+
"2.0.0rc1"
332+
]
333+
},
334+
{
335+
"cuda": "cpu",
336+
"torch": "1.7.x",
337+
"mmcv": [
338+
"2.0.0rc1"
339+
]
340+
},
341+
{
342+
"cuda": "cpu",
343+
"torch": "1.6.x",
344+
"mmcv": [
345+
"2.0.0rc1"
346+
]
347+
}
348+
]
349+
}

‎docs/en/conf.py

+2
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@
5858

5959
myst_heading_anchors = 4
6060

61+
myst_enable_extensions = ['colon_fence']
62+
6163
# Configuration for intersphinx
6264
intersphinx_mapping = {
6365
'python': ('https://docs.python.org/3', None),

0 commit comments

Comments
 (0)