index.rst 1.25 KB
Newer Older
Zaida Zhou's avatar
Zaida Zhou committed
1
2
Welcome to MMCV's documentation!
================================
Kai Chen's avatar
Kai Chen committed
3

Zaida Zhou's avatar
Zaida Zhou committed
4
5
You can switch between Chinese and English documents in the lower-left corner of the layout.

Kai Chen's avatar
Kai Chen committed
6
.. toctree::
7
   :maxdepth: 2
8
9
10
11
12
   :caption: Get Started

   get_started/introduction.md
   get_started/installation.md
   get_started/build.md
limm's avatar
limm committed
13
   get_started/api_reference.md
14
15

.. toctree::
16
   :maxdepth: 2
17
18
19
   :caption: Understand MMCV

   understand_mmcv/data_process.md
20
   understand_mmcv/data_transform.md
21
22
23
24
25
   understand_mmcv/visualization.md
   understand_mmcv/cnn.md
   understand_mmcv/ops.md

.. toctree::
26
   :maxdepth: 2
27
28
   :caption: Deployment

RunningLeon's avatar
RunningLeon committed
29
   deployment/mmcv_ops_definition.md
30

Zaida Zhou's avatar
Zaida Zhou committed
31
32
33
34
35
.. toctree::
   :caption: Switch Language

   switch_language.md

36
.. toctree::
37
   :maxdepth: 2
38
   :caption: Compatibility
Kai Chen's avatar
Kai Chen committed
39

40
   compatibility.md
41
42
43

.. toctree::

Zaida Zhou's avatar
Zaida Zhou committed
44
   faq.md
Kai Chen's avatar
Kai Chen committed
45

46
.. toctree::
47
   :maxdepth: 2
48
49
50
51
52
53
   :caption: Community

   community/contributing.md
   community/pr.md

.. toctree::
54
   :maxdepth: 1
55
56
   :caption: API Reference

57
58
59
60
61
62
63
64
   mmcv.image <api/image>
   mmcv.video <api/video>
   mmcv.visualization <api/visualization>
   mmcv.cnn <api/cnn>
   mmcv.ops <api/ops>
   mmcv.transforms <api/transforms>
   mmcv.arraymisc <api/arraymisc>
   mmcv.utils <api/utils>
Kai Chen's avatar
Kai Chen committed
65
66
67
68
69
70

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`