mmclassification/docs/en/api/apis.rst

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

.. module:: mmcls.apis

mmcls.apis
===================================

These are some high-level APIs for classification tasks.

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

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

.. autofunction:: list_models

.. autofunction:: get_model

.. autofunction:: init_model


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

.. autofunction:: 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] 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			`.. module:: mmcls.apis`

[Docs] Refine API reference. (#774) * [Docs] Refine API reference * Add PoolFormer 2022-04-15 20:19:20 +08:00			`mmcls.apis`
			`===================================`

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

			`.. contents:: mmcls.apis`
			`: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] 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			`.. autofunction:: list_models`

			`.. autofunction:: get_model`

			`.. autofunction:: init_model`


			`Inference`
			`------------------`
[Docs] Refine API reference. (#774) * [Docs] Refine API reference * Add PoolFormer 2022-04-15 20:19:20 +08:00
[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			`.. autofunction:: inference_model`