index.rst 1.22 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
13
14
   :caption: Get Started

   get_started/introduction.md
   get_started/installation.md
   get_started/build.md

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

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

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

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

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

   switch_language.md

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

39
   compatibility.md
40
41
42

.. toctree::

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

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

   community/contributing.md
   community/pr.md

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

56
57
58
59
60
61
62
63
   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
64
65
66
67
68
69

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

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