Control-VAE 项目使用教程

1. 项目目录结构及介绍

Control-VAE 项目的目录结构如下：

Control-VAE/
├── ControlVAECore/
├── Data/
├── Figure/
├── ModifyODESrc/
├── PlayGround/
├── ThirdParty/
├── .gitignore
├── LICENSE
├── README.md
├── VclSimuBackend-raw.py
├── odecharacter_scene.pickle
├── requirements.yml
├── setup.py
├── train_controlvae.py

目录介绍

• ControlVAECore/: 包含 ControlVAE 的核心代码和实现。
• Data/: 存放项目所需的数据文件，包括预训练模型和配置文件。
• Figure/: 存放项目生成的图表和可视化结果。
• ModifyODESrc/: 包含对 ODE（Open Dynamics Engine）的修改和扩展代码。
• PlayGround/: 包含项目的演示和交互代码，如随机采样和操纵杆控制。
• ThirdParty/: 存放项目依赖的第三方库和工具。
• .gitignore: Git 忽略文件，指定哪些文件和目录不需要被版本控制。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• VclSimuBackend-raw.py: 模拟后端的核心代码。
• odecharacter_scene.pickle: 保存的场景数据文件。
• requirements.yml: 项目的依赖环境配置文件。
• setup.py: 项目的安装脚本。
• train_controlvae.py: 项目的训练脚本。

2. 项目启动文件介绍

train_controlvae.py

这是项目的训练脚本，用于训练 ControlVAE 模型。使用 MPI（Message Passing Interface）进行并行训练，主进程负责训练网络，其他进程负责收集模拟数据。

使用方法:

mpiexec -n 5 python train_controlvae.py --YOUR_ARGS

--YOUR_ARGS 是可选的参数，可以根据需要进行配置。

PlayGround/ 目录下的启动文件

• random_playground.py: 用于随机采样的演示脚本。
• joystick_playground.py: 用于操纵杆控制的演示脚本。

使用方法:

python PlayGround/random_playground.py
python PlayGround/joystick_playground.py

这些脚本会要求选择配置文件和训练好的模型参数文件。

3. 项目的配置文件介绍

requirements.yml

这是项目的依赖环境配置文件，使用 Conda 进行环境管理。可以通过以下命令创建和激活环境：

conda env create -f requirements.yml
conda activate control-vae

Data/ 目录下的配置文件

在 Data/ 目录下，通常会存放预训练模型和配置文件。例如：

• config.yml: 项目的配置文件，包含训练和演示的参数设置。
• controlvae.data: 训练好的模型参数文件。

使用方法:

在运行演示脚本时，需要指定这些配置文件和模型参数文件的路径。例如：

python PlayGround/random_playground.py --config Data/config.yml --model Data/controlvae.data

通过以上步骤，您可以顺利地启动和配置 Control-VAE 项目，并进行训练和演示。