2021-04-03 01:21:33 +08:00
|
|
|
Welcome to MMOCR's documentation!
|
|
|
|
|
=======================================
|
|
|
|
|
|
2021-07-07 14:13:27 +08:00
|
|
|
You can switch between English and Chinese in the lower-left corner of the layout.
|
|
|
|
|
|
2021-05-12 09:57:53 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
2022-08-29 15:37:13 +08:00
|
|
|
:caption: Get Started
|
2021-04-03 01:21:33 +08:00
|
|
|
|
2022-08-29 15:37:13 +08:00
|
|
|
get_started/overview.md
|
|
|
|
|
get_started/install.md
|
|
|
|
|
get_started/quick_run.md
|
2023-03-10 14:51:57 +08:00
|
|
|
get_started/faq.md
|
2021-04-03 01:21:33 +08:00
|
|
|
|
2021-11-11 17:39:27 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
2022-08-29 15:37:13 +08:00
|
|
|
:caption: User Guides
|
2021-11-11 17:39:27 +08:00
|
|
|
|
2022-08-29 15:37:13 +08:00
|
|
|
user_guides/inference.md
|
|
|
|
|
user_guides/config.md
|
|
|
|
|
user_guides/dataset_prepare.md
|
|
|
|
|
user_guides/train_test.md
|
|
|
|
|
user_guides/visualization.md
|
|
|
|
|
user_guides/useful_tools.md
|
2021-11-11 17:39:27 +08:00
|
|
|
|
2021-04-03 01:21:33 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
2022-08-29 15:37:13 +08:00
|
|
|
:caption: Basic Concepts
|
|
|
|
|
|
2022-10-17 12:58:35 +08:00
|
|
|
basic_concepts/structures.md
|
|
|
|
|
basic_concepts/transforms.md
|
|
|
|
|
basic_concepts/evaluation.md
|
2023-03-27 12:47:01 +08:00
|
|
|
basic_concepts/datasets.md
|
2022-08-29 15:37:13 +08:00
|
|
|
basic_concepts/overview.md
|
|
|
|
|
basic_concepts/data_flow.md
|
|
|
|
|
basic_concepts/models.md
|
|
|
|
|
basic_concepts/visualizers.md
|
|
|
|
|
basic_concepts/convention.md
|
|
|
|
|
basic_concepts/engine.md
|
2021-04-03 01:21:33 +08:00
|
|
|
|
|
|
|
|
|
2021-04-08 18:05:46 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
2021-08-25 16:41:07 +08:00
|
|
|
:caption: Dataset Zoo
|
2021-04-08 18:05:46 +08:00
|
|
|
|
2022-11-02 15:06:49 +08:00
|
|
|
user_guides/data_prepare/datasetzoo.md
|
|
|
|
|
user_guides/data_prepare/dataset_preparer.md
|
2022-08-31 20:16:33 +08:00
|
|
|
user_guides/data_prepare/det.md
|
|
|
|
|
user_guides/data_prepare/recog.md
|
|
|
|
|
user_guides/data_prepare/kie.md
|
2022-08-29 15:37:13 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: Model Zoo
|
|
|
|
|
|
|
|
|
|
modelzoo.md
|
2023-03-10 15:09:37 +08:00
|
|
|
projectzoo.md
|
2022-11-03 19:01:16 +08:00
|
|
|
backbones.md
|
2022-08-29 15:37:13 +08:00
|
|
|
textdet_models.md
|
|
|
|
|
textrecog_models.md
|
|
|
|
|
kie_models.md
|
2021-04-08 18:05:46 +08:00
|
|
|
|
2021-08-25 16:41:07 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
2022-08-29 15:37:13 +08:00
|
|
|
:caption: Notes
|
2021-08-25 16:41:07 +08:00
|
|
|
|
2022-08-29 15:37:13 +08:00
|
|
|
notes/contribution_guide.md
|
|
|
|
|
notes/changelog.md
|
2021-04-03 01:21:33 +08:00
|
|
|
|
2023-03-10 15:09:37 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: Migrating from MMOCR 0.x
|
|
|
|
|
|
|
|
|
|
migration/overview.md
|
|
|
|
|
migration/code.md
|
|
|
|
|
migration/dataset.md
|
|
|
|
|
migration/model.md
|
|
|
|
|
migration/transforms.md
|
|
|
|
|
|
2021-04-03 01:21:33 +08:00
|
|
|
.. toctree::
|
2022-08-29 15:37:13 +08:00
|
|
|
:maxdepth: 1
|
2021-04-03 01:21:33 +08:00
|
|
|
:caption: API Reference
|
|
|
|
|
|
2023-02-02 19:05:55 +08:00
|
|
|
mmocr.apis <api/apis>
|
2022-10-10 11:35:33 +08:00
|
|
|
mmocr.structures <api/structures>
|
|
|
|
|
mmocr.datasets <api/datasets>
|
|
|
|
|
mmocr.transforms <api/transforms>
|
|
|
|
|
mmocr.models <api/models>
|
|
|
|
|
mmocr.evaluation <api/evaluation>
|
|
|
|
|
mmocr.visualization <api/visualization>
|
|
|
|
|
mmocr.engine <api/engine>
|
|
|
|
|
mmocr.utils <api/utils>
|
2021-04-03 01:21:33 +08:00
|
|
|
|
2023-01-06 17:29:28 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: Contact US
|
|
|
|
|
|
|
|
|
|
contact.md
|
|
|
|
|
|
2021-07-07 16:21:52 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:caption: Switch Language
|
|
|
|
|
|
2022-08-29 15:37:13 +08:00
|
|
|
switch_language.md
|
|
|
|
|
|
2021-07-07 16:21:52 +08:00
|
|
|
|
2021-04-03 01:21:33 +08:00
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`search`
|
