MLGym 项目使用教程

MLGym 项目使用教程

MLGym MLGym A New Framework and Benchmark for Advancing AI Research Agents 项目地址: https://gitcode.com/gh_mirrors/ml/MLGym

1. 项目目录结构及介绍

MLGym 项目是一个用于机器学习任务的开源环境框架，其目录结构如下：

• assets/: 存储项目所需的静态资源文件。
• configs/: 包含配置文件，如任务配置和代理配置。
• data/: 存储项目所需的数据文件。
• demo/: 包含用于演示项目的示例脚本。
• demonstrations/: 存储代理的示范轨迹。
• docker/: 包含用于 Docker 容器的配置和脚本。
• docs/: 存储项目的文档文件。
• mlgym/: 核心代码库，包含 MLGym 的实现。
• results/: 存储实验结果。
• scripts/: 包含运行实验的脚本文件。
• tests/: 包含项目的单元测试。
• tools/: 包含项目所需的工具脚本。
• trajectories/: 存储任务轨迹文件。
• .gitignore: 指定 Git 忽略的文件。
• CHANGELOG.md: 记录项目的更新和修改历史。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 指导如何为项目贡献。
• LICENSE: 项目的开源协议。
• MAINTENANCE.md: 项目的维护计划。
• README.md: 项目的主描述文件。
• pyproject.toml: 项目的基本配置文件。
• requirements.txt: 项目依赖的 Python 包。
• run.py: 项目的启动文件。
• run_replay.py: 用于重放代理轨迹的脚本。

2. 项目的启动文件介绍

项目的启动文件是 run.py，` 它是运行 MLGym 任务的主要入口点。通过该文件，用户可以指定任务配置、代理配置、模型以及其他运行参数。

以下是 run.py 的基本使用示例：

python run.py \
--container_type docker \
--task_config_path tasks/battleOfSexes.yaml \
--model litellm:claude-3-5-sonnet-20240620 \
--per_instance_cost_limit 4.00 \
--agent_config_path configs/agents/default.yaml \
--temp 1 \
--gpus 0 \
--max_steps 50 \
--aliases_file ./docker/aliases.sh

用户可以通过 --help 参数查看所有可用的命令行参数。

3. 项目的配置文件介绍

项目的配置文件分为任务配置文件和代理配置文件。

• 任务配置文件：位于 tasks/ 目录下，这些 YAML 文件定义了不同任务的具体配置，例如 battleOfSexes.yaml。

• 代理配置文件：位于 configs/agents/ 目录下，这些 YAML 文件定义了代理的行为和超参数，例如 default.yaml。

配置文件允许用户自定义任务的参数和代理的行为，以适应不同的实验需求和场景。通过修改这些配置文件，用户可以轻松地调整实验设置，进行不同参数下的性能比较和算法测试。

MLGym MLGym A New Framework and Benchmark for Advancing AI Research Agents 项目地址: https://gitcode.com/gh_mirrors/ml/MLGym