LMM-R1 项目使用与启动教程

LMM-R1 项目使用与启动教程

lmm-r1 Extend OpenRLHF to support LMM RL training for reproduction of DeepSeek-R1 on multimodal tasks. 项目地址: https://gitcode.com/gh_mirrors/lm/lmm-r1

1. 项目目录结构及介绍

LMM-R1 项目目录结构如下：

lmm-r1/
├── .github/
│   └── workflows/
├── dockerfile
├── docs/
├── examples/
│   └── data/
│       └── test_message.jsonl
├── openrlhf/
├── .gitignore
├── .pre-commit-config.yaml
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── README_zh.md
├── pyproject.toml
├── requirements.txt
├── setup.py
├── version.txt

• .github/workflows/：存放 GitHub Actions 的配置文件，用于自动化构建、测试等流程。
• dockerfile：Dockerfile 文件，用于构建项目镜像。
• docs/：存放项目文档。
• examples/：示例数据和脚本。
  • data/：包含示例数据文件。
• openrlhf/：项目核心代码。
• .gitignore：Git 忽略文件列表。
• .pre-commit-config.yaml：pre-commit 配置文件，用于代码格式化等。
• CONTRIBUTING.md：贡献指南。
• LICENSE：项目许可证文件。
• README.md：项目介绍（英文版）。
• README_zh.md：项目介绍（中文版）。
• pyproject.toml：项目配置文件。
• requirements.txt：项目依赖。
• setup.py：Python 包设置文件。
• version.txt：项目版本文件。

2. 项目的启动文件介绍

项目的启动主要是通过 examples/scripts/ 目录下的脚本文件进行。以下是一些主要的启动脚本：

• train_fre_text.sh：使用文本数据训练模型的推理能力（FRE-Text 阶段）。
• train_fre_multi.sh：使用多模态数据训练模型的推理能力（FRE-Multi 阶段）。
• train_mgt_geo.sh：在几何领域训练模型以增强几何推理能力（MGT-Geo 阶段）。
• train_mgt_percereas.sh：在感知与推理平衡的领域训练模型（MGT-PerceReason 阶段）。

根据具体需求选择相应的脚本，使用 bash 命令执行即可。

3. 项目的配置文件介绍

项目的配置文件主要集中在 pyproject.toml 和 requirements.txt。

• pyproject.toml：此文件定义了项目的元数据，包括项目名称、版本、作者、依赖等。以下是一个简化的示例：

[build-system]
requires = ["setuptools", "wheel"]

[tool.setuptools]
packages = ["lmm_r1"]

[project]
name = "lmm-r1"
version = "0.6.2a"
description = "Empowering 3B LMMs with Strong Reasoning Abilities"
authors = ["Peng, Yingzhe", "Zhang, Gongrui", "Zhang, Miaosen", "You, Zhiyuan", "Liu, Jie", "Zhu, Qipeng", "Yang, Kai", "Xu, Xingzhong", "Geng, Xin", "Yang, Xu"]

• requirements.txt：此文件列出了项目运行所需的 Python 包依赖。例如：

torch
tqdm
numpy
transformers

确保在开始项目之前安装所有列出的依赖项。

lmm-r1 Extend OpenRLHF to support LMM RL training for reproduction of DeepSeek-R1 on multimodal tasks. 项目地址: https://gitcode.com/gh_mirrors/lm/lmm-r1