Synthetic Text Image Generator for OCR Model |Paper |Documentation |Datasets

Contents

Documentation

Installation

$ pip install synthtiger

Usage

# Set environment variable (for macOS)$export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES

usage: synthtiger [-h] [-o DIR] [-c NUM] [-w NUM] [-s NUM] [-v] SCRIPT NAME [CONFIG]positional arguments:  SCRIPT                Script file path.  NAME                  Template class name.  CONFIG                Config file path.optional arguments:  -h, --help            show this help message and exit  -o DIR, --output DIR  Directory path to save data.  -c NUM, --count NUM   Number of output data. [default: 100]  -w NUM, --worker NUM  Number of workers. If 0, It generates data in the main process. [default: 0]  -s NUM, --seed NUM    Random seed. [default: None]  -v, --verbose         Print error messages while generating data.

Examples

SynthTIGER text images

# horizontalsynthtiger -o results -w 4 -v examples/synthtiger/template.py SynthTiger examples/synthtiger/config_horizontal.yaml# verticalsynthtiger -o results -w 4 -v examples/synthtiger/template.py SynthTiger examples/synthtiger/config_vertical.yaml

Multiline text images

synthtiger -o results -w 4 -v examples/multiline/template.py Multiline examples/multiline/config.yaml

Advanced Usage

Non-Latin language data generation

Font customization

Colormap customization

Template customization

fromsynthtigerimporttemplatesclassMyTemplate(templates.Template):def__init__(self,config=None):# initialize template.defgenerate(self):# generate data.definit_save(self,root):# initialize something before save.defsave(self,root,data,idx):# save data to specific path.defend_save(self,root):# finalize something after save.

Datasets

# for Linux, macOScat synthtiger_v1.0.zip.*> synthtiger_v1.0.zip# for Windowscopy /b synthtiger_v1.0.zip.* synthtiger_v1.0.zip

Structure

gt.txtimages/    0/        0.jpg        1.jpg        ...        9998.jpg        9999.jpg    1/    ...    998/    999/

images/0/0.jpg10images/0/1.jpgdate:...images/999/9999998.jpgSTUFFIERimages/999/9999999.jpgRe:

Citation

@inproceedings{yim2021synthtiger,title={SynthTIGER: Synthetic Text Image GEneratoR Towards Better Text Recognition Models},author={Yim, Moonbin and Kim, Yoonsik and Cho, Han-Cheol and Park, Sungrae},booktitle={International Conference on Document Analysis and Recognition},pages={109--124},year={2021},organization={Springer}}

License

SynthTIGERCopyright (c) 2021-present NAVER Corp.Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included inall copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS INTHE SOFTWARE.

docs/resources/font/