NeuRIS 项目使用教程

NeuRIS 项目使用教程

NeuRIS 项目地址: https://gitcode.com/gh_mirrors/ne/NeuRIS

1. 项目目录结构及介绍

NeuRIS 项目的目录结构如下：

NeuRIS/
├── confs/
│   └── ...
├── doc/
│   └── ...
├── evaluation/
│   └── ...
├── models/
│   └── ...
├── preprocess/
│   └── ...
├── utils/
│   └── ...
├── LICENSE
├── README.md
├── exp_evaluation.py
├── exp_preprocess.py
├── exp_runner.py
└── requirements.txt

目录介绍

• confs/: 包含项目的配置文件。
• doc/: 包含项目的文档文件。
• evaluation/: 包含用于评估模型的脚本和工具。
• models/: 包含项目的模型文件。
• preprocess/: 包含数据预处理的脚本和工具。
• utils/: 包含项目的实用工具和辅助函数。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• exp_evaluation.py: 用于模型评估的启动文件。
• exp_preprocess.py: 用于数据预处理的启动文件。
• exp_runner.py: 项目的核心启动文件。
• requirements.txt: 项目依赖的 Python 包列表。

2. 项目启动文件介绍

exp_runner.py

exp_runner.py 是 NeuRIS 项目的核心启动文件，用于执行各种任务，如模型训练、验证和测试。可以通过命令行参数指定不同的模式来执行不同的任务。

使用示例：

python exp_runner.py --mode train --conf <config_file>

exp_evaluation.py

exp_evaluation.py 用于评估模型的性能。可以通过命令行参数指定不同的评估模式。

使用示例：

python exp_evaluation.py --mode eval_3D_mesh_metrics

exp_preprocess.py

exp_preprocess.py 用于数据预处理，准备训练和测试所需的数据。

使用示例：

python exp_preprocess.py --mode preprocess_data

3. 项目的配置文件介绍

配置文件位于 confs/ 目录下，通常以 .conf 或 .yaml 格式存储。配置文件包含了项目的各种参数设置，如数据路径、模型参数、训练参数等。

配置文件示例：

# config_file.yaml
data_path: "dataset/indoor"
model_params:
  learning_rate: 0.001
  batch_size: 32
training_params:
  epochs: 100
  save_interval: 10

使用配置文件：

在启动文件中，可以通过 --conf 参数指定配置文件的路径。

python exp_runner.py --mode train --conf confs/config_file.yaml

通过以上步骤，您可以顺利地启动和配置 NeuRIS 项目，并根据需要进行模型训练、评估和数据预处理。

NeuRIS 项目地址: https://gitcode.com/gh_mirrors/ne/NeuRIS