mmclassification/docs/en/api/apis.rst

.. role:: hidden
    :class: hidden-section

.. module:: mmpretrain.apis

mmpretrain.apis
===================================

These are some high-level APIs for classification tasks.

.. contents:: mmpretrain.apis
   :depth: 2
   :local:
   :backlinks: top

Model
------------------

.. autosummary::
   :toctree: generated
   :nosignatures:

   list_models
   get_model
   init_model

Inference
------------------

.. autosummary::
   :toctree: generated
   :nosignatures:
   :template: callable.rst

   ImageClassificationInferencer

.. autosummary::
   :toctree: generated
   :nosignatures:

   inference_model
[Docs] Refine API reference. (#774) * [Docs] Refine API reference * Add PoolFormer 2022-04-15 20:19:20 +08:00			`.. role:: hidden`
			`:class: hidden-section`

[Docs] Update generate_readme.py and readme files. (#1388) * Update generate_readme.py and readme files. * Update reamde * Update docs * update metafile * update simmim readme * update * update mae * fix lint * update mocov2 * update readme pic * fix lint * Fix mmcls download links. * Fix Chinese docs. * Decrease readthedocs requirements. --------- Co-authored-by: fangyixiao18 <fangyx18@hotmail.com> 2023-03-02 13:29:07 +08:00			`.. module:: mmpretrain.apis`
[Docs] Refactor dataset tutorial (#916) * refactor dataset tutorials * split into user_guide and advance_guide * refine * Fix dataset preparasion tutorial. * refine CN docs * update docs API doc link * refine new a dataset * refine new a dataset * refine new a dataset Co-authored-by: mzr1996 <mzr1996@163.com> 2022-08-30 18:45:58 +08:00
[Docs] Update generate_readme.py and readme files. (#1388) * Update generate_readme.py and readme files. * Update reamde * Update docs * update metafile * update simmim readme * update * update mae * fix lint * update mocov2 * update readme pic * fix lint * Fix mmcls download links. * Fix Chinese docs. * Decrease readthedocs requirements. --------- Co-authored-by: fangyixiao18 <fangyx18@hotmail.com> 2023-03-02 13:29:07 +08:00			`mmpretrain.apis`
[Docs] Refine API reference. (#774) * [Docs] Refine API reference * Add PoolFormer 2022-04-15 20:19:20 +08:00			`===================================`

			`These are some high-level APIs for classification tasks.`

[Docs] Update generate_readme.py and readme files. (#1388) * Update generate_readme.py and readme files. * Update reamde * Update docs * update metafile * update simmim readme * update * update mae * fix lint * update mocov2 * update readme pic * fix lint * Fix mmcls download links. * Fix Chinese docs. * Decrease readthedocs requirements. --------- Co-authored-by: fangyixiao18 <fangyx18@hotmail.com> 2023-03-02 13:29:07 +08:00			`.. contents:: mmpretrain.apis`
[Docs] Refine API reference. (#774) * [Docs] Refine API reference * Add PoolFormer 2022-04-15 20:19:20 +08:00			`:depth: 2`
			`:local:`
			`:backlinks: top`

[Feature] Support getting model from the name defined in the model-index file. (#1236) * [Feature] Support getting model from the name defined in the model-index file. * Add unit tests. * Prevent import `timm` if the `TIMMBackbone` is not used. * Fix Windows CI. * Move `init_model` to `mmcls.apis.hub`, and support pass nn.Module to all model components. * Fix requirements * Rename `hub.py` to `model.py` and add unit tests. 2022-12-06 17:00:22 +08:00			`Model`
[Docs] Refine API reference. (#774) * [Docs] Refine API reference * Add PoolFormer 2022-04-15 20:19:20 +08:00			`------------------`

[Feature] Add `ImageClassificationInferencer`. (#1261) * [Feature] Add ImageClassificationInferencer. * Update inferencer implementation and add unit tests. * Update documentations. * Update pre-commit hook * Update docs 2023-02-08 14:30:12 +08:00			`.. autosummary::`
			`:toctree: generated`
			`:nosignatures:`
[Feature] Support getting model from the name defined in the model-index file. (#1236) * [Feature] Support getting model from the name defined in the model-index file. * Add unit tests. * Prevent import `timm` if the `TIMMBackbone` is not used. * Fix Windows CI. * Move `init_model` to `mmcls.apis.hub`, and support pass nn.Module to all model components. * Fix requirements * Rename `hub.py` to `model.py` and add unit tests. 2022-12-06 17:00:22 +08:00
[Feature] Add `ImageClassificationInferencer`. (#1261) * [Feature] Add ImageClassificationInferencer. * Update inferencer implementation and add unit tests. * Update documentations. * Update pre-commit hook * Update docs 2023-02-08 14:30:12 +08:00			`list_models`
			`get_model`
			`init_model`
[Feature] Support getting model from the name defined in the model-index file. (#1236) * [Feature] Support getting model from the name defined in the model-index file. * Add unit tests. * Prevent import `timm` if the `TIMMBackbone` is not used. * Fix Windows CI. * Move `init_model` to `mmcls.apis.hub`, and support pass nn.Module to all model components. * Fix requirements * Rename `hub.py` to `model.py` and add unit tests. 2022-12-06 17:00:22 +08:00
			`Inference`
			`------------------`
[Docs] Refine API reference. (#774) * [Docs] Refine API reference * Add PoolFormer 2022-04-15 20:19:20 +08:00
[Feature] Add `ImageClassificationInferencer`. (#1261) * [Feature] Add ImageClassificationInferencer. * Update inferencer implementation and add unit tests. * Update documentations. * Update pre-commit hook * Update docs 2023-02-08 14:30:12 +08:00			`.. autosummary::`
			`:toctree: generated`
			`:nosignatures:`
			`:template: callable.rst`

			`ImageClassificationInferencer`

			`.. autosummary::`
			`:toctree: generated`
			`:nosignatures:`

			`inference_model`