Ma Zerun d04ebc1eb5
[Docs] Add API Reference in the docs (#342)
* Add API inference in the docs and fix readthedocs config.

* Replace some relative link in docs.

* Format docstring for reStructuredText syntax.

* Fix vit paper link

* Fix docstring of `show_results` function in `BaseClassifier`.
2021-07-14 15:06:50 +08:00

61 lines
952 B
ReStructuredText

Welcome to MMClassification's documentation!
============================================
You can switch between Chinese and English documents in the lower-left corner of the layout.
您可以在页面左下角切换中英文文档。
.. toctree::
:maxdepth: 2
:caption: Get Started
install.md
getting_started.md
.. toctree::
:maxdepth: 2
:caption: Model zoo
modelzoo_statistics.md
.. toctree::
:maxdepth: 2
:caption: Tutorials
tutorials/finetune.md
tutorials/new_dataset.md
tutorials/data_pipeline.md
tutorials/new_modules.md
.. toctree::
:maxdepth: 2
:caption: Useful Tools and Scripts
tools/pytorch2onnx.md
tools/onnx2tensorrt.md
tools/pytorch2torchscript.md
tools/model_serving.md
.. toctree::
:caption: API Reference
api.rst
.. toctree::
:caption: Language Switch
switch_language.md
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`