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命令。它负责调用各个子模块的功能，并根据配置文件进行推論处理。

主要功能

• 推論处理: 根据输入的图像文件和配置文件，执行推論处理，生成文本和XML文件。
• 部分実行: 支持部分推論处理，用户可以通过命令行选项指定执行的步骤。
• 中間出力: 支持中間出力，用户可以选择保存推論过程中的中間结果。

使用方法

python main.py infer input_data_dir output_dir -s s

3. 项目配置文件介绍

config.yml

config.yml 是NDLOCR CLI项目的推論处理配置文件。它包含了推論处理的各种参数设置，如是否启用读取顺序识别、注音推定等功能。

配置项

• line_order: 是否启用读取顺序识别。
• ruby_read: 是否启用注音推定。
• add_title_author: 是否启用标题和作者识别。

eval_config.yml

eval_config.yml 是NDLOCR CLI项目的評估处理配置文件。它包含了評估处理的各种参数设置，如評估的指标和評估的范围。

配置项

• eval_metrics: 評估的指标，如准确率、召回率等。
• eval_range: 評估的范围，如全量評估或部分評估。

通过这两个配置文件，用户可以根据自己的需求定制推論和評估处理的流程。

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