SOLD² 项目教程

1. 项目目录结构及介绍

SOLD² 项目的目录结构如下：

SOLD2/
├── assets/
├── notebooks/
├── sold2/
│   ├── config/
│   ├── data/
│   ├── models/
│   ├── utils/
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

目录介绍：

• assets/: 存放项目相关的静态资源文件。
• notebooks/: 存放 Jupyter Notebook 文件，用于演示和实验。
• sold2/: 项目的主要代码目录，包含配置文件、数据处理、模型定义和工具函数等。
  • config/: 存放项目的配置文件。
  • data/: 存放数据处理相关的代码。
  • models/: 存放模型定义的代码。
  • utils/: 存放各种工具函数。
• .gitignore: Git 忽略文件，指定不需要版本控制的文件和目录。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍文档。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.py: 项目的安装脚本。

2. 项目的启动文件介绍

SOLD² 项目的启动文件主要是 setup.py 和 notebooks/ 目录下的 Jupyter Notebook 文件。

setup.py

setup.py 是 Python 项目的标准安装脚本，用于安装项目的依赖包和配置项目。你可以通过以下命令安装项目：

pip install -e .

Jupyter Notebook

notebooks/ 目录下包含多个 Jupyter Notebook 文件，用于演示和实验。你可以通过以下命令启动 Jupyter Notebook：

jupyter notebook

然后在浏览器中打开 notebooks/ 目录下的 Notebook 文件进行实验。

3. 项目的配置文件介绍

SOLD² 项目的配置文件主要存放在 sold2/config/ 目录下。以下是一些重要的配置文件：

project_config.py

project_config.py 是项目的全局配置文件，包含数据集路径、实验路径等全局变量。你需要根据实际情况修改这些变量。

# 数据集根目录
DATASET_ROOT = "/path/to/dataset"

# 实验路径
EXP_PATH = "/path/to/experiments"

synthetic_dataset.yaml

synthetic_dataset.yaml 是用于训练合成数据集的配置文件，包含数据集的生成参数和训练参数。

wireframe_dataset.yaml

wireframe_dataset.yaml 是用于训练 Wireframe 数据集的配置文件，包含数据集的路径和训练参数。

train_detector.yaml

train_detector.yaml 是用于训练检测器的配置文件，包含模型结构、优化器、学习率等参数。

train_full_pipeline.yaml

train_full_pipeline.yaml 是用于训练完整模型的配置文件，包含检测器和描述符的训练参数。

通过修改这些配置文件，你可以自定义训练过程和模型参数。