CityGaussian 项目使用教程

1. 项目的目录结构及介绍

CityGaussian 项目是一个用于高质量大规模场景重建的开源项目。以下是项目的目录结构及其简单介绍：

CityGaussian/
├── .github/              # GitHub 工作流程和配置文件
├── assets/               # 资源文件，如图片等
├── blender/              # 与 Blender 相关的文件
├── configs/              # 配置文件
├── doc/                  # 文档资料
├── internal/             # 内部实现代码
├── notebooks/            # Jupyter 笔记本
├── requirements/         # 项目依赖
├── scripts/              # 脚本文件
├── submodules/           # 子模块
├── tests/                # 测试代码
├── tools/                # 实用工具代码
├── utils/                # 公共辅助函数代码
├── .gitignore            # Git 忽略文件
├── .gitmodules           # Git 子模块配置文件
├── LICENSE.md            # 项目许可证信息
├── README.md             # 项目说明文件
├── dataset.py            # 数据集处理文件
├── main.py               # 主执行文件
├── pyproject.toml        # 项目配置文件
├── render.py             # 渲染处理文件
├── requirements.txt      # 项目依赖列表
├── seganygs.py           # 数据处理脚本
└── viewer.py             # 查看器相关代码

2. 项目的启动文件介绍

main.py 是项目的主要启动文件。它负责初始化程序，加载配置，并且开始整个重建和渲染流程。以下是一个简化的 main.py 文件的结构：

# 导入必要的库
import configurations
from trainer import Trainer

# 配置参数
config = configurations.load_config('path/to/config/file')

# 创建训练器对象
trainer = Trainer(config)

# 开始训练或测试过程
trainer.run()

在实际的项目中，main.py 会包含更详细的初始化和流程控制代码。

3. 项目的配置文件介绍

配置文件通常位于 configs/ 目录下，它们包含了项目运行时的参数设置。配置文件通常采用 .yaml 或 .json 格式，本项目使用 .yaml 格式。以下是一个配置文件示例：

# 配置文件示例
model:
  name: CityGaussian
  parameters:
    max_cache_num: 1024
    prune_ratio: 0.5
data:
  dataset_path: 'path/to/dataset'
  batch_size: 32
train:
  epochs: 50
  learning_rate: 0.001

这个配置文件定义了模型名称和参数，数据集路径和批处理大小，以及训练过程中的周期数和学习率等。

使用配置文件可以使项目更加灵活和可配置，便于在不同环境或需求下调整项目行为。在项目启动时，会加载这些配置文件，并根据其中的参数进行相应的操作。