GaussianSTORM 项目启动与配置教程

1. 项目目录结构及介绍

GaussianSTORM 项目是一个用于大规模室外场景时空重建的开源项目。以下是项目的目录结构及各部分的功能介绍：

GaussianSTORM/
├── assets/              # 存放项目所需的静态资源
├── data/                # 存放数据集相关文件
├── docs/                # 存放项目文档
├── preproc/             # 存放数据预处理相关脚本
├── storm/               # 核心代码目录，包含模型定义、训练、推理等
├── third_party/         # 存放第三方依赖库或代码
├── .gitignore           # 指定 Git 忽略的文件和目录
├── LICENSE              # 项目许可证文件
├── README.md            # 项目说明文件
├── engine_storm.py      # 项目执行引擎
├── extract_sky.py       # 提取天空的脚本
├── inference.py         # 推理脚本
├── main_storm.py        # 主执行脚本，用于训练和评估
├── preprocess.py        # 数据预处理脚本
├── requirements.txt     # Python 依赖列表
└── requirements_data_preprocess.txt  # 数据预处理所需的 Python 依赖列表

2. 项目的启动文件介绍

项目的主启动文件是 main_storm.py。该文件负责处理命令行参数，并启动训练或评估流程。以下是一个基本的启动命令示例：

torchrun --nproc_per_node=8 main_storm.py \
--project <project_name> \
--exp_name <experiment_name> \
--data_root <path_to_dataset> \
--batch_size <per_gpu_batch_size> \
--num_iterations <number_of_iterations> \
--model <model_name> \
--num_motion_tokens <number_of_motion_tokens> \
...

其中 <project_name>、<experiment_name>、<path_to_dataset>、<per_gpu_batch_size>、<number_of_iterations>、<model_name>、<number_of_motion_tokens> 等参数需要根据具体项目配置进行替换。

3. 项目的配置文件介绍

项目的配置主要通过命令行参数进行，但也可以通过配置文件来简化参数设置。配置文件通常是 JSON 或 YAML 格式，可以在 main_storm.py 中加载并解析。

以下是一个示例的配置文件内容（假设为 config.yaml）：

project: my_project
exp_name: my_experiment
data_root: /path/to/dataset
batch_size: 4
num_iterations: 100000
model: STORM-B/8
num_motion_tokens: 16
use_sky_token: true
use_affine_token: true
load_depth: true
load_flow: true
load_ground: true
...

在 main_storm.py 中，可以通过以下方式加载这个配置文件：

import yaml

def load_config(config_path):
    with open(config_path, 'r') as file:
        config = yaml.safe_load(file)
    return config

config = load_config('config.yaml')

然后，可以使用 config 对象中的参数来替代命令行参数，从而简化启动流程。