mirrors
/
mmpretrain
mirror of https://github.com/open-mmlab/mmpretrain.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
mmpretrain/docs/en/api.rst

69 lines
908 B
ReStructuredText
Raw Normal View History

[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
mmcls.apis
-------------
.. automodule:: mmcls.apis
:members:
mmcls.core
-------------
evaluation
^^^^^^^^^^
.. automodule:: mmcls.core.evaluation
:members:
mmcls.models
---------------
models
^^^^^^
.. automodule:: mmcls.models
:members:
classifiers
^^^^^^^^^^^
.. automodule:: mmcls.models.classifiers
:members:
backbones
^^^^^^^^^^
.. automodule:: mmcls.models.backbones
:members:
necks
^^^^^^
.. automodule:: mmcls.models.necks
:members:
[Docs] Add schedule and runtime tutorial docs (#499) * add cn tutorials/config.md * add heads api and doc title link * Update tutorials index * Update tutorials index * Update config.md * add english version * Update config.md * add custom_runtime * Update docs * modify title * modify en to zh_CN in chinses docs * Update Readme * fix punctuations * Update docs/tutorials/customize_runtime.md Co-authored-by: Ma Zerun <mzr1996@163.com> * Update docs/tutorials/customize_runtime.md Co-authored-by: Ma Zerun <mzr1996@163.com> * split to schedule and runtime * fix lint * improve docs after review * fix TOC * imporve expersion * fix an error * Imporve schedule.md * Improve runtime.md * Improve chinese docs. * Fix toc-tree * fix en link and add a case of gradient clipping * fix wrong word Co-authored-by: Ma Zerun <mzr1996@163.com>
2021-11-17 18:12:54 +08:00
heads
^^^^^^
.. automodule:: mmcls.models.heads
:members:
[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
losses
^^^^^^
.. automodule:: mmcls.models.losses
:members:
utils
^^^^^^
.. automodule:: mmcls.models.utils
:members:
mmcls.datasets
-----------------
datasets
^^^^^^^^
.. automodule:: mmcls.datasets
:members:
pipelines
^^^^^^^^^
.. automodule:: mmcls.datasets.pipelines
:members:
mmcls.utils
--------------
.. automodule:: mmcls.utils
:members: