EPyMARL 安装与使用教程
epymarl项目地址:https://gitcode.com/gh_mirrors/ep/epymarl
1. 项目目录结构及介绍
EPyMARL 是一个基于 Python 的多智能体深度强化学习框架,它扩展了 PyMARL,提供了更多的灵活性和算法选择。以下是 EPYMARL 项目的基本目录结构:
.
├── docker # Docker 相关配置文件
├── src # 主要代码源文件
│ ├── docker_src # Docker 中使用的源文件
│ ├── envs # 环境定义
│ ├── learners # 学习器代码
│ ├── mac # 多智能体控制器(MAC)
│ ├── models # 模型定义
│ ├── plots # 绘图工具
│ ├── preprocessors # 预处理器
│ └── utils # 辅助工具
├── .gitignore # Git 忽略文件列表
├── LICENSE # 许可证文件
├── NOTICE # 注意事项
└── README.md # 项目说明文档
这些目录中,envs
包含环境模拟器,learners
保存各种学习算法,mac
实现多智能体控制器,models
定义模型结构,plots
用于结果可视化,preprocessors
包含数据预处理函数,而 utils
则是一些通用辅助工具。
2. 项目启动文件介绍
EPyMARL 的主要运行脚本位于 src/run.sh
。这个脚本执行以下操作:
- 设置环境变量。
- 根据配置文件运行指定的算法和环境。
- 调用其他功能脚本,如安装依赖 (
install_sc2.sh
) 和加载所需环境 (run_interactive.sh
,runalgo.sh
等)。
你可以通过编辑 src/run.sh
或创建自定义脚本来指定你想要运行的具体算法和配置。
3. 项目的配置文件介绍
EPYMARL 的配置文件通常是 YAML 格式的,位于 src/configs
文件夹下。这些配置文件用于设置算法参数、环境参数以及运行时的其他选项。一个例子是 src/configs/example_config.yaml
,里面可能包含如下内容:
alg_name: ia2c # 设定要运行的算法名称
env_name: simple # 设定要运行的环境名称
n_agents: 3 # 环境中的智能体数量
n_steps: 1000000 # 训练步数
num_envs: 1 # 并行运行的环境副本数
save_model_freq: 50000 # 模型保存频率
Learner:
learner_name: ia2c # 学习器的配置
...
Environment:
env_name: simple # 环境的配置
...
当你运行 EPYMARL 时,可以通过 -c
参数指定配置文件,比如 bash src/run.sh -c configs/example_config.yaml
。
请确保先阅读官方仓库的 README.md
获取更详细的信息,并根据自己的需求调整相关配置以适应不同场景。祝你在使用 EPyMARL 进行多智能体强化学习研究时一切顺利!