mmocr/docs/en/api.rst

mmocr.apis
-------------
.. automodule:: mmocr.apis
    :members:


mmocr.core
-------------
evaluation
^^^^^^^^^^
.. automodule:: mmocr.core.evaluation
    :members:


mmocr.utils
-------------
.. automodule:: mmocr.utils
    :members:


mmocr.models
---------------
Common Backbones
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.common.backbones
    :members:

.. automodule:: mmocr.models.common.losses
    :members:

Text Detection Detectors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textdet.detectors
    :members:

Text Detection Heads
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textdet.dense_heads
    :members:

Text Detection Necks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textdet.necks
    :members:

Text Detection Losses
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textdet.losses
    :members:

Text Detection Postprocessors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textdet.postprocess
    :members:

Text Recognition Recognizer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.recognizer
    :members:

Text Recognition Backbones
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.backbones
    :members:

Text Recognition Necks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.necks
    :members:

Text Recognition Heads
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.heads
    :members:

Text Recognition Preprocessors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.preprocessor
    :members:

Text Recognition Backbones
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.backbones
    :members:

Text Recognition Layers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.layers
    :members:

Text Recognition Convertors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.convertors
    :members:

Text Recognition Encoders
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.encoders
    :members:

Text Recognition Decoders
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.decoders
    :members:

Text Recognition Fusers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.fusers
    :members:

Text Recognition Losses
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.losses
    :members:

KIE Extractors
^^^^^^^^^^^^^^
.. automodule:: mmocr.models.kie.extractors
    :members:

KIE Heads
^^^^^^^^^^^
.. automodule:: mmocr.models.kie.heads
    :members:

KIE Losses
^^^^^^^^^^^
.. automodule:: mmocr.models.kie.losses
    :members:

NER Encoders
^^^^^^^^^^^^
.. automodule:: mmocr.models.ner.encoders
    :members:

NER Decoders
^^^^^^^^^^^^
.. automodule:: mmocr.models.ner.decoders
    :members:

NER Losses
^^^^^^^^^^^
.. automodule:: mmocr.models.ner.losses
    :members:

mmocr.datasets
-----------------
.. automodule:: mmocr.datasets
    :members:

datasets
^^^^^^^^^^^
.. automodule:: mmocr.datasets.base_dataset
    :members:

.. automodule:: mmocr.datasets.icdar_dataset
    :members:

.. automodule:: mmocr.datasets.ocr_dataset
    :members:

.. automodule:: mmocr.datasets.ocr_seg_dataset
    :members:

.. automodule:: mmocr.datasets.text_det_dataset
    :members:

.. automodule:: mmocr.datasets.kie_dataset
    :members:


pipelines
^^^^^^^^^^^
.. automodule:: mmocr.datasets.pipelines
    :members:

utils
^^^^^^^^^^^
.. automodule:: mmocr.datasets.utils
    :members:
[feature]: dbnet and docs 2021-04-03 01:21:33 +08:00			`mmocr.apis`
			`-------------`
			`.. automodule:: mmocr.apis`
			`:members:`

update docs 2021-04-08 18:05:46 +08:00
[feature]: dbnet and docs 2021-04-03 01:21:33 +08:00			`mmocr.core`
			`-------------`
			`evaluation`
			`^^^^^^^^^^`
			`.. automodule:: mmocr.core.evaluation`
			`:members:`
update docs 2021-04-08 18:05:46 +08:00

			`mmocr.utils`
			`-------------`
			`.. automodule:: mmocr.utils`
			`:members:`


			`mmocr.models`
			`---------------`
[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`Common Backbones`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.models.common.backbones`
update docs 2021-04-08 18:05:46 +08:00			`:members:`

fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.models.common.losses`
			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`Text Detection Detectors`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
			`.. automodule:: mmocr.models.textdet.detectors`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`Text Detection Heads`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
			`.. automodule:: mmocr.models.textdet.dense_heads`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`Text Detection Necks`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
			`.. automodule:: mmocr.models.textdet.necks`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`Text Detection Losses`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.models.textdet.losses`
			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`Text Detection Postprocessors`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.models.textdet.postprocess`
			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`Text Recognition Recognizer`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.models.textrecog.recognizer`
			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`Text Recognition Backbones`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.models.textrecog.backbones`
			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`Text Recognition Necks`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.models.textrecog.necks`
			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`Text Recognition Heads`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.models.textrecog.heads`
			`:members:`

[Docs] Add model summary (#693) * Add model summary * Update text recog jpg * update pictures and add kie 2021-12-31 11:26:38 +08:00			`Text Recognition Preprocessors`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
			`.. automodule:: mmocr.models.textrecog.preprocessor`
			`:members:`
[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00
			`Text Recognition Backbones`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
			`.. automodule:: mmocr.models.textrecog.backbones`
			`:members:`

			`Text Recognition Layers`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
			`.. automodule:: mmocr.models.textrecog.layers`
			`:members:`

			`Text Recognition Convertors`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.models.textrecog.convertors`
			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`Text Recognition Encoders`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.models.textrecog.encoders`
			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`Text Recognition Decoders`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.models.textrecog.decoders`
			`:members:`

[Docs] Add model summary (#693) * Add model summary * Update text recog jpg * update pictures and add kie 2021-12-31 11:26:38 +08:00			`Text Recognition Fusers`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
			`.. automodule:: mmocr.models.textrecog.fusers`
			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`Text Recognition Losses`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.models.textrecog.losses`
			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`KIE Extractors`
			`^^^^^^^^^^^^^^`
			`.. automodule:: mmocr.models.kie.extractors`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`KIE Heads`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`^^^^^^^^^^^`
[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`.. automodule:: mmocr.models.kie.heads`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`KIE Losses`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`^^^^^^^^^^^`
[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`.. automodule:: mmocr.models.kie.losses`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`NER Encoders`
			`^^^^^^^^^^^^`
			`.. automodule:: mmocr.models.ner.encoders`
update docs 2021-04-08 18:05:46 +08:00			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`NER Decoders`
			`^^^^^^^^^^^^`
			`.. automodule:: mmocr.models.ner.decoders`
update docs 2021-04-08 18:05:46 +08:00			`:members:`

[Docs] Add config tutorial (#683) * Add config tutorial and reorganize dataset_type.md * update cn docs toc * Add misc tool * Improve docs api menu and config docs 2021-12-28 12:41:24 +08:00			`NER Losses`
			`^^^^^^^^^^^`
			`.. automodule:: mmocr.models.ner.losses`
			`:members:`
update docs 2021-04-08 18:05:46 +08:00
			`mmocr.datasets`
			`-----------------`
			`.. automodule:: mmocr.datasets`
			`:members:`

			`datasets`
			`^^^^^^^^^^^`
			`.. automodule:: mmocr.datasets.base_dataset`
			`:members:`

fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.datasets.icdar_dataset`
			`:members:`
update docs 2021-04-08 18:05:46 +08:00
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.datasets.ocr_dataset`
			`:members:`

			`.. automodule:: mmocr.datasets.ocr_seg_dataset`
update docs 2021-04-08 18:05:46 +08:00			`:members:`

fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.datasets.text_det_dataset`
update docs 2021-04-08 18:05:46 +08:00			`:members:`

fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.datasets.kie_dataset`
update docs 2021-04-08 18:05:46 +08:00			`:members:`


fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`pipelines`
update docs 2021-04-08 18:05:46 +08:00			`^^^^^^^^^^^`
fix api vis bug: sphinx version 2021-04-09 22:18:26 +08:00			`.. automodule:: mmocr.datasets.pipelines`
update docs 2021-04-08 18:05:46 +08:00			`:members:`
fix readthedoc (#247) 2021-05-27 21:58:11 +08:00
			`utils`
			`^^^^^^^^^^^`
			`.. automodule:: mmocr.datasets.utils`
			`:members:`