目录

• 文档
• 安装
• 使用
• 高级用法
• 数据集
• 引用
• 许可证

文档

文档可在 https://clovaai.github.io/synthtiger/ 查阅。

您可以在该文档中查看API参考。

安装

SynthTIGER 需要 python>=3.6 和 libraqm。

从 PyPI 安装 SynthTIGER：

$ pip install synthtiger

如果您在安装或运行 SynthTIGER 时遇到依赖错误，请安装依赖项。

使用

# 设置环境变量（适用于macOS）
$ export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES

用法: synthtiger [-h] [-o DIR] [-c NUM] [-w NUM] [-s NUM] [-v] SCRIPT NAME [CONFIG]

位置参数:
  SCRIPT                脚本文件路径。
  NAME                  模板类名称。
  CONFIG                配置文件路径。

可选参数:
  -h, --help            显示此帮助信息并退出
  -o DIR, --output DIR  保存数据的目录路径。
  -c NUM, --count NUM   输出数据的数量。[默认值：100]
  -w NUM, --worker NUM  工作线程数。如果为0，则在主进程中生成数据。[默认值：0]
  -s NUM, --seed NUM    随机种子。[默认值：无]
  -v, --verbose         在生成数据时打印错误信息。

示例

SynthTIGER 文本图像

# 横向
synthtiger -o results -w 4 -v examples/synthtiger/template.py SynthTiger examples/synthtiger/config_horizontal.yaml

# 纵向
synthtiger -o results -w 4 -v examples/synthtiger/template.py SynthTiger examples/synthtiger/config_vertical.yaml

• images: 包含图像的目录。
• gt.txt: 包含文本标签的文件。
• coords.txt: 包含带文本效果字符边界框的文件。
• glyph_coords.txt: 包含不带文本效果字符边界框的文件。
• masks: 包含带文本效果掩码图像的目录。
• glyph_masks: 包含不带文本效果掩码图像的目录。

多行文本图像

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

• images: 包含图像的目录。
• gt.txt: 包含文本标签的文件。

高级用法

非拉丁语种数据生成

1. 准备语料库

   txt 格式，逐行排列（示例）。

2. 准备字体

   更多详情请参见字体定制。

3. 在配置文件中编辑语料库路径和字体路径（示例）

4. 运行 synthtiger

字体定制

1. 准备字体

   ttf/otf 格式（示例）。

2. 提取可渲染字符集

   python tools/extract_font_charset.py -w 4 fonts/
   

   此脚本会提取所有字体文件的可渲染字符集（示例）。

   文本文件会在输入路径下以与字体相同的名称生成。

3. 在配置文件中编辑字体路径（示例）

4. 运行 synthtiger

色彩映射定制

1. 准备图像

   jpg/jpeg/png/bmp 格式。

2. 创建色彩映射

   python tools/create_colormap.py --max_k 3 -w 4 images/ colormap.txt
   

   此脚本会为所有图像文件创建色彩映射（示例）。

3. 在配置文件中编辑色彩映射路径（示例）

4. 运行 synthtiger

模板定制

您可以通过继承基础模板来实现自定义模板。

from synthtiger import templates


class MyTemplate(templates.Template):
    def __init__(self, config=None):
        # 初始化模板。

    def generate(self):
        # 生成数据。

    def init_save(self, root):
        # 在保存之前初始化某些内容。

    def save(self, root, data, idx):
        # 将数据保存到特定路径。

    def end_save(self, root):
        # 在保存完成后完成某些工作。

数据集

SynthTIGER 可在 google drive 上下载。

数据集被拆分为多个较小的文件。请下载所有文件，并运行以下命令。

# 对于Linux、macOS
cat synthtiger_v1.0.zip.* > synthtiger_v1.0.zip

# 对于Windows
copy /b synthtiger_v1.0.zip.* synthtiger_v1.0.zip

synthtiger_v1.0.zip (36G) (md5: 5b5365f4fe15de24e403a9256079be70)

• 原始论文版本。
  • 使用了MJ和ST标签。

synthtiger_v1.1.zip (38G) (md5: b2757a7e2b5040b14ed64c473533b592)

• 使用了MJ和ST词汇表，而非MJ和ST标签。
  • resources/corpus/mjsynth.txt
  • resources/corpus/synthtext.txt
• 修复了一个对弯曲文本应用两次变换的错误。
• 修复了一个将灰度图像错误转换为RGB图像的错误。

版本	IIIT5k	SVT	IC03	IC13	IC15	SVTP	CUTE80	总计
1.0	93.2	87.3	90.5	92.9	72.1	77.7	80.6	85.9
1.1	93.4	87.6	91.4	93.2	73.9	77.8	80.6	86.6

结构

数据集的结构如下。该数据集包含1000万张图像。

gt.txt
images/
    0/
        0.jpg
        1.jpg
        ...
        9998.jpg
        9999.jpg
    1/
    ...
    998/
    999/

gt.txt 的格式如下。图像路径和标签之间用制表符分隔。（<image_path>\t<label>）

images/0/0.jpg	10
images/0/1.jpg	date:
...
images/999/9999998.jpg	STUFFIER
images/999/9999999.jpg	Re:

引用

@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}
}

许可证

SynthTIGER
版权所有 © 2021-至今 NAVER Corp.

特此授予任何人免费获取本软件及其相关文档文件（以下简称“软件”）副本的权利，以对软件进行处理，不受限制，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利，并允许向任何获得软件的人提供服务，但须遵守以下条件：

上述版权声明和本许可声明应包含在软件的所有副本或实质性部分中。

软件按“原样”提供，不提供任何形式的保证，无论是明示的还是默示的，包括但不限于适销性、特定用途适用性和非侵权性的保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任负责，无论其是基于合同、侵权行为或其他原因产生的，与软件或其使用有关的一切责任均由提出请求的一方自行承担。

以下目录及其子目录的许可与原始许可相同。请参阅 NOTICE 文件。

docs/
resources/font/

SynthTIGER 快速上手指南

SynthTIGER 是一个用于生成合成文本图像的工具，旨在提升 OCR 模型的训练效果。它支持水平、垂直及多行文本生成，并允许高度自定义字体、语料和背景。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：Linux, macOS 或 Windows
• Python 版本：>= 3.6
• 系统依赖：必须安装 libraqm 库。
  • Ubuntu/Debian: sudo apt-get install libraqm-dev
  • macOS: brew install libraqm
  • Windows: 需通过 vcpkg 或其他包管理器安装，或预编译二进制文件。

安装步骤

推荐使用 pip 进行安装。国内开发者可使用清华源或阿里源加速下载。

# 使用默认源安装
pip install synthtiger

# 或使用国内镜像源加速安装（推荐）
pip install synthtiger -i https://pypi.tuna.tsinghua.edu.cn/simple

注意：如果运行时报错提示缺少依赖，请检查 libraqm 是否正确安装。

基本使用

1. 环境变量设置 (仅限 macOS)

如果您使用的是 macOS 系统，运行前需设置以下环境变量以避免多进程问题：

export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES

2. 生成水平文本图像

以下命令将使用默认配置生成 100 张水平排列的合成文本图片，并保存到 results 目录，启用 4 个工作线程加速生成。

synthtiger -o results -w 4 -v examples/synthtiger/template.py SynthTiger examples/synthtiger/config_horizontal.yaml

3. 生成垂直文本图像

生成垂直排列的文本图片：

synthtiger -o results -w 4 -v examples/synthtiger/template.py SynthTiger examples/synthtiger/config_vertical.yaml

4. 生成多行文本图像

生成包含多行文本的图片：

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

输出说明

执行完成后，results 目录下将包含：

• images/: 生成的图像文件。
• gt.txt: 对应的文本标签文件（格式：图像路径<TAB>文本内容）。
• coords.txt / glyph_coords.txt: 字符边界框坐标文件。
• masks/ / glyph_masks/: 对应的掩码图像。

常用参数说明

• -o DIR: 指定输出目录。
• -c NUM: 指定生成图片数量（默认 100）。
• -w NUM: 指定工作进程数（默认 0，即单进程；建议根据 CPU 核心数设置，如 4 或 8）。
• -s NUM: 设置随机种子以保证结果可复现。
• -v: 开启详细模式，打印错误信息。