mmocr/docs/en/api.rst

236 lines
4.9 KiB
ReStructuredText

mmocr.engine
-------------
.. automodule:: mmocr.engine.hooks
:members:
mmocr.evaluation
-------------
.. automodule:: mmocr.evaluation.evaluator
:members:
.. automodule:: mmocr.evaluation.functional
:members:
.. automodule:: mmocr.evaluation.metircs
:members:
mmocr.utils
-------------
Point utils
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.utils.point_utils
:members:
Bbox utils
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.utils.bbox_utils
:members:
Polygon utils
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.utils.polygon_utils
:members:
Mask utils
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.utils.mask_utils
:members:
String utils
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.utils.string_utils
:members:
Image utils
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.utils.img_utils
:members:
File IO utils
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.utils.fileio
:members:
Others
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.utils.data_converter_utils
:members:
.. automodule:: mmocr.utils.parsers
:members:
mmocr.models
---------------
Common
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.common.backbones
:members:
.. automodule:: mmocr.models.common.losses
:members:
.. automodule:: mmocr.models.common.dictionary
:members:
.. automodule:: mmocr.models.common.layers
:members:
.. automodule:: mmocr.models.common.modules
:members:
Text Detection Detectors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textdet.detectors
:members:
Text Detection Heads
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textdet.heads
:members:
Text Detection Necks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textdet.necks
:members:
Text Detection Module Losses
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textdet.module_losses
:members:
Text Detection Preprocessors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textdet.data_preprocessors
:members:
Text Detection Postprocessors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textdet.postprocessors
:members:
Text Recognition Recognizer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.recognizers
:members:
Text Recognition Backbones
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.backbones
:members:
Text Recognition Preprocessors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.data_preprocessors
:members:
Text Recognition Layers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.layers
:members:
Text Recognition Plugins
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.plugins
:members:
Text Recognition Encoders
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.encoders
:members:
Text Recognition Decoders
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.decoders
:members:
Text Recognition Module Losses
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmocr.models.textrecog.module_losses
:members:
KIE Extractors
^^^^^^^^^^^^^^
.. automodule:: mmocr.models.kie.extractors
:members:
KIE Heads
^^^^^^^^^^^
.. automodule:: mmocr.models.kie.heads
:members:
KIE Module Losses
^^^^^^^^^^^
.. automodule:: mmocr.models.kie.module_losses
:members:
mmocr.datasets
-----------------
.. automodule:: mmocr.datasets
:members:
Dataset Types
^^^^^^^^^^^
.. automodule:: mmocr.datasets.ocr_dataset
:members:
.. automodule:: mmocr.datasets.icdar_dataset
:members:
.. automodule:: mmocr.datasets.recog_lmdb_dataset
:members:
.. automodule:: mmocr.datasets.recog_text_dataset
:members:
.. automodule:: mmocr.datasets.wildreceipt_dataset
:members:
Transforms
^^^^^^^^^^^
.. automodule:: mmocr.datasets.transforms
:members:
mmocr.structures
-----------------
Text Detection Data Sample
^^^^^^^^^^^
.. automodule:: mmocr.structures.textdet_data_sample
:members:
Text Recognition Data Sample
^^^^^^^^^^^
.. automodule:: mmocr.structures.textrecog_data_sample
:members:
KIE Data Sample
^^^^^^^^^^^
.. automodule:: mmocr.structures.kie_data_sample
:members:
mmocr.visualization
-----------------
visualize
^^^^^^^^^^^
.. automodule:: mmocr.visualization.visualize
:members:
Text Detection Visualizer
^^^^^^^^^^^
.. automodule:: mmocr.visualization.textdet_visualizer
:members:
Text Recognition Visualizer
^^^^^^^^^^^
.. automodule:: mmocr.visualization.textrecog_visualizer
:members: