mirrors/mmocr
1
0
Fork 0
mirror of https://github.com/open-mmlab/mmocr.git synced 2025-06-03 21:54:47 +08:00
Code Issues Projects Releases Wiki Activity

Fix readthedocs generation (#14)

Browse Source 
* Fix readthedocs

* Fix doc

* md format
This commit is contained in:
lizz 2021-04-08 15:49:46 +08:00 committed by GitHub
parent 6a655ad454
commit 0206781bb6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 81 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
configs/textrecog/crnn/README.md
View File

@ -32,6 +32,6 @@
## Results and models ## Results and models
| methods | | Regular Text | | | | Irregular Text | | download | | methods | | Regular Text | | | | Irregular Text | | download |
| :-----: | :----: | :----------: | :--: | :-: | :--: | :------------: | :--: | :------------------: | | :-----: | :----: | :----------: | :---: | :---: | :---: | :------------: | :---: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| methods | IIIT5K | SVT | IC13 | | IC15 | SVTP | CT80 | | methods | IIIT5K | SVT | IC13 | | IC15 | SVTP | CT80 |
| CRNN | 80.5 | 81.5 | 86.5 | | - | - | - | [model](https://download.openmmlab.com/mmocr/textrecog/crnn/crnn_academic-a723a1c5.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/crnn/20210326_111035.log.json) | | CRNN | 80.5 | 81.5 | 86.5 | | - | - | - | [model](https://download.openmmlab.com/mmocr/textrecog/crnn/crnn_academic-a723a1c5.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/crnn/20210326_111035.log.json) |

2
configs/textrecog/robust_scanner/README.md
View File

@ -42,7 +42,7 @@
## Results and Models ## Results and Models
| Methods | GPUs | | Regular Text | | | | Irregular Text | | download | | Methods | GPUs | | Regular Text | | | | Irregular Text | | download |
| :-----------------------------------------------------------------: | :---------: | :----: | :----------: | :--: | :-: | :--: | :------------: | :--: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | :-----------------------------------------------------------------------------: | :---: | :----: | :----------: | :---: | :---: | :---: | :------------: | :---: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| | | IIIT5K | SVT | IC13 | | IC15 | SVTP | CT80 | | | | IIIT5K | SVT | IC13 | | IC15 | SVTP | CT80 |
| [RobustScanner](configs/textrecog/robust_scanner/robustscanner_r31_academic.py) | 16 | 95.1 | 89.2 | 93.1 | | 77.8 | 80.3 | 90.3 | [model](https://download.openmmlab.com/mmocr/textrecog/robustscanner/robustscanner_r31_academic-5f05874f.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/robustscanner/20210401_170932.log.json) | | [RobustScanner](configs/textrecog/robust_scanner/robustscanner_r31_academic.py) | 16 | 95.1 | 89.2 | 93.1 | | 77.8 | 80.3 | 90.3 | [model](https://download.openmmlab.com/mmocr/textrecog/robustscanner/robustscanner_r31_academic-5f05874f.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/robustscanner/20210401_170932.log.json) |

2
configs/textrecog/sar/README.md
View File

@ -45,7 +45,7 @@
## Results and Models ## Results and Models
| Methods | Backbone | Decoder | | Regular Text | | | | Irregular Text | | download | | Methods | Backbone | Decoder | | Regular Text | | | | Irregular Text | | download |
| :-----------------------------------------------------------------: | :---------: | :------------------: | :----: | :----------: | :--: | :-: | :--: | :------------: | :--: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | :-----------------------------------------------------------------: | :---------: | :------------------: | :----: | :----------: | :---: | :---: | :---: | :------------: | :---: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| | | | IIIT5K | SVT | IC13 | | IC15 | SVTP | CT80 | | | | | IIIT5K | SVT | IC13 | | IC15 | SVTP | CT80 |
| [SAR](/configs/textrecog/sar/sar_r31_parallel_decoder_academic.py) | R31-1/8-1/4 | ParallelSARDecoder | 95.0 | 89.6 | 93.7 | | 79.0 | 82.2 | 88.9 | [model](https://download.openmmlab.com/mmocr/textrecog/sar/sar_r31_parallel_decoder_academic-dba3a4a3.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/sar/20210327_154129.log.json) | | [SAR](/configs/textrecog/sar/sar_r31_parallel_decoder_academic.py) | R31-1/8-1/4 | ParallelSARDecoder | 95.0 | 89.6 | 93.7 | | 79.0 | 82.2 | 88.9 | [model](https://download.openmmlab.com/mmocr/textrecog/sar/sar_r31_parallel_decoder_academic-dba3a4a3.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/sar/20210327_154129.log.json) |
| [SAR](configs/textrecog/sar/sar_r31_sequential_decoder_academic.py) | R31-1/8-1/4 | SequentialSARDecoder | 95.2 | 88.7 | 92.4 | | 78.2 | 81.9 | 89.6 | [model](https://download.openmmlab.com/mmocr/textrecog/sar/sar_r31_sequential_decoder_academic-d06c9a8e.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/sar/20210330_105728.log.json) | | [SAR](configs/textrecog/sar/sar_r31_sequential_decoder_academic.py) | R31-1/8-1/4 | SequentialSARDecoder | 95.2 | 88.7 | 92.4 | | 78.2 | 81.9 | 89.6 | [model](https://download.openmmlab.com/mmocr/textrecog/sar/sar_r31_sequential_decoder_academic-d06c9a8e.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/sar/20210330_105728.log.json) |

4
configs/textrecog/seg/README.md
View File

@ -32,8 +32,8 @@
## Results and Models ## Results and Models
|Backbone|Neck|Head|||Regular Text|||Irregular Text|download | Backbone | Neck | Head | | | Regular Text | | | Irregular Text | download |
| :-------------: | :-----: | :-----: | :------: | :-----: | :----: | :-----: | :-----: | :-----: | :-----: | | :------: | :----: | :---: | :---: | :----: | :----------: | :---: | :---: | :------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| | | | | IIIT5K | SVT | IC13 | | CT80 | | | | | | IIIT5K | SVT | IC13 | | CT80 |
| R31-1/16 | FPNOCR | 1x | | 90.9 | 81.8 | 90.7 | | 80.9 | [model](https://download.openmmlab.com/mmocr/textrecog/seg/seg_r31_1by16_fpnocr_academic-72235b11.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/seg/20210325_112835.log.json) | | R31-1/16 | FPNOCR | 1x | | 90.9 | 81.8 | 90.7 | | 80.9 | [model](https://download.openmmlab.com/mmocr/textrecog/seg/seg_r31_1by16_fpnocr_academic-72235b11.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/seg/20210325_112835.log.json) |

39
docs/datasets.md
View File

@ -1,9 +1,19 @@
# Datasets Preparation # Datasets Preparation
This page lists the datasets which are commonly used in text detection, text recognition and key information extraction, and their download links. This page lists the datasets which are commonly used in text detection, text recognition and key information extraction, and their download links.
<!-- TOC -->
- [Datasets Preparation](#datasets-preparation)
- [Text Detection](#text-detection)
- [Text Recognition](#text-recognition)
- [Key Information Extraction](#key-information-extraction)
<!-- /TOC -->
## Text Detection ## Text Detection
**The structure of the text detection dataset directory is organized as follows.**
``` The structure of the text detection dataset directory is organized as follows.
```text
├── ctw1500 ├── ctw1500
│   ├── imgs │   ├── imgs
│   ├── instances_test.json │   ├── instances_test.json
@ -20,8 +30,9 @@ This page lists the datasets which are commonly used in text detection, text rec
│   ├── imgs │   ├── imgs
│   └── instances_training.lmdb │   └── instances_training.lmdb
``` ```
| Dataset | | Images | | | Annotation Files | | | Note | | | Dataset | | Images | | | Annotation Files | | | Note | |
|:---------:|:-:|:--------------------------:|:-:|:--------------------------------------------:|:---------------------------------------:|:----------------------------------------:|:-:|:----:|---| | :-------: | :---: | :------------------------------------------------------------: | :----------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------: | :-------------------------------------: | :--------------------------------------------------------------------------------------------: | :---: | :---: | --- |
| | | | | training | validation | testing | | | | | | | | | training | validation | testing | | | |
| CTW1500 | | [homepage](https://github.com/Yuliang-Liu/Curve-Text-Detector) | | [instances_training.json](https://download.openmmlab.com/mmocr/data/ctw1500/instances_training.json) | - | [instances_test.json](https://download.openmmlab.com/mmocr/data/ctw1500/instances_test.json) | | | | | CTW1500 | | [homepage](https://github.com/Yuliang-Liu/Curve-Text-Detector) | | [instances_training.json](https://download.openmmlab.com/mmocr/data/ctw1500/instances_training.json) | - | [instances_test.json](https://download.openmmlab.com/mmocr/data/ctw1500/instances_test.json) | | | |
| ICDAR2015 | | [homepage](https://rrc.cvc.uab.es/?ch=4&com=downloads) | | [instances_training.json](https://download.openmmlab.com/mmocr/data/icdar2015/instances_training.json) | - | [instances_test.json](https://download.openmmlab.com/mmocr/data/icdar2015/instances_test.json) | | | | | ICDAR2015 | | [homepage](https://rrc.cvc.uab.es/?ch=4&com=downloads) | | [instances_training.json](https://download.openmmlab.com/mmocr/data/icdar2015/instances_training.json) | - | [instances_test.json](https://download.openmmlab.com/mmocr/data/icdar2015/instances_test.json) | | | |
@ -32,6 +43,7 @@ This page lists the datasets which are commonly used in text detection, text rec
- Step1: Download `ch4_training_images.zip` and `ch4_test_images.zip` from [homepage](https://rrc.cvc.uab.es/?ch=4&com=downloads) - Step1: Download `ch4_training_images.zip` and `ch4_test_images.zip` from [homepage](https://rrc.cvc.uab.es/?ch=4&com=downloads)
- Step2: Download [instances_training.json](https://download.openmmlab.com/mmocr/data/icdar2015/instances_training.json) and [instances_test.json](https://download.openmmlab.com/mmocr/data/icdar2015/instances_test.json) - Step2: Download [instances_training.json](https://download.openmmlab.com/mmocr/data/icdar2015/instances_training.json) and [instances_test.json](https://download.openmmlab.com/mmocr/data/icdar2015/instances_test.json)
- Step3: - Step3:
```bash ```bash
mkdir icdar2015 && cd icdar2015 mkdir icdar2015 && cd icdar2015
mv /path/to/instances_training.json . mv /path/to/instances_training.json .
@ -41,13 +53,15 @@ This page lists the datasets which are commonly used in text detection, text rec
ln -s /path/to/ch4_training_images training ln -s /path/to/ch4_training_images training
ln -s /path/to/ch4_test_images test ln -s /path/to/ch4_test_images test
``` ```
- For `icdar2017`: - For `icdar2017`:
- To avoid the effect of rotation when load `jpg` with opencv, We provide re-saved `png` format image in [renamed_images](https://download.openmmlab.com/mmocr/data/icdar2017/renamed_imgs.tar). You can copy these images to `imgs`. - To avoid the effect of rotation when load `jpg` with opencv, We provide re-saved `png` format image in [renamed_images](https://download.openmmlab.com/mmocr/data/icdar2017/renamed_imgs.tar). You can copy these images to `imgs`.
## Text Recognition ## Text Recognition
**The structure of the text recognition dataset directory is organized as follows.** **The structure of the text recognition dataset directory is organized as follows.**
``` ```text
├── mixture ├── mixture
│   ├── coco_text │   ├── coco_text
│ │ ├── train_label.txt │ │ ├── train_label.txt
@ -92,10 +106,10 @@ This page lists the datasets which are commonly used in text detection, text rec
│   ├── SynthAdd │   ├── SynthAdd
│ │ ├── label.txt │ │ ├── label.txt
│ │ ├── SynthText_Add │ │ ├── SynthText_Add
``` ```
| Dataset | | images | annotation file | annotation file | Note | | Dataset | | images | annotation file | annotation file | Note |
|:----------:|:-:|:---------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------:|:----:| | :--------: | :---: | :-----------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: | :---: |
| | | | training | test | | | | | | training | test | |
| coco_text | | [homepage](https://rrc.cvc.uab.es/?ch=5&com=downloads) | [train_label.txt](https://download.openmmlab.com/mmocr/data/mixture/coco_text/train_label.txt) | - | | | coco_text | | [homepage](https://rrc.cvc.uab.es/?ch=5&com=downloads) | [train_label.txt](https://download.openmmlab.com/mmocr/data/mixture/coco_text/train_label.txt) | - | |
| icdar_2011 | | [homepage](http://www.cvc.uab.es/icdar2011competition/?com=downloads) | [train_label.txt](https://download.openmmlab.com/mmocr/data/mixture/icdar_2015/train_label.txt) | - | | | icdar_2011 | | [homepage](http://www.cvc.uab.es/icdar2011competition/?com=downloads) | [train_label.txt](https://download.openmmlab.com/mmocr/data/mixture/icdar_2015/train_label.txt) | - | |
@ -128,11 +142,11 @@ This page lists the datasets which are commonly used in text detection, text rec
- For `coco_text`: - For `coco_text`:
- Step1: Download from [homepage](https://rrc.cvc.uab.es/?ch=5&com=downloads) - Step1: Download from [homepage](https://rrc.cvc.uab.es/?ch=5&com=downloads)
- Step2: Download [train_label.txt](https://download.openmmlab.com/mmocr/data/mixture/coco_text/train_label.txt) - Step2: Download [train_label.txt](https://download.openmmlab.com/mmocr/data/mixture/coco_text/train_label.txt)
- For `Syn90k`: - For `Syn90k`:
- Step1: Download `mjsynth.tar.gz` from [homepage](https://www.robots.ox.ac.uk/~vgg/data/text/) - Step1: Download `mjsynth.tar.gz` from [homepage](https://www.robots.ox.ac.uk/~vgg/data/text/)
- Step2: Download [shuffle_labels.txt](https://download.openmmlab.com/mmocr/data/mixture/Synth90k/shuffle_labels.txt) - Step2: Download [shuffle_labels.txt](https://download.openmmlab.com/mmocr/data/mixture/Synth90k/shuffle_labels.txt)
- Step3: - Step3:
```bash ```bash
mkdir Syn90k && cd Syn90k mkdir Syn90k && cd Syn90k
@ -147,11 +161,13 @@ This page lists the datasets which are commonly used in text detection, text rec
ln -s /path/to/Syn90k Syn90k ln -s /path/to/Syn90k Syn90k
``` ```
- For `SynthText`: - For `SynthText`:
- Step1: Download `SynthText.zip` from [homepage](https://www.robots.ox.ac.uk/~vgg/data/scenetext/) - Step1: Download `SynthText.zip` from [homepage](https://www.robots.ox.ac.uk/~vgg/data/scenetext/)
- Step2: Download [shuffle_labels.txt](https://download.openmmlab.com/mmocr/data/mixture/SynthText/shuffle_labels.txt) - Step2: Download [shuffle_labels.txt](https://download.openmmlab.com/mmocr/data/mixture/SynthText/shuffle_labels.txt)
- Step3: Download [instances_train.txt](https://download.openmmlab.com/mmocr/data/mixture/SynthText/instances_train.txt) - Step3: Download [instances_train.txt](https://download.openmmlab.com/mmocr/data/mixture/SynthText/instances_train.txt)
- Step4: - Step4:
```bash ```bash
unzip SynthText.zip unzip SynthText.zip
@ -164,10 +180,12 @@ This page lists the datasets which are commonly used in text detection, text rec
ln -s /path/to/SynthText SynthText ln -s /path/to/SynthText SynthText
``` ```
- For `SynthAdd`: - For `SynthAdd`:
- Step1: Download `SynthText_Add.zip` from [SynthAdd](https://pan.baidu.com/s/1uV0LtoNmcxbO-0YA7Ch4dg) (code:627x)) - Step1: Download `SynthText_Add.zip` from [SynthAdd](https://pan.baidu.com/s/1uV0LtoNmcxbO-0YA7Ch4dg) (code:627x))
- Step2: Download [label.txt](https://download.openmmlab.com/mmocr/data/mixture/SynthAdd/label.txt) - Step2: Download [label.txt](https://download.openmmlab.com/mmocr/data/mixture/SynthAdd/label.txt)
- Step3: - Step3:
```bash ```bash
mkdir SynthAdd && cd SynthAdd mkdir SynthAdd && cd SynthAdd
@ -184,8 +202,10 @@ This page lists the datasets which are commonly used in text detection, text rec
``` ```
## Key Information Extraction ## Key Information Extraction
**The structure of the key information extraction dataset directory is organized as follows.**
``` The structure of the key information extraction dataset directory is organized as follows.
```text
└── wildreceipt └── wildreceipt
├── anno_files ├── anno_files
├── class_list.txt ├── class_list.txt
@ -194,4 +214,5 @@ This page lists the datasets which are commonly used in text detection, text rec
├── test.txt ├── test.txt
└── train.txt └── train.txt
``` ```
- Download [wildreceipt.tar](https://download.openmmlab.com/mmocr/data/wildreceipt.tar) - Download [wildreceipt.tar](https://download.openmmlab.com/mmocr/data/wildreceipt.tar)

15
requirements/readthedocs.txt
View File

@ -1,3 +1,18 @@
imgaug
kwarray
lmdb
matplotlib
mmcv mmcv
numpy
Pillow<=6.2.2
Polygon3
pyclipper
pycocotools
python-Levenshtein
scikit-image
scipy
shapely
skimage
titlecase
torch torch
torchvision torchvision