虚拟家庭模拟器（VirtualHome）使用教程

虚拟家庭模拟器（VirtualHome）使用教程

virtualhome API to run VirtualHome, a Multi-Agent Household Simulator 项目地址: https://gitcode.com/gh_mirrors/vi/virtualhome

1. 项目目录结构及介绍

VirtualHome 是一个开源的多代理家庭模拟器，其目录结构如下：

virtualhome/
├── assets/                 # 存储项目所需的资源文件
├── docker/                 # Docker 配置文件和脚本
├── simulation/             # 包含模拟器和相关模块
│   ├── evolving_graph/     # Evolving Graph 模拟器相关文件
│   ├── unity_simulator/    # Unity 模拟器相关文件
│   └── environment/        # Reinforcement Learning 环境相关文件
├── demo/                   # 包含演示脚本和Jupyter笔记本
├── helper_scripts/         # 辅助脚本，如启动X服务器的脚本
├── .gitignore              # 指定Git忽略的文件和目录
├── LICENSE                 # 项目许可证文件
├── README.md               # 项目说明文件
├── pyproject.toml          # Python 项目配置文件
└── setup.py                # Python 包设置文件

• assets/ 目录包含了项目所需的资源文件，如场景、模型和材质等。
• docker/ 目录包含了用于Docker化的配置文件和脚本。
• simulation/ 目录是模拟器的核心部分，包含了Evolving Graph和Unity Simulator两种模拟器。
• demo/ 目录包含了用于展示项目功能的脚本和Jupyter笔记本。
• helper_scripts/ 目录包含了辅助脚本，用于简化一些配置任务。

2. 项目的启动文件介绍

VirtualHome 的启动文件主要位于 demo/ 目录下，以下是几个关键的启动文件：

• generate_video.py：用于生成家庭活动视频的脚本。
• generate_snapshots.py：用于生成场景快照的脚本。
• test_unity_environment.py：用于测试Unity环境基础的Reinforcement Learning环境的脚本。
• test_unity_environment_mp.py：用于测试多进程下Unity环境基础的Reinforcement Learning环境的脚本。

这些脚本可以通过Python直接运行，例如运行 generate_video.py 生成视频：

cd demo/
python generate_video.py

3. 项目的配置文件介绍

VirtualHome 的配置文件包括：

• .gitignore：指定Git在提交时应该忽略的文件和目录。
• pyproject.toml：Python项目配置文件，用于定义项目依赖等。
• setup.py：Python包设置文件，用于打包和分发Python包。

这些配置文件在项目初始化和开发过程中起到关键作用，确保项目的依赖和构建流程的正确性。

在开始使用VirtualHome之前，确保已经安装了所有必要的依赖，并且正确配置了环境。具体的安装和配置步骤可以参考项目提供的官方文档。

virtualhome API to run VirtualHome, a Multi-Agent Household Simulator 项目地址: https://gitcode.com/gh_mirrors/vi/virtualhome