WorldScore 项目启动与配置教程

1. 项目目录结构及介绍

WorldScore 项目目录结构如下：

WorldScore/
├── assets/
├── config/
│   ├── model_configs/
│   └── utils/
├── notebooks/
├── requirements/
├── thirdparty/
│   ├── DROID-SLAM/
│   ├── Grounded-Segment-Anything/
│   └── sam2/
├── world_generators/
│   ├──_configs/
│   └── generate_videos.py
├── worldscore/
│   ├── analysis/
│   ├── benchmark/
│   │   ├── datasets/
│   │   ├── evaluation/
│   │   ├── utils/
│   │   └── visuals/
│   └── metrics/
├── .gitignore
├── .gitmodules
├── LICENSE
├── MANIFEST.in
├── README.md
├── download.py
├── pylintrc
├── ruff.toml
├── setup.py
└── ...

各目录及文件功能说明：

• assets/: 存储项目所需的资源文件。
• config/: 包含模型配置文件及工具类。
• notebooks/: Jupyter 笔记本文件，用于数据分析与可视化。
• requirements/: 存储项目依赖的 Python 包列表。
• thirdparty/: 存储第三方库的源代码。
• world_generators/: 包含用于生成视频的模型类和配置文件。
• worldscore/: 包含项目的核心代码，如分析工具、评估方法、指标计算等。
• .gitignore: 指定 Git 忽略的文件和目录。
• .gitmodules: 定义 Git 子模块。
• LICENSE: 项目的开源许可证文件。
• MANIFEST.in: 指定打包时包含的文件。
• README.md: 项目的说明文件。
• download.py: 用于下载项目所需数据的脚本。
• pylintrc: Python 代码风格配置文件。
• ruff.toml: 另一个 Python 代码风格配置文件。
• setup.py: 用于构建和打包 Python 包的脚本。

2. 项目的启动文件介绍

项目的启动主要是通过 world_generators/generate_videos.py 脚本实现的。该脚本负责调用配置好的模型类生成视频。

启动命令如下：

python world_generators/generate_videos.py --model-name <model_name>

其中 <model_name> 是用户自定义的模型名称。

3. 项目的配置文件介绍

项目的配置文件主要包括以下两部分：

模型配置文件

模型配置文件位于 config/model_configs/ 目录下，每个模型都有一个对应的 YAML 文件，例如 model_name.yaml。该文件包含了模型的初始化参数和生成视频所需的配置。

一个典型的模型配置文件如下：

_target_: world_generators.<model_name>.<model_name>
model_name: <model_name>
generation_type: i2v
frames: <frames>
fps: <fps>
# 其他模型特定的参数

环境配置文件

环境配置文件为 .env 文件，位于项目根目录。该文件定义了项目运行所需的环境变量，如项目路径、模型路径和数据集路径等。

一个典型的环境配置文件如下：

WORLDSCORE_PATH=/path/to/worldscore
MODEL_PATH=/path/to/model
DATA_PATH=/path/to/dataset

在运行项目之前，需要创建 .env 文件，并正确设置环境变量。然后，在新的终端会话中导出这些变量：

export $(grep -v '^#' .env | xargs)

以上是 WorldScore 项目的启动和配置文档。按照以上步骤操作，您可以顺利地启动并运行该项目。