Introduction

English | 简体中文

MMOCR is an open-source toolbox based on PyTorch and mmdetection for text detection, text recognition, and the corresponding downstream tasks including key information extraction. It is part of the OpenMMLab project.

The main branch works with PyTorch 1.6+.

Documentation: https://mmocr.readthedocs.io/en/latest/.

Major Features

• Comprehensive Pipeline

  The toolbox supports not only text detection and text recognition, but also their downstream tasks such as key information extraction.

• Multiple Models

  The toolbox supports a wide variety of state-of-the-art models for text detection, text recognition and key information extraction.

• Modular Design

  The modular design of MMOCR enables users to define their own optimizers, data preprocessors, and model components such as backbones, necks and heads as well as losses. Please refer to getting_started.md for how to construct a customized model.

• Numerous Utilities

  The toolbox provides a comprehensive set of utilities which can help users assess the performance of models. It includes visualizers which allow visualization of images, ground truths as well as predicted bounding boxes, and a validation tool for evaluating checkpoints during training. It also includes data converters to demonstrate how to convert your own data to the annotation files which the toolbox supports.

Model Zoo

Supported algorithms:

Text Detection

• DBNet (AAAI'2020)
• Mask R-CNN (ICCV'2017)
• PANet (ICCV'2019)
• PSENet (CVPR'2019)
• TextSnake (ECCV'2018)
• DRRG (CVPR'2020)
• FCENet (CVPR'2021)

Text Recognition

• CRNN (TPAMI'2016)
• NRTR (ICDAR'2019)
• RobustScanner (ECCV'2020)
• SAR (AAAI'2019)
• SegOCR (Manuscript'2021)

Key Information Extraction

• SDMG-R (ArXiv'2021)

Named Entity Recognition

• Bert-Softmax (NAACL'2019)

Please refer to model_zoo for more details.

License

This project is released under the Apache 2.0 license.

Citation

If you find this project useful in your research, please consider cite:

@misc{mmocr2021,
    title={MMOCR:  A Comprehensive Toolbox for Text Detection, Recognition and Understanding},
    author={MMOCR Contributors},
    howpublished = {\url{https://github.com/open-mmlab/mmocr}},
    year={2021}
}

Changelog

v0.2.1 was released in 2021-7-20.

Installation

Please refer to install.md for installation.

Get Started

Please see getting_started.md for the basic usage of MMOCR.

Contributing

We appreciate all contributions to improve MMOCR. Please refer to CONTRIBUTING.md for the contributing guidelines.

Acknowledgement

MMOCR is an open-source project that is contributed by researchers and engineers from various colleges and companies. We appreciate all the contributors who implement their methods or add new features, as well as users who give valuable feedbacks. We hope the toolbox and benchmark could serve the growing research community by providing a flexible toolkit to reimplement existing methods and develop their own new OCR methods.

Projects in OpenMMLab

• MMCV: OpenMMLab foundational library for computer vision.
• MMClassification: OpenMMLab image classification toolbox and benchmark.
• MMDetection: OpenMMLab detection toolbox and benchmark.
• MMDetection3D: OpenMMLab's next-generation platform for general 3D object detection.
• MMSegmentation: OpenMMLab semantic segmentation toolbox and benchmark.
• MMAction2: OpenMMLab's next-generation action understanding toolbox and benchmark.
• MMPose: OpenMMLab's pose estimation toolbox and benchmark.
• MMTracking: OpenMMLab video perception toolbox and benchmark.
• MMEditing: OpenMMLab image editing toolbox and benchmark.
• MMOCR: A Comprehensive Toolbox for Text Detection, Recognition and Understanding.
• MMGeneration: OpenMMLab image and video generative models toolbox.