Welcome to MMOCR's documentation!
=======================================

You can switch between English and Chinese in the lower-left corner of the layout.

.. toctree::
   :maxdepth: 2
   :caption: Get Started

   get_started/overview.md
   get_started/install.md
   get_started/quick_run.md
   get_started/faq.md

.. toctree::
   :maxdepth: 2
   :caption: User Guides

   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

.. toctree::
   :maxdepth: 2
   :caption: Basic Concepts

   basic_concepts/structures.md
   basic_concepts/transforms.md
   basic_concepts/evaluation.md
   basic_concepts/datasets.md
   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


.. toctree::
   :maxdepth: 2
   :caption: Dataset Zoo

   user_guides/data_prepare/datasetzoo.md
   user_guides/data_prepare/dataset_preparer.md
   user_guides/data_prepare/det.md
   user_guides/data_prepare/recog.md
   user_guides/data_prepare/kie.md

.. toctree::
   :maxdepth: 2
   :caption: Model Zoo

   modelzoo.md
   projectzoo.md
   backbones.md
   textdet_models.md
   textrecog_models.md
   kie_models.md

.. toctree::
   :maxdepth: 2
   :caption: Notes

   notes/branches.md
   notes/contribution_guide.md
   notes/changelog.md

.. toctree::
   :maxdepth: 2
   :caption: Migrating from MMOCR 0.x

   migration/overview.md
   migration/news.md
   migration/branches.md
   migration/code.md
   migration/dataset.md
   migration/model.md
   migration/transforms.md

.. toctree::
   :maxdepth: 1
   :caption: API Reference

   mmocr.apis <api/apis>
   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>

.. toctree::
   :maxdepth: 2
   :caption: Contact US

   contact.md

.. toctree::
   :caption: Switch Language

   switch_language.md


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`