OS2D 项目使用教程

1. 项目目录结构及介绍

OS2D 项目的目录结构如下：

os2d/
├── baselines/
├── data/
├── experiments/
├── models/
├── os2d/
├── env/
├── .gitignore
├── FASTAPI.md
├── INSTALL.md
├── LICENSE
├── README.md
├── app.py
├── demo-api.ipynb
├── demo.ipynb
├── docker-compose.yml
└── main.py

目录介绍

• baselines/: 包含项目的基准数据和配置。
• data/: 存放数据集文件，包括训练和测试数据。
• experiments/: 包含实验配置文件和实验结果。
• models/: 存放预训练模型和模型相关文件。
• os2d/: 核心代码库，包含主要的算法实现。
• env/: 环境配置文件，可能包含虚拟环境配置。
• .gitignore: Git 忽略文件配置。
• FASTAPI.md: 关于使用 FastAPI 的说明文档。
• INSTALL.md: 项目安装指南。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• app.py: 应用启动文件。
• demo-api.ipynb: API 演示笔记本文件。
• demo.ipynb: 项目演示笔记本文件。
• docker-compose.yml: Docker 配置文件。
• main.py: 项目主启动文件。

2. 项目启动文件介绍

main.py

main.py 是 OS2D 项目的主启动文件。它负责加载配置、初始化模型、进行训练和评估等操作。以下是启动文件的主要功能：

• 加载配置文件: 通过 --config-file 参数指定配置文件路径。
• 初始化模型: 根据配置文件初始化模型，并加载预训练权重。
• 训练和评估: 根据配置进行模型训练和评估。

示例启动命令

python main.py --config-file experiments/config_training.yml

3. 项目配置文件介绍

experiments/config_training.yml

config_training.yml 是 OS2D 项目的主要配置文件，用于定义训练和评估的参数。以下是配置文件的主要内容：

• 模型配置: 定义模型的架构、是否使用几何模型、是否简化仿射模型等。
• 训练配置: 定义训练的目标函数、是否进行数据挖掘、是否冻结批量归一化等。
• 评估配置: 定义评估的数据集、图像缩放比例等。

示例配置片段

model:
  use_inverse_geom_model: True
  use_simplified_affine_model: False
  backbone_arch: ResNet50

train:
  do_training: False
  objective:
    loc_weight: 0.0

eval:
  dataset_names: ["grozi-val-new-cl"]
  dataset_scales: [1280.0]

通过修改配置文件中的参数，可以自定义训练和评估的行为。