文本识别数据生成器

用于文本识别的合成数据生成工具

它用来做什么？

生成用于训练 OCR 软件的文本图像样本。现已支持非拉丁文字！如需更详细的教程，请参阅官方文档。

我需要什么才能让它运行？

安装 PyPI 包：

pip install trdg

安装完成后，您就可以在命令行中使用 trdg。建议使用虚拟环境，而不是使用 sudo 进行安装。

如果您想添加其他语言，可以克隆仓库。只需运行 pip install -r requirements.txt 即可。

Docker 镜像

如果您不想安装任何东西就能使用 TextRecognitionDataGenerator，可以直接拉取 Docker 镜像。

docker pull belval/trdg:latest

docker run -v /output/path/:/app/out/ -t belval/trdg:latest trdg [args]

路径（/output/path/）必须是绝对路径。

新特性

• 添加 --stroke_width 参数，用于设置文本描边的宽度（感谢 @SunHaozhe）
• 添加 --stroke_fill 参数，用于设置当描边宽度大于 0 时的描边颜色（感谢 @SunHaozhe）
• 添加 --word_split 参数，用于按单词而非单个字符进行分割。这对于基于连字的语言非常有用。
• 添加 --dict 参数，用于指定自定义词典（感谢 @luh0907）
• 添加 --font_dir 参数，用于指定要使用的字体目录。
• 添加 --output_mask，用于输出每张图像的字符级掩码。
• 添加 --character_spacing，用于控制字符之间的间距（以像素为单位）。
• 添加 Python 模块。
• 添加 --font 参数，用于在所有生成的图像中仅使用一种字体（感谢 @JulienCoutault！）
• 添加 --fit 和 --margins，以实现更精细的布局控制。
• 使用 -or 参数更改文本方向。
• 使用 -tc '#000000,#FFFFFF' 指定文本颜色范围，注意引号是必需的。
• 增加对简体中文和繁体中文的支持。

它是如何工作的？

系统会从特定语言的词典中随机选择单词，然后根据指定的字体、背景以及各种变换（如扭曲、模糊等），生成包含这些单词的图像。

基本用法（Python 模块）

作为 Python 模块的使用方式与命令行类似，但如果您希望将其直接集成到训练流程中，这种方式更加灵活，且占用的空间和内存更少。共有四种生成器可供使用。

from trdg.generators import (
    GeneratorFromDict,
    GeneratorFromRandom,
    GeneratorFromStrings,
    GeneratorFromWikipedia,
)

# 生成器使用的参数与命令行相同，只是以参数形式传入
generator = GeneratorFromStrings(
    ['Test1', 'Test2', 'Test3'],
    blur=2,
    random_blur=True
)

for img, lbl in generator:
    # 在这里对 Pillow 图像进行处理。

完整的类定义如下：

• GeneratorFromDict
• GeneratorFromRandom
• GeneratorFromStrings
• GeneratorFromWikipedia

基本用法（命令行）

trdg -c 1000 -w 5 -f 64

您将获得 1,000 张随机生成的图像，上面带有随机文本，例如：

默认情况下，这些图像会被保存到当前工作目录下的 out/ 文件夹中。

文本倾斜

如果您想要随机倾斜效果呢？只需添加 -k 和 -rk 参数即可（trdg -c 1000 -w 5 -f 64 -k 5 -rk）。

文本扭曲

您还可以通过 -d 和 -do 参数为生成的文本添加扭曲效果。

文本模糊

不过，扫描的文档通常并不那么清晰，对吧？您可以添加 -bl 和 -rbl 参数，在生成的图像上应用高斯模糊，用户可以自定义模糊半径（此处分别为 0、1、2、4）：

背景

也许您想要不同的背景？可以使用 -b 参数来选择三种可用背景之一：高斯噪声（0）、纯白色（1）、准晶图案（2），或者使用图片背景（3）。

当使用图片背景（3）时，系统会从 images/ 文件夹中随机选择一张图片，并在其上绘制文本。

手写体

或者您正在开发手写文本的 OCR 吗？可以添加 -hw 参数！（实验性功能）

该功能使用由 Grzego 训练的 TensorFlow 模型，模型基于 这个优秀的项目。

如果您不使用此功能，则该项目无需 TensorFlow 即可运行。

词典

文本是从词典文件中随机选取的（该文件位于 dicts 文件夹中），并绘制在由高斯噪声生成的白色背景上。最终生成的图像会保存为 [text]_[index].jpg。

有许多参数可以调整以获得所需的效果，因此建议查看 trdg -h 获取更多信息。

生成中文文本图像

很简单！只需执行 trdg -l cn -c 1000 -w 5！

生成的文本既有简体中文，也有繁体中文。

繁体中文：

简体中文：

生成日文文本图像

也很简单！只需执行 trdg -l ja -c 1000 -w 5！

输出：

添加新字体

脚本会从 fonts 目录中随机选择一种字体。

目录	语言
fonts/latin	英语、法语、西班牙语、德语
fonts/cn	中文
fonts/ko	韩语
fonts/ja	日语
fonts/th	泰语

只需添加或删除字体，直到获得所需的效果。

若要添加新的非拉丁文字语言，所需的工作量非常小。

1. 创建一个以该语言 双字母代码 命名的新文件夹。
2. 在其中放入一个 .ttf 格式的字体文件。
3. 编辑 run.py 文件，在 load_fonts() 函数中添加一条 if 语句。
4. 在 dicts 目录中创建一个同名双字母代码的文本文件。
5. 按照常规方式运行工具，但需加上 -l 参数，并指定你的双字母代码。

目前仅支持 .ttf 格式字体。

基准测试

每秒生成的图片数量。

• Intel Core i7-4710HQ @ 2.50Ghz + SSD (-c 1000 -w 1)
  • -t 1 : 363 张/秒
  • -t 2 : 694 张/秒
  • -t 4 : 1300 张/秒
  • -t 8 : 1500 张/秒
• AMD Ryzen 7 1700 @ 4.0Ghz + SSD (-c 1000 -w 1)
  • -t 1 : 558 张/秒
  • -t 2 : 1045 张/秒
  • -t 4 : 2107 张/秒
  • -t 8 : 3297 张/秒

贡献说明

1. 创建一个议题，描述你将要实现的功能。
2. 实现该功能。
3. 提交拉取请求。

功能请求与问题

如果发现有任何缺失、不明确或无法正常工作的情况，请在仓库中提交一个议题。

尚待完成的工作？

• 改进背景生成
• 改进手写文本生成
• 增加更多自定义参数（主要针对背景）

TextRecognitionDataGenerator 快速上手指南

TextRecognitionDataGenerator (trdg) 是一个用于生成合成文本图像数据的工具，专为训练 OCR（光学字符识别）模型设计。它支持包括简体中文、繁体中文、日文在内的多种非拉丁语言，并可模拟模糊、倾斜、扭曲等真实场景效果。

环境准备

• 操作系统：Linux, macOS, Windows
• Python 版本：建议 Python 3.6+
• 前置依赖：
  • 若使用手写字体生成功能，需安装 TensorFlow（可选）。
  • 若通过源码运行而非 Docker，需确保系统已安装基础编译工具及字体库。

安装步骤

推荐优先使用国内镜像源加速安装。

方式一：通过 PyPI 安装（推荐）

pip install trdg -i https://pypi.tuna.tsinghua.edu.cn/simple

提示：建议在虚拟环境（virtualenv）中安装，避免污染系统环境。

方式二：使用 Docker（无需配置环境）

如果你希望免去环境配置烦恼，可直接拉取 Docker 镜像：

docker pull belval/trdg:latest

基本使用

安装完成后，即可在命令行直接使用 trdg 命令，或在 Python 代码中作为模块调用。

1. 命令行 (CLI) 模式

生成 1000 张包含 5 个随机单词的图片：

trdg -c 1000 -w 5

• -c: 生成的图片数量 (count)
• -w: 每张包含的单词数 (words)
• 默认输出目录为当前路径下的 out/ 文件夹。

生成中文文本图片（简体/繁体）：

trdg -l cn -c 1000 -w 5

• -l: 指定语言代码（cn 代表中文，ja 代表日文，ko 代表韩文等）。

添加干扰效果（模拟真实扫描文档）：

# 添加随机倾斜 (-k) 和高斯模糊 (-bl)
trdg -c 1000 -w 5 -k 5 -rk -bl 2 -rbl

查看完整参数帮助：

trdg -h

2. Python 模块模式

适合直接集成到训练管道中，更灵活且节省内存。

from trdg.generators import GeneratorFromStrings

# 自定义文本列表生成器
generator = GeneratorFromStrings(
    ['测试数据 1', '人工智能', 'OCR 训练'],
    blur=2,
    random_blur=True
)

for img, lbl in generator:
    # img 为 PIL 图像对象，lbl 为对应的文本标签
    # 在此处处理图像或存入数据集
    pass

其他可用生成器类：

• GeneratorFromDict: 从内置字典随机选取单词。
• GeneratorFromRandom: 生成随机字符组合。
• GeneratorFromWikipedia: 从维基百科抓取文本生成。

3. Docker 使用示例

若使用 Docker，需挂载输出目录（路径必须为绝对路径）：

docker run -v /absolute/path/to/output/:/app/out/ -t belval/trdg:latest trdg -c 1000 -w 5 -l cn