NDLOCR CLI 项目使用文档

NDLOCR CLI 项目使用文档

ndlocr_cli NDLOCRアプリケーションのリポジトリ（ソースコードを含む） 项目地址: https://gitcode.com/gh_mirrors/nd/ndlocr_cli

1. 项目目录结构及介绍

NDLOCR CLI 项目的目录结构如下：

ndlocr_cli
├── main.py
├── cli
├── submodules
│   ├── separate_pages_mmdet
│   ├── deskew_HT
│   ├── ndl_layout
│   ├── text_recognition_lightning
│   ├── reading_order
│   ├── ruby_prediction
│   └── ocr_line_eval_script
├── config.yml
├── eval_config.yml
├── docker
├── README.md
├── requirements.txt
├── LICENSE
└── LICENSE_DEPENDENCIES

目录结构介绍

• main.py: 项目的主入口文件，用于执行 CLI 命令。
• cli: 包含 CLI 命令相关的 Python 代码。
• submodules: 包含各个推理和评估处理的源代码目录。
  • separate_pages_mmdet: 页面分割的源代码。
  • deskew_HT: 倾斜校正的源代码。
  • ndl_layout: 布局提取处理的源代码。
  • text_recognition_lightning: 文字识别和标题作者识别处理的源代码。
  • reading_order: 阅读顺序识别处理的源代码。
  • ruby_prediction: 注音推断处理的源代码。
  • ocr_line_eval_script: 推理结果评估处理的源代码。
• config.yml: 推理设置的示例配置文件。
• eval_config.yml: 评估设置的示例配置文件。
• docker: 包含 Docker 环境创建的脚本。
• README.md: 项目的说明文件。
• requirements.txt: Python 所需的包列表。
• LICENSE: 项目的许可证文件。
• LICENSE_DEPENDENCIES: 项目所使用的包的许可证文件。

2. 项目启动文件介绍

main.py

main.py 是 NDLOCR CLI 项目的主入口文件，用于执行 CLI 命令。通过该文件，用户可以启动推理处理、评估处理等操作。

主要功能

• 推理处理: 通过 main.py 可以执行推理处理，将输入的图像文件转换为文本数据。
• 评估处理: 通过 main.py 可以执行评估处理，评估推理结果的准确性。

使用示例

python main.py infer input_data_dir output_dir -s s

3. 项目配置文件介绍

config.yml

config.yml 是推理处理的配置文件，用户可以通过修改该文件来调整推理处理的参数。

主要配置项

• 推理模式: 设置推理的模式，如单张图片推理、批量图片推理等。
• 输出格式: 设置推理结果的输出格式，如文本、XML 等。
• 中间结果保存: 设置是否保存中间推理结果。

eval_config.yml

eval_config.yml 是评估处理的配置文件，用户可以通过修改该文件来调整评估处理的参数。

主要配置项

• 评估模式: 设置评估的模式，如单张图片评估、批量图片评估等。
• 评估指标: 设置评估的指标，如准确率、召回率等。
• 评估结果保存: 设置是否保存评估结果。

通过以上配置文件，用户可以根据实际需求灵活调整 NDLOCR CLI 项目的运行参数，以达到最佳的推理和评估效果。

ndlocr_cli NDLOCRアプリケーションのリポジトリ（ソースコードを含む） 项目地址: https://gitcode.com/gh_mirrors/nd/ndlocr_cli