diff --git a/doc/doc_en/style_text_rec_en.md b/StyleTextRec/README.md
similarity index 96%
rename from doc/doc_en/style_text_rec_en.md
rename to StyleTextRec/README.md
index 7e7d29c9..36db8d44 100644
--- a/doc/doc_en/style_text_rec_en.md
+++ b/StyleTextRec/README.md
@@ -7,7 +7,7 @@ The following figure shows some example results. In addition, the actual `namepl
#### Preparation
-1. Please refer the [QUICK INSTALLATION](./installation_en.md) to install PaddlePaddle. Python3 environment is strongly recommended.
+1. Please refer the [QUICK INSTALLATION](../doc/doc_en/installation_en.md) to install PaddlePaddle. Python3 environment is strongly recommended.
2. Download the pretrained models and unzip:
```bash
diff --git a/doc/doc_ch/style_text_rec.md b/StyleTextRec/README_ch.md
similarity index 77%
rename from doc/doc_ch/style_text_rec.md
rename to StyleTextRec/README_ch.md
index 3a6d8b8b..60edf343 100644
--- a/doc/doc_ch/style_text_rec.md
+++ b/StyleTextRec/README_ch.md
@@ -9,21 +9,21 @@
### 工具简介
-
+
Style-Text是对百度自研文本编辑算法《Editing Text in the Wild》中提出的SRNet网络的改进,不同于常用的GAN的方法只选择一个分支,该工具将文本合成任务分解为三个子模块,文本风格迁移模块、背景抽取模块和前背景融合模块,来提升合成数据的效果。下图显示了一些示例结果。
此外,在实际铭牌文本识别场景和韩语文本识别场景,验证了该合成工具的有效性。
### 环境配置
-1. 参考[快速安装](./installation.md),安装PaddleOCR。强烈建议您使用python3环境。
+1. 参考[快速安装](../doc/doc_ch/installation.md),安装PaddleOCR。强烈建议您使用python3环境。
2. 进入`style_text_rec`目录,下载模型,并解压:
```bash
@@ -55,7 +55,7 @@ python3 -m tools.synth_image -c configs/config.yml
1. 运行后,会生成`fake_busion.jpg`,即为最终结果。
-
+
除此之外,程序还会生成并保存中间结果:
* `fake_bg.jpg`:为风格参考图去掉文字后的背景;
@@ -66,7 +66,7 @@ python3 -m tools.synth_image -c configs/config.yml
python3 -m tools.synth_image -c configs/config.yml --style_image examples/style_images/2.jpg --text_corpus PaddleOCR --language en
```
* 注意:语言选项和语料相对应,目前我们支持英文、简体中文和韩语。
-
+
3. 在`tools/synth_image.py`中,我们还提供了一个`batch_synth_images`方法,可以两两组合语料和图片,批量生成一批数据。
### 高级使用
@@ -81,12 +81,15 @@ python3 -m tools.synth_image -c configs/config.yml --style_image examples/style_
* `image_home`:风格图片目录;
* `label_file`:风格图片路径列表文件,如果所用数据集有label,则label_file为label文件路径;
* `with_label`:标志`label_file`是否为label文件。
- 我们提供了一批[样例图](https://paddleocr.bj.bcebos.com/dygraph_v2.0/style_text/chkoen_5w.tar)供您试用。
* `CorpusGenerator`:
* `method`:语料生成方法,目前有`FileCorpus`和`EnNumCorpus`可选。如果使用`EnNumCorpus`,则不需要填写其他配置,否则需要修改`corpus_file`和`language`;
* `language`:语料的语种;
* `corpus_file`: 语料文件路径。
-
+
+ 我们提供了一批[样例图](https://paddleocr.bj.bcebos.com/dygraph_v2.0/style_text/chkoen_5w.tar)供您试用,下面给出了一些示例:
+
+
+
2. 运行`tools/synth_dataset`合成数据:
``` bash
@@ -104,8 +107,17 @@ python3 -m tools.synth_image -c configs/config.yml --style_image examples/style_
### 应用示例
在完成上述操作后,即可得到用于OCR识别的合成数据集,下面给出了一些数据集生成的示例:
+
+
+
+请您参考[OCR识别文档](https://github.com/PaddlePaddle/PaddleOCR/blob/dygraph/doc/doc_ch/recognition.md#%E5%90%AF%E5%8A%A8%E8%AE%AD%E7%BB%83),完成训练。
-接下来请参考[OCR识别文档](https://github.com/PaddlePaddle/PaddleOCR/blob/dygraph/doc/doc_ch/recognition.md#%E5%90%AF%E5%8A%A8%E8%AE%AD%E7%BB%83),完成训练。
+下面展示了一些使用合成数据训练的效果:
+
+| 场景 | 字符 | 原始数据 | 测试数据 | 只使用原始数据的识别准确率 | 新增合成数据 | 使用合成数据识别准确率 | 指标提升 |
+| -------- | ---------- | -------- | -------- | -------------------------- | ------------ | ---------------------- | -------- |
+| 金属表面 | 英文和数字 | 2203 | 650 | 0.5938 | 20000 | 0.7546 | 16% |
+| 随机背景 | 韩语 | 5631 | 1230 | 0.3012 | 100000 | 0.5057 | 20% |
### 项目结构
```
diff --git a/style_text_rec/__init__.py b/StyleTextRec/__init__.py
similarity index 100%
rename from style_text_rec/__init__.py
rename to StyleTextRec/__init__.py
diff --git a/style_text_rec/arch/__init__.py b/StyleTextRec/arch/__init__.py
similarity index 100%
rename from style_text_rec/arch/__init__.py
rename to StyleTextRec/arch/__init__.py
diff --git a/style_text_rec/arch/base_module.py b/StyleTextRec/arch/base_module.py
similarity index 100%
rename from style_text_rec/arch/base_module.py
rename to StyleTextRec/arch/base_module.py
diff --git a/style_text_rec/arch/decoder.py b/StyleTextRec/arch/decoder.py
similarity index 100%
rename from style_text_rec/arch/decoder.py
rename to StyleTextRec/arch/decoder.py
diff --git a/style_text_rec/arch/encoder.py b/StyleTextRec/arch/encoder.py
similarity index 100%
rename from style_text_rec/arch/encoder.py
rename to StyleTextRec/arch/encoder.py
diff --git a/style_text_rec/arch/spectral_norm.py b/StyleTextRec/arch/spectral_norm.py
similarity index 100%
rename from style_text_rec/arch/spectral_norm.py
rename to StyleTextRec/arch/spectral_norm.py
diff --git a/style_text_rec/arch/style_text_rec.py b/StyleTextRec/arch/style_text_rec.py
similarity index 100%
rename from style_text_rec/arch/style_text_rec.py
rename to StyleTextRec/arch/style_text_rec.py
diff --git a/style_text_rec/configs/config.yml b/StyleTextRec/configs/config.yml
similarity index 100%
rename from style_text_rec/configs/config.yml
rename to StyleTextRec/configs/config.yml
diff --git a/style_text_rec/configs/dataset_config.yml b/StyleTextRec/configs/dataset_config.yml
similarity index 100%
rename from style_text_rec/configs/dataset_config.yml
rename to StyleTextRec/configs/dataset_config.yml
diff --git a/doc/imgs_style_text/1.png b/StyleTextRec/doc/images/1.png
similarity index 100%
rename from doc/imgs_style_text/1.png
rename to StyleTextRec/doc/images/1.png
diff --git a/doc/imgs_style_text/2.png b/StyleTextRec/doc/images/2.png
similarity index 100%
rename from doc/imgs_style_text/2.png
rename to StyleTextRec/doc/images/2.png
diff --git a/doc/imgs_style_text/3.png b/StyleTextRec/doc/images/3.png
similarity index 100%
rename from doc/imgs_style_text/3.png
rename to StyleTextRec/doc/images/3.png
diff --git a/doc/imgs_style_text/4.jpg b/StyleTextRec/doc/images/4.jpg
similarity index 100%
rename from doc/imgs_style_text/4.jpg
rename to StyleTextRec/doc/images/4.jpg
diff --git a/doc/imgs_style_text/5.png b/StyleTextRec/doc/images/5.png
similarity index 100%
rename from doc/imgs_style_text/5.png
rename to StyleTextRec/doc/images/5.png
diff --git a/StyleTextRec/doc/images/6.png b/StyleTextRec/doc/images/6.png
new file mode 100644
index 00000000..75af7275
Binary files /dev/null and b/StyleTextRec/doc/images/6.png differ
diff --git a/style_text_rec/engine/__init__.py b/StyleTextRec/engine/__init__.py
similarity index 100%
rename from style_text_rec/engine/__init__.py
rename to StyleTextRec/engine/__init__.py
diff --git a/style_text_rec/engine/corpus_generators.py b/StyleTextRec/engine/corpus_generators.py
similarity index 100%
rename from style_text_rec/engine/corpus_generators.py
rename to StyleTextRec/engine/corpus_generators.py
diff --git a/style_text_rec/engine/predictors.py b/StyleTextRec/engine/predictors.py
similarity index 100%
rename from style_text_rec/engine/predictors.py
rename to StyleTextRec/engine/predictors.py
diff --git a/style_text_rec/engine/style_samplers.py b/StyleTextRec/engine/style_samplers.py
similarity index 100%
rename from style_text_rec/engine/style_samplers.py
rename to StyleTextRec/engine/style_samplers.py
diff --git a/style_text_rec/engine/synthesisers.py b/StyleTextRec/engine/synthesisers.py
similarity index 100%
rename from style_text_rec/engine/synthesisers.py
rename to StyleTextRec/engine/synthesisers.py
diff --git a/style_text_rec/engine/text_drawers.py b/StyleTextRec/engine/text_drawers.py
similarity index 100%
rename from style_text_rec/engine/text_drawers.py
rename to StyleTextRec/engine/text_drawers.py
diff --git a/style_text_rec/engine/writers.py b/StyleTextRec/engine/writers.py
similarity index 100%
rename from style_text_rec/engine/writers.py
rename to StyleTextRec/engine/writers.py
diff --git a/style_text_rec/examples/corpus/example.txt b/StyleTextRec/examples/corpus/example.txt
similarity index 100%
rename from style_text_rec/examples/corpus/example.txt
rename to StyleTextRec/examples/corpus/example.txt
diff --git a/style_text_rec/examples/image_list.txt b/StyleTextRec/examples/image_list.txt
similarity index 100%
rename from style_text_rec/examples/image_list.txt
rename to StyleTextRec/examples/image_list.txt
diff --git a/style_text_rec/examples/style_images/1.jpg b/StyleTextRec/examples/style_images/1.jpg
similarity index 100%
rename from style_text_rec/examples/style_images/1.jpg
rename to StyleTextRec/examples/style_images/1.jpg
diff --git a/style_text_rec/examples/style_images/2.jpg b/StyleTextRec/examples/style_images/2.jpg
similarity index 100%
rename from style_text_rec/examples/style_images/2.jpg
rename to StyleTextRec/examples/style_images/2.jpg
diff --git a/style_text_rec/fonts/ch_standard.ttf b/StyleTextRec/fonts/ch_standard.ttf
similarity index 100%
rename from style_text_rec/fonts/ch_standard.ttf
rename to StyleTextRec/fonts/ch_standard.ttf
diff --git a/style_text_rec/fonts/en_standard.ttf b/StyleTextRec/fonts/en_standard.ttf
similarity index 100%
rename from style_text_rec/fonts/en_standard.ttf
rename to StyleTextRec/fonts/en_standard.ttf
diff --git a/style_text_rec/fonts/ko_standard.ttf b/StyleTextRec/fonts/ko_standard.ttf
similarity index 100%
rename from style_text_rec/fonts/ko_standard.ttf
rename to StyleTextRec/fonts/ko_standard.ttf
diff --git a/style_text_rec/tools/__init__.py b/StyleTextRec/tools/__init__.py
similarity index 100%
rename from style_text_rec/tools/__init__.py
rename to StyleTextRec/tools/__init__.py
diff --git a/style_text_rec/tools/synth_dataset.py b/StyleTextRec/tools/synth_dataset.py
similarity index 100%
rename from style_text_rec/tools/synth_dataset.py
rename to StyleTextRec/tools/synth_dataset.py
diff --git a/style_text_rec/tools/synth_image.py b/StyleTextRec/tools/synth_image.py
similarity index 100%
rename from style_text_rec/tools/synth_image.py
rename to StyleTextRec/tools/synth_image.py
diff --git a/style_text_rec/utils/__init__.py b/StyleTextRec/utils/__init__.py
similarity index 100%
rename from style_text_rec/utils/__init__.py
rename to StyleTextRec/utils/__init__.py
diff --git a/style_text_rec/utils/config.py b/StyleTextRec/utils/config.py
similarity index 100%
rename from style_text_rec/utils/config.py
rename to StyleTextRec/utils/config.py
diff --git a/style_text_rec/utils/load_params.py b/StyleTextRec/utils/load_params.py
similarity index 100%
rename from style_text_rec/utils/load_params.py
rename to StyleTextRec/utils/load_params.py
diff --git a/style_text_rec/utils/logging.py b/StyleTextRec/utils/logging.py
similarity index 100%
rename from style_text_rec/utils/logging.py
rename to StyleTextRec/utils/logging.py
diff --git a/style_text_rec/utils/math_functions.py b/StyleTextRec/utils/math_functions.py
similarity index 100%
rename from style_text_rec/utils/math_functions.py
rename to StyleTextRec/utils/math_functions.py
diff --git a/style_text_rec/utils/sys_funcs.py b/StyleTextRec/utils/sys_funcs.py
similarity index 100%
rename from style_text_rec/utils/sys_funcs.py
rename to StyleTextRec/utils/sys_funcs.py