README.md 11.8 KB
Newer Older
G
grasswolfs 已提交
1 2
English | [简体中文](README_ch.md)

qq_25193841's avatar
qq_25193841 已提交
3 4
# PPOCRLabel

qq_25193841's avatar
qq_25193841 已提交
5
PPOCRLabel is a semi-automatic graphic annotation tool suitable for OCR field, with built-in PPOCR model to automatically detect and re-recognize data. 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 已提交
6

G
grasswolfs 已提交
7
<img src="./data/gif/steps_en.gif" width="100%"/>
qq_25193841's avatar
qq_25193841 已提交
8

9 10
### Recent Update

11 12 13
- 2021.8.11:
  - New functions: Open the dataset folder, image rotation (Note: Please delete the label box before rotating the image) (by [Wei-JL](https://github.com/Wei-JL))
  - Added shortcut key description (Help-Shortcut Key), repaired the direction shortcut key movement function under batch processing (by [d2623587501](https://github.com/d2623587501))
14
- 2021.2.5: New batch processing and undo functions (by [Evezerest](https://github.com/Evezerest)):
15 16
  - **Batch processing function**: Press and hold the Ctrl key to select the box, you can move, copy, and delete in batches.
  - **Undo function**: In the process of drawing a four-point label box or after editing the box, press Ctrl+Z to undo the previous operation.
17
  - Fix image rotation and size problems, optimize the process of editing the mark frame (by [ninetailskim](https://github.com/ninetailskim)[edencfc](https://github.com/edencfc)).
18
- 2021.1.11: Optimize the labeling experience (by [edencfc](https://github.com/edencfc)),
W
WenmuZhou 已提交
19
  - Users can choose whether to pop up the label input dialog after drawing the detection box in "View - Pop-up Label Input Dialog".
20 21
  - The recognition result scrolls synchronously when users click related detection box.
  - Click to modify the recognition result.(If you can't change the result, please switch to the system default input method, or switch back to the original input method again)
22 23
- 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 已提交
24 25 26
### TODO:
- Lock box mode: For the same scene data, the size and position of the locked detection box can be transferred between different pictures.

G
grasswolfs 已提交
27
## Installation
qq_25193841's avatar
qq_25193841 已提交
28

29
### 1. Environment Preparation
G
grasswolfs 已提交
30

31 32 33 34 35 36
#### **Install PaddlePaddle 2.0**

```bash
pip3 install --upgrade pip

# If you have cuda9 or cuda10 installed on your machine, please run the following command to install
37
python3 -m pip install paddlepaddle-gpu -i https://mirror.baidu.com/pypi/simple
38 39

# If you only have cpu on your machine, please run the following command to install
40
python3 -m pip install paddlepaddle -i https://mirror.baidu.com/pypi/simple
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
```

For more software version requirements, please refer to the instructions in [Installation Document](https://www.paddlepaddle.org.cn/install/quick) for operation.

#### **Install PaddleOCR**

```bash
# Recommend
git clone https://github.com/PaddlePaddle/PaddleOCR

# If you cannot pull successfully due to network problems, you can also choose to use the code hosting on the cloud:

git clone https://gitee.com/paddlepaddle/PaddleOCR

# Note: The cloud-hosting code may not be able to synchronize the update with this GitHub project in real time. There might be a delay of 3-5 days. Please give priority to the recommended method.
```

#### **Install Third-party Libraries**

```bash
cd PaddleOCR
pip3 install -r requirements.txt
```

If you getting this error `OSError: [WinError 126] The specified module could not be found` when you install shapely on windows. Please try to download Shapely whl file using http://www.lfd.uci.edu/~gohlke/pythonlibs/#shapely.

Reference: [Solve shapely installation on windows](https://stackoverflow.com/questions/44398265/install-shapely-oserror-winerror-126-the-specified-module-could-not-be-found)
G
grasswolfs 已提交
68 69

### 2. Install PPOCRLabel
qq_25193841's avatar
qq_25193841 已提交
70

qq_25193841's avatar
qq_25193841 已提交
71
#### Windows
G
grasswolfs 已提交
72

73
```bash
qq_25193841's avatar
qq_25193841 已提交
74
pip install pyqt5
G
grasswolfs 已提交
75 76
cd ./PPOCRLabel # Change the directory to the PPOCRLabel folder
python PPOCRLabel.py
qq_25193841's avatar
qq_25193841 已提交
77 78 79 80
```

#### Ubuntu Linux

81
```bash
qq_25193841's avatar
qq_25193841 已提交
82 83
pip3 install pyqt5
pip3 install trash-cli
G
grasswolfs 已提交
84 85
cd ./PPOCRLabel # Change the directory to the PPOCRLabel folder
python3 PPOCRLabel.py
qq_25193841's avatar
qq_25193841 已提交
86 87
```

88 89
#### MacOS
```bash
qq_25193841's avatar
qq_25193841 已提交
90
pip3 install pyqt5
G
grasswolfs 已提交
91
pip3 uninstall opencv-python # Uninstall opencv manually as it conflicts with pyqt
W
WenmuZhou 已提交
92
pip3 install opencv-contrib-python-headless==4.2.0.32 # Install the headless version of opencv
G
grasswolfs 已提交
93 94
cd ./PPOCRLabel # Change the directory to the PPOCRLabel folder
python3 PPOCRLabel.py
qq_25193841's avatar
qq_25193841 已提交
95 96
```

G
grasswolfs 已提交
97 98 99 100 101 102 103 104 105 106 107 108 109
## 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.
qq_25193841's avatar
qq_25193841 已提交
110

qq_25193841's avatar
qq_25193841 已提交
111
   4.2 Press 'Q' 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.
qq_25193841's avatar
qq_25193841 已提交
112

G
grasswolfs 已提交
113
5. After the marking frame is drawn, the user clicks "OK", and the detection frame will be pre-assigned a "TEMPORARY" label.
qq_25193841's avatar
qq_25193841 已提交
114

G
grasswolfs 已提交
115
6. Click 're-Recognition', model will rewrite ALL recognition results in ALL detection box<sup>[3]</sup>.
qq_25193841's avatar
qq_25193841 已提交
116

G
grasswolfs 已提交
117
7. Double click the result in 'recognition result' list to manually change inaccurate recognition results.
qq_25193841's avatar
qq_25193841 已提交
118

119
8. **Click "Check", the image status will switch to "√",then the program automatically jump to the next.**
qq_25193841's avatar
qq_25193841 已提交
120

G
grasswolfs 已提交
121
9. Click "Delete Image" and the image will be deleted to the recycle bin.
qq_25193841's avatar
qq_25193841 已提交
122

123
10. Labeling result: the user can export the label result manually through the menu "File - Export Label", while the program will also export automatically if "File - Auto export Label Mode" is selected. The manually checked label will be stored in *Label.txt* under the opened picture folder. Click "File"-"Export 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>.
qq_25193841's avatar
qq_25193841 已提交
124

G
grasswolfs 已提交
125 126 127 128 129 130
### 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 "√".

131
[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.
G
grasswolfs 已提交
132 133 134 135

[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.

|   File name   |                         Description                          |
qq_25193841's avatar
qq_25193841 已提交
136
| :-----------: | :----------------------------------------------------------: |
137
|   Label.txt   | The detection label file can be directly used for PPOCR detection model training. After the user saves 5 label results, the file will be automatically exported. It will also be written when the user closes the application or changes the file folder. |
G
grasswolfs 已提交
138 139
| 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.     |
140
|  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"-"Export recognition result". |
G
grasswolfs 已提交
141 142 143 144
|   crop_img    | The recognition data, generated at the same time with *rec_gt.txt* |

## Explanation

145 146
### Shortcut keys

147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
| Shortcut keys            | Description                                      |
| ------------------------ | ------------------------------------------------ |
| 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                    |
| Ctrl + C                 | Copy and paste the selected box                  |
| Ctrl + Left Mouse Button | Multi select the label 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                                |
164

G
grasswolfs 已提交
165 166 167 168
### Built-in Model

- 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.

W
WenmuZhou 已提交
169
- 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.
G
grasswolfs 已提交
170
  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 已提交
171

G
grasswolfs 已提交
172
- 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)
qq_25193841's avatar
qq_25193841 已提交
173

174
### Export Label Result
175

176
PPOCRLabel supports three ways to export Label.txt
177

178 179 180
- Automatically export: After selecting "File - Auto Export Label Mode", the program will automatically write the annotations into Label.txt every time the user confirms an image. If this option is not turned on, it will be automatically exported after detecting that the user has manually checked 5 images.
- Manual export: Click "File-Export Marking Results" to manually export the label.
- Close application export
181 182


183
### Export Partial Recognition Results
qq_25193841's avatar
qq_25193841 已提交
184

G
grasswolfs 已提交
185
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.
qq_25193841's avatar
qq_25193841 已提交
186

G
grasswolfs 已提交
187
*Note: The status of the checkboxes in the recognition results still needs to be saved manually by clicking Save Button.*
qq_25193841's avatar
qq_25193841 已提交
188

G
grasswolfs 已提交
189
### Error message
qq_25193841's avatar
qq_25193841 已提交
190

G
grasswolfs 已提交
191
- 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.
qq_25193841's avatar
qq_25193841 已提交
192

G
grasswolfs 已提交
193
- 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:
qq_25193841's avatar
qq_25193841 已提交
194

G
grasswolfs 已提交
195 196 197 198 199 200 201
    ```
    pip install opencv-python==4.2.0.32
    ```
- If you get an error starting with **Missing string id **,you need to recompile resources:
    ```
    pyrcc5 -o libs/resources.py resources.qrc
    ```
W
WenmuZhou 已提交
202
- If you get an error ``` module 'cv2' has no attribute 'INTER_NEAREST'```, you need to delete all opencv related packages first, and then reinstall the 4.2.0.32  version of headless opencv
qq_25193841's avatar
qq_25193841 已提交
203
    ```
W
WenmuZhou 已提交
204
    pip install opencv-contrib-python-headless==4.2.0.32
qq_25193841's avatar
qq_25193841 已提交
205
    ```
W
WenmuZhou 已提交
206

G
grasswolfs 已提交
207
### Related
qq_25193841's avatar
qq_25193841 已提交
208

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