README_en.md 8.0 KB
Newer Older
qq_25193841's avatar
qq_25193841 已提交
1 2
# PPOCRLabel

3
PPOCRLabel is a semi-automatic graphic annotation tool suitable for OCR field. It is written in python3 and pyqt5, supporting rectangular box annotation and four-point annotation modes. Annotations can be directly used for the training of PPOCR detection and recognition models.
qq_25193841's avatar
qq_25193841 已提交
4

qq_25193841's avatar
qq_25193841 已提交
5
<img src="./data/gif/steps_en.gif" width="100%"/>
qq_25193841's avatar
qq_25193841 已提交
6

7 8 9 10
### Recent Update

- 2020.12.18: Support re-recognition of a single label box (by [ninetailskim](https://github.com/ninetailskim) ), perfect shortcut keys.

qq_25193841's avatar
qq_25193841 已提交
11 12 13 14 15 16 17 18 19 20 21 22 23
## Installation

### 1. Install PaddleOCR

Refer to [PaddleOCR installation document](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/doc/doc_ch/installation.md) to prepare PaddleOCR

### 2. Install PPOCRLabel

#### Windows + Anaconda

Download and install [Anaconda](https://www.anaconda.com/download/#download) (Python 3+)

```
qq_25193841's avatar
qq_25193841 已提交
24
pip install pyqt5
qq_25193841's avatar
qq_25193841 已提交
25
cd ./PPOCRLabel # Change the directory to the PPOCRLabel folder
qq_25193841's avatar
qq_25193841 已提交
26
python PPOCRLabel.py
qq_25193841's avatar
qq_25193841 已提交
27 28 29 30 31
```

#### Ubuntu Linux

```
qq_25193841's avatar
qq_25193841 已提交
32 33
pip3 install pyqt5
pip3 install trash-cli
qq_25193841's avatar
qq_25193841 已提交
34
cd ./PPOCRLabel # Change the directory to the PPOCRLabel folder
qq_25193841's avatar
qq_25193841 已提交
35
python3 PPOCRLabel.py
qq_25193841's avatar
qq_25193841 已提交
36 37 38 39 40 41 42 43
```

#### macOS
```
pip3 install pyqt5
pip3 uninstall opencv-python # Uninstall opencv manually as it conflicts with pyqt
pip3 install opencv-contrib-python-headless # Install the headless version of opencv
cd ./PPOCRLabel # Change the directory to the PPOCRLabel folder
qq_25193841's avatar
qq_25193841 已提交
44
python3 PPOCRLabel.py
qq_25193841's avatar
qq_25193841 已提交
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
```

## Usage

### Steps

1. Build and launch using the instructions above.

2. Click 'Open Dir' in Menu/File to select the folder of the picture.<sup>[1]</sup>

3. Click 'Auto recognition', use PPOCR model to automatically annotate images which marked with 'X' <sup>[2]</sup>before the file name.

4. Create Box:

   4.1 Click 'Create RectBox' or press 'W' in English keyboard mode to draw a new rectangle detection box. Click and release left mouse to select a region to annotate the text area.

   4.2 Press 'P' to enter four-point labeling mode which enables you to create any four-point shape by clicking four points with the left mouse button in succession and DOUBLE CLICK the left mouse as the signal of labeling completion.

5. After the marking frame is drawn, the user clicks "OK", and the detection frame will be pre-assigned a "TEMPORARY" label.

6. Click 're-Recognition', model will rewrite ALL recognition results in ALL detection box<sup>[3]</sup>.

7. Double click the result in 'recognition result' list to manually change inaccurate recognition results.

qq_25193841's avatar
qq_25193841 已提交
69
8. Click "Check", the image status will switch to "√",then the program automatically jump to the next(The results will not be written directly to the file at this time).
qq_25193841's avatar
qq_25193841 已提交
70 71 72

9. Click "Delete Image" and the image will be deleted to the recycle bin.

qq_25193841's avatar
qq_25193841 已提交
73
10. Labeling result: the user can save manually through the menu "File - Save Label", while the program will also save automatically after every 10 images confirmed by the user.the manually checked label will be stored in *Label.txt* under the opened picture folder.
qq_25193841's avatar
qq_25193841 已提交
74 75 76 77 78 79 80 81 82 83 84
    Click "PaddleOCR"-"Save Recognition Results" in the menu bar, the recognition training data of such pictures will be saved in the *crop_img* folder, and the recognition label will be saved in *rec_gt.txt*<sup>[4]</sup>.

### Note

[1] PPOCRLabel uses the opened folder as the project. After opening the image folder, the picture will not be displayed in the dialog. Instead, the pictures under the folder will be directly imported into the program after clicking "Open Dir".

[2] The image status indicates whether the user has saved the image manually. If it has not been saved manually it is "X", otherwise it is "√", PPOCRLabel will not relabel pictures with a status of "√".

[3] After clicking "Re-recognize", the model will overwrite ALL recognition results in the picture.
Therefore, if the recognition result has been manually changed before, it may change after re-recognition.

qq_25193841's avatar
qq_25193841 已提交
85
[4] The files produced by PPOCRLabel can be found under the opened picture folder including the following, please do not manually change the contents, otherwise it will cause the program to be abnormal.
qq_25193841's avatar
qq_25193841 已提交
86 87 88 89 90 91

|   File name   |                         Description                          |
| :-----------: | :----------------------------------------------------------: |
|   Label.txt   | The detection label file can be directly used for PPOCR detection model training. After the user saves 10 label results, the file will be automatically saved. It will also be written when the user closes the application or changes the file folder. |
| fileState.txt | The picture status file save the image in the current folder that has been manually confirmed by the user. |
|  Cache.cach   |    Cache files to save the results of model recognition.     |
qq_25193841's avatar
qq_25193841 已提交
92
|  rec_gt.txt   | The recognition label file, which can be directly used for PPOCR identification model training, is generated after the user clicks on the menu bar "File"-"Save recognition result". |
qq_25193841's avatar
qq_25193841 已提交
93 94
|   crop_img    | The recognition data, generated at the same time with *rec_gt.txt* |

95
## Explanation
qq_25193841's avatar
qq_25193841 已提交
96

97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
### Shortcut keys

| Shortcut keys    | Description                                      |
| ---------------- | ------------------------------------------------ |
| Ctrl + shift + A | Automatically label all unchecked images         |
| Ctrl + shift + R | Re-recognize all the labels of the current image |
| W                | Create a rect box                                |
| Q                | Create a four-points box                         |
| Ctrl + E         | Edit label of the selected box                   |
| Ctrl + R         | Re-recognize the selected box                    |
| Backspace        | Delete the selected box                          |
| Ctrl + V         | Check image                                      |
| Ctrl + Shift + d | Delete image                                     |
| D                | Next image                                       |
| A                | Previous image                                   |
| Ctrl++           | Zoom in                                          |
| Ctrl--           | Zoom out                                         |
| ↑→↓←             | Move selected box                                |

qq_25193841's avatar
qq_25193841 已提交
116
### Built-in Model
117

qq_25193841's avatar
qq_25193841 已提交
118
- Default model: PPOCRLabel uses the Chinese and English ultra-lightweight OCR model in PaddleOCR by default, supports Chinese, English and number recognition, and multiple language detection.
119

qq_25193841's avatar
qq_25193841 已提交
120
- Model language switching: Changing the built-in model language is supportable by clicking "PaddleOCR"-"Choose OCR Model" in the menu bar. Currently supported languages​include French, German, Korean, and Japanese. 
121 122
  For specific model download links, please refer to [PaddleOCR Model List](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/doc/doc_en/models_list_en.md#multilingual-recognition-modelupdating)

qq_25193841's avatar
qq_25193841 已提交
123 124
- Custom model: The model trained by users can be replaced by modifying PPOCRLabel.py in [PaddleOCR class instantiation](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/PPOCRLabel/PPOCRLabel.py#L110) referring [Custom Model Code](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/doc/doc_en/whl_en.md#use-custom-model)

125 126 127 128 129 130 131 132 133 134
### Export partial recognition results

For some data that are difficult to recognize, the recognition results will not be exported by **unchecking** the corresponding tags in the recognition results checkbox.

*Note: The status of the checkboxes in the recognition results still needs to be saved manually by clicking Save Button.*

### Error message

- If paddleocr is installed with whl, it has a higher priority than calling PaddleOCR class with paddleocr.py, which may cause an exception if whl package is not updated.

135
- For Linux users, if you get an error starting with **objc[XXXXX]** when opening the software, it proves that your opencv version is too high. It is recommended to install version 4.2:
136 137 138 139

	```
	pip install opencv-python==4.2.0.32
	```
qq_25193841's avatar
qq_25193841 已提交
140 141 142 143
- If you get an error starting with **Missing string id **,you need to recompile resources:
    ```
	pyrcc5 -o libs/resources.py resources.qrc
	```
144
### Related
qq_25193841's avatar
qq_25193841 已提交
145 146

1.[Tzutalin. LabelImg. Git code (2015)](https://github.com/tzutalin/labelImg)