PEDRA 项目使用教程

PEDRA 项目使用教程

PEDRA Programmable Engine for Drone Reinforcement Learning Applications 项目地址: https://gitcode.com/gh_mirrors/pe/PEDRA

1. 项目的目录结构及介绍

PEDRA 项目的目录结构如下：

PEDRA/
├── algorithms/
├── configs/
├── docs/
├── images/
├── network/
├── unreal_envs/
├── util/
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── README_old.md
├── _config.yml
├── aux_functions.py
├── faq.md
├── main.py
├── requirements_cpu.txt
├── requirements_gpu.txt
└── retrieve_initial_position.py

目录介绍

• algorithms/: 存放与强化学习算法相关的代码文件。
• configs/: 存放项目的配置文件。
• docs/: 存放项目的文档文件。
• images/: 存放项目的图片资源。
• network/: 存放与神经网络相关的代码文件。
• unreal_envs/: 存放与 Unreal 引擎环境相关的文件。
• util/: 存放项目的工具函数和辅助代码。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的主 README 文件。
• README_old.md: 旧版本的 README 文件。
• _config.yml: 项目的配置文件。
• aux_functions.py: 辅助函数文件。
• faq.md: 项目的常见问题解答文件。
• main.py: 项目的启动文件。
• requirements_cpu.txt: CPU 版本的依赖包列表。
• requirements_gpu.txt: GPU 版本的依赖包列表。
• retrieve_initial_position.py: 用于获取初始位置的脚本。

2. 项目的启动文件介绍

项目的启动文件是 main.py。该文件是 PEDRA 项目的入口点，负责初始化环境、加载配置文件、启动强化学习训练等核心功能。

main.py 主要功能

• 初始化环境: 根据配置文件中的环境类型和名称，初始化相应的 Unreal 引擎环境。
• 加载配置文件: 从 configs/ 目录中加载配置文件，配置文件中包含了训练参数、算法参数等。
• 启动训练: 根据配置文件中的算法类型，启动相应的强化学习训练过程。
• 日志记录: 记录训练过程中的关键参数和状态，生成日志文件以便后续分析。

3. 项目的配置文件介绍

项目的配置文件主要存放在 configs/ 目录下，其中最重要的配置文件是 config.cfg。

config.cfg 配置文件介绍

config.cfg 文件包含了项目的全局配置参数和算法特定的配置参数。以下是一些关键配置项的介绍：

[general_params]
run_name = "simulation_1"  # 当前模拟的名称
env_type = "indoor"        # 环境类型（室内/室外）
env_name = "indoor_cloud"  # 具体的环境名称
ip_address = "127.0.0.1"   # 用于与环境通信的 IP 地址
algorithm = "DDQN"         # 使用的算法类型

[algorithm_params]
learning_rate = 0.001      # 学习率
discount_factor = 0.99     # 折扣因子
epsilon = 1.0              # 探索率
epsilon_decay = 0.995      # 探索率衰减因子

配置文件结构

• [general_params]: 包含项目的全局配置参数，如模拟名称、环境类型、环境名称、IP 地址和算法类型。
• [algorithm_params]: 包含算法特定的配置参数，如学习率、折扣因子、探索率等。

通过修改 config.cfg 文件中的参数，用户可以自定义模拟环境和训练过程的各项参数。

PEDRA Programmable Engine for Drone Reinforcement Learning Applications 项目地址: https://gitcode.com/gh_mirrors/pe/PEDRA