Marian 项目安装与使用教程

1. 项目目录结构及介绍

Marian 是一个高效的神经机器翻译框架，使用纯 C++ 编写，具有最小的依赖性。以下是项目的目录结构及其介绍：

marian/
├── cmake/
├── contrib/
├── doc/
├── examples/
├── regression-tests/
├── scripts/
├── src/
├── vs/
├── .clang-format
├── .gitattributes
├── .gitignore
├── .gitmodules
├── CHANGELOG.md
├── CMakeLists.txt
├── CMakeSettings.json
├── CONTRIBUTING.md
├── Doxyfile.in
├── LICENSE.md
├── README.md
├── VERSION
├── azure-pipelines.yml
├── azure-regression-tests.yml

• cmake/: 包含 CMake 构建系统的相关文件。
• contrib/: 包含项目的贡献者文件。
• doc/: 包含项目的文档文件。
• examples/: 包含项目的示例代码。
• regression-tests/: 包含回归测试的相关文件。
• scripts/: 包含项目的脚本文件。
• src/: 包含项目的源代码。
• vs/: 包含 Visual Studio 的相关文件。
• .clang-format: 代码格式化配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置文件。
• CHANGELOG.md: 项目变更日志。
• CMakeLists.txt: CMake 构建脚本。
• CMakeSettings.json: CMake 设置文件。
• CONTRIBUTING.md: 贡献指南。
• Doxyfile.in: Doxygen 配置文件。
• LICENSE.md: 项目许可证。
• README.md: 项目自述文件。
• VERSION: 项目版本文件。
• azure-pipelines.yml: Azure Pipelines 配置文件。
• azure-regression-tests.yml: Azure 回归测试配置文件。

2. 项目启动文件介绍

Marian 项目的启动文件主要是 CMakeLists.txt，它定义了项目的构建过程。以下是启动文件的简要介绍：

# CMakeLists.txt
cmake_minimum_required(VERSION 3.5)
project(marian)

# 添加源文件
add_subdirectory(src)

# 添加测试
add_subdirectory(regression-tests)

# 添加示例
add_subdirectory(examples)

# 其他配置
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

• cmake_minimum_required(VERSION 3.5): 指定所需的最低 CMake 版本。
• project(marian): 定义项目名称。
• add_subdirectory(src): 添加源代码目录。
• add_subdirectory(regression-tests): 添加回归测试目录。
• add_subdirectory(examples): 添加示例代码目录。
• set(CMAKE_CXX_STANDARD 11): 设置 C++ 标准为 C++11。

3. 项目配置文件介绍

Marian 项目的配置文件主要包括 CMakeLists.txt 和 CMakeSettings.json。以下是配置文件的简要介绍：

CMakeLists.txt

CMakeLists.txt 是 CMake 构建系统的主要配置文件，定义了项目的构建过程和依赖关系。

CMakeSettings.json

CMakeSettings.json 是 Visual Studio 的 CMake 设置文件，用于配置 Visual Studio 中的 CMake 项目。

{
  "configurations": [
    {
      "name": "x64-Debug",
      "generator": "Visual Studio 16 2019",
      "configurationType": "Debug",
      "buildRoot": "${projectDir}\\out\\build\\${name}",
      "installRoot": "${projectDir}\\out\\install\\${name}",
      "cmakeCommandArgs": "",
      "buildCommandArgs": "",
      "ctestCommandArgs": ""
    }
  ]
}

• name: 配置名称。
• generator: 使用的生成器。
• configurationType: 配置类型（Debug 或 Release）。
• buildRoot: 构建输出目录。
• installRoot: 安装输出目录。
• cmakeCommandArgs: CMake 命令参数。
• buildCommandArgs: 构建命令参数。
• ctestCommandArgs: CTest 命令参数。

通过以上配置文件，可以方便地进行项目的构建和调试。