compare-mt 项目教程

1. 项目目录结构及介绍

compare-mt 是一个用于语言生成系统（如机器翻译、摘要生成、对话响应生成等）的全面分析和比较工具。以下是项目的目录结构及其介绍：

compare-mt/
├── example/
│   ├── ted_ref_eng
│   ├── ted_sys1_eng
│   ├── ted_sys2_eng
│   └── ...
├── scripts/
│   ├── count.py
│   ├── relativepositiontag.py
│   └── ...
├── tests/
│   ├── test_compare_mt.py
│   └── ...
├── github/workflows/
│   ├── compare_mt.yml
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── pytest.ini
├── requirements.txt
├── setup.py
└── compare_mt.py

目录结构介绍

• example/: 包含示例数据文件，用于演示如何使用 compare-mt 进行系统比较。
• scripts/: 包含一些辅助脚本，如 count.py 用于计算词频，relativepositiontag.py 用于生成词的相对位置标签。
• tests/: 包含测试脚本，用于确保 compare-mt 的正确性。
• github/workflows/: 包含 GitHub Actions 的工作流配置文件，用于自动化测试和部署。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• pytest.ini: pytest 配置文件。
• requirements.txt: 项目依赖库列表。
• setup.py: 项目安装脚本。
• compare_mt.py: 项目的主启动文件。

2. 项目启动文件介绍

compare-mt 的启动文件是 compare_mt.py。该文件包含了主要的逻辑和功能，用于比较两个语言生成系统的输出。

启动文件功能

• 系统比较: 比较两个系统的输出，计算各种统计数据，如 BLEU 分数、词频分析、句子长度分析等。
• 生成报告: 生成详细的 HTML 报告，展示系统之间的差异。
• 支持多种分析: 支持词频分析、句子标签分析、源语言分析等多种分析方法。

启动命令示例

python compare_mt.py --output_directory output/ example/ted_ref_eng example/ted_sys1_eng example/ted_sys2_eng

3. 项目的配置文件介绍

compare-mt 的配置主要通过命令行参数进行，但也有一些配置文件用于辅助功能。

配置文件

• requirements.txt: 列出了项目依赖的所有 Python 库。
• pytest.ini: 配置 pytest 测试框架的参数。
• setup.py: 用于安装项目的脚本，包含项目的元数据和依赖项。

配置示例

在 requirements.txt 中，你可以看到项目依赖的库：

numpy
pandas
nltk
...

在 pytest.ini 中，你可以配置 pytest 的行为：

[pytest]
addopts = --cov=compare_mt --cov-report=html

在 setup.py 中，你可以看到项目的安装配置：

from setuptools import setup, find_packages

setup(
    name='compare-mt',
    version='0.1',
    packages=find_packages(),
    install_requires=[
        'numpy',
        'pandas',
        'nltk',
        ...
    ],
)

通过这些配置文件和启动文件，你可以轻松地安装和使用 compare-mt 项目，进行语言生成系统的全面比较和分析。