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

67 lines
874 B
ReStructuredText

API Reference
=============
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:
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: