mmpretrain/docs/index.rst
Ezra-Yu fdb178303b
[Docs] Add analysis&misc docs (#525)
* refactor ananlysis_log and add docs

* refactor ananlysis_log and fix lint

* improve docs

* improve docs

* improve docs

* fix bugs and refactor analysis_log

* rename analysis folder to analysis_tools

* fix failure link

* add result analysis docs

* add eval-metrics docs

* add misc doc

* fix lint

* improve docs

* improve misc docs

* fix docs

* Change the `eval_options` in `tools/analysis_tools/eval_metric.py` to
`metric_options`

* Improve tutorials

Co-authored-by: mzr1996 <mzr1996@163.com>
2021-12-07 11:27:34 +08:00

70 lines
1.2 KiB
ReStructuredText

Welcome to MMClassification's documentation!
============================================
You can switch between Chinese and English documentation in the lower-left corner of the layout.
您可以在页面左下角切换中英文文档。
.. toctree::
:maxdepth: 1
:caption: Get Started
install.md
getting_started.md
.. toctree::
:maxdepth: 1
:caption: Tutorials
tutorials/config.md
tutorials/finetune.md
tutorials/new_dataset.md
tutorials/data_pipeline.md
tutorials/new_modules.md
tutorials/schedule.md
tutorials/runtime.md
.. include:: _model_zoo.rst
.. toctree::
:maxdepth: 1
:caption: Useful Tools and Scripts
tools/pytorch2onnx.md
tools/onnx2tensorrt.md
tools/pytorch2torchscript.md
tools/model_serving.md
tools/visualization.md
tools/analysis.md
tools/miscellaneous.md
.. toctree::
:maxdepth: 1
:caption: Community
community/CONTRIBUTING.md
.. toctree::
:caption: API Reference
api.rst
.. toctree::
:caption: Language Switch
English <https://mmclassification.readthedocs.io/en/latest/>
简体中文 <https://mmclassification.readthedocs.io/zh_CN/latest/>
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`