index.rst 1.3 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
19
20
21
22
23
24
25
26
27
28
   :caption: Understand MMCV

   understand_mmcv/config.md
   understand_mmcv/registry.md
   understand_mmcv/runner.md
   understand_mmcv/io.md
   understand_mmcv/data_process.md
   understand_mmcv/visualization.md
   understand_mmcv/cnn.md
   understand_mmcv/ops.md
   understand_mmcv/utils.md

.. toctree::
29
   :maxdepth: 2
30
31
   :caption: Deployment

RunningLeon's avatar
RunningLeon committed
32
   deployment/mmcv_ops_definition.md
33
   deployment/onnx.md
34
   deployment/onnxruntime_custom_ops.md
35
   deployment/onnxruntime_op.md
36
   deployment/tensorrt_custom_ops.md
37
38
   deployment/tensorrt_plugin.md

Zaida Zhou's avatar
Zaida Zhou committed
39
40
41
42
43
.. toctree::
   :caption: Switch Language

   switch_language.md

44
.. toctree::
45
   :maxdepth: 2
46
   :caption: Compatibility
Kai Chen's avatar
Kai Chen committed
47

48
   compatibility.md
49
50

.. toctree::
51
   :maxdepth: 2
52
53
   :caption: FAQ

Zaida Zhou's avatar
Zaida Zhou committed
54
   faq.md
Kai Chen's avatar
Kai Chen committed
55

56
.. toctree::
57
   :maxdepth: 2
58
59
60
61
62
63
   :caption: Community

   community/contributing.md
   community/pr.md

.. toctree::
64
   :maxdepth: 2
65
66
67
   :caption: API Reference

   api.rst
Kai Chen's avatar
Kai Chen committed
68
69
70
71
72
73

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

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