S3Gaussian 项目使用教程
1. 项目的目录结构及介绍
S3Gaussian 项目的目录结构如下:
S3Gaussian/
├── arguments/
├── assets/
├── data/
├── docs/
├── gaussian_renderer/
├── lpipsPyTorch/
├── scenes/
├── scripts/
├── submodules/
├── utils/
├── .DS_Store
├── LICENSE.md
├── README.md
├── convert.py
├── environment.yml
├── full_eval.py
├── metrics.py
├── preprocess_main.py
├── requirements.txt
├── train.py
├── waymo_preprocess.py
└── zip_file.sh
目录介绍:
- arguments/: 包含项目的参数配置文件。
- assets/: 存放项目所需的静态资源文件。
- data/: 存放项目的数据集文件。
- docs/: 存放项目的文档文件。
- gaussian_renderer/: 包含高斯渲染器的相关代码。
- lpipsPyTorch/: 包含 LPIPS 评估指标的实现代码。
- scenes/: 存放场景数据文件。
- scripts/: 包含项目的脚本文件。
- submodules/: 包含项目的子模块代码。
- utils/: 包含项目的工具函数和辅助代码。
- .DS_Store: macOS 系统文件,忽略即可。
- LICENSE.md: 项目的开源许可证文件。
- README.md: 项目的介绍和使用说明文件。
- convert.py: 数据转换脚本。
- environment.yml: 项目的 Conda 环境配置文件。
- full_eval.py: 全量评估脚本。
- metrics.py: 评估指标的实现代码。
- preprocess_main.py: 数据预处理主脚本。
- requirements.txt: 项目的依赖包列表。
- train.py: 项目的训练主脚本。
- waymo_preprocess.py: Waymo 数据集的预处理脚本。
- zip_file.sh: 压缩文件的脚本。
2. 项目的启动文件介绍
项目的启动文件是 train.py
,该文件负责启动训练过程。以下是 train.py
的基本使用方法:
python train.py -s $data_dir --port 6017 --expname "waymo" --model_path $model_path
参数说明:
-s $data_dir
: 指定数据集的路径。--port 6017
: 指定训练时使用的端口号。--expname "waymo"
: 指定实验名称。--model_path $model_path
: 指定模型保存的路径。
3. 项目的配置文件介绍
项目的配置文件主要包括 environment.yml
和 requirements.txt
。
environment.yml
该文件用于配置 Conda 环境,包含项目所需的 Python 版本和依赖包。可以通过以下命令创建和激活环境:
conda env create -f environment.yml
conda activate S3Gaussian
requirements.txt
该文件列出了项目所需的 Python 依赖包,可以通过以下命令安装:
pip install -r requirements.txt
其他配置文件
- arguments/: 包含项目的参数配置文件,如
nvs.py
和stage2.py
,用于指定不同的训练阶段和配置。
通过以上配置文件和启动文件,可以顺利地启动和配置 S3Gaussian 项目。