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
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
   :caption: Understand MMCV

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

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

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

Zaida Zhou's avatar
Zaida Zhou committed
37
38
39
40
41
.. toctree::
   :caption: Switch Language

   switch_language.md

42
.. toctree::
43
   :maxdepth: 2
44
   :caption: Compatibility
Kai Chen's avatar
Kai Chen committed
45

46
   compatibility.md
47
48

.. toctree::
49
   :maxdepth: 2
50
51
   :caption: FAQ

Zaida Zhou's avatar
Zaida Zhou committed
52
   faq.md
Kai Chen's avatar
Kai Chen committed
53

54
.. toctree::
55
   :maxdepth: 2
56
57
58
59
60
61
   :caption: Community

   community/contributing.md
   community/pr.md

.. toctree::
62
   :maxdepth: 2
63
64
65
   :caption: API Reference

   api.rst
Kai Chen's avatar
Kai Chen committed
66
67
68
69
70
71

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

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