CFNet 项目使用教程

1. 项目目录结构及介绍

CFNet 项目的目录结构如下：

CFNet/
├── datasets/
│   ├── KITTI2015/
│   ├── KITTI2012/
│   ├── Middlebury/
│   └── ETH3D/
├── models/
│   ├── relu/
│   └── ...
├── scripts/
│   ├── sceneflow.sh
│   ├── robust.sh
│   ├── eth3d_save.sh
│   ├── mid_save.sh
│   └── kitti15_save.sh
├── utils/
├── LICENSE
├── README.md
├── main.py
├── robust.py
├── robust_test.py
├── save_disp.py
├── save_disp_eth3d.py
├── save_disp_mid.py
└── ...

目录结构介绍

• datasets/: 存放数据集的目录，包括 KITTI2015、KITTI2012、Middlebury 和 ETH3D 数据集。
• models/: 存放模型定义的目录，包括不同版本的模型文件。
• scripts/: 存放训练和评估脚本的目录，包括预训练、微调、评估等脚本。
• utils/: 存放工具函数和辅助代码的目录。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍文档。
• main.py: 项目的启动文件。
• robust.py: 用于训练和评估的脚本。
• robust_test.py: 用于测试模型跨域泛化能力的脚本。
• save_disp.py: 用于保存预测结果的脚本。
• save_disp_eth3d.py: 用于保存 ETH3D 数据集预测结果的脚本。
• save_disp_mid.py: 用于保存 Middlebury 数据集预测结果的脚本。

2. 项目的启动文件介绍

main.py

main.py 是 CFNet 项目的启动文件，负责初始化模型、加载数据集、进行训练和评估等操作。以下是该文件的主要功能：

• 模型初始化: 初始化 CFNet 模型。
• 数据加载: 加载训练和测试数据集。
• 训练: 执行模型的训练过程。
• 评估: 在测试集上评估模型的性能。

使用方法

python main.py --config config.yaml

其中，config.yaml 是项目的配置文件，包含了训练和评估的参数设置。

3. 项目的配置文件介绍

config.yaml

config.yaml 是 CFNet 项目的配置文件，包含了训练和评估过程中所需的参数设置。以下是配置文件的主要内容：

# 数据集路径
data_path: "/path/to/datasets"

# 模型参数
model:
  name: "CFNet"
  pretrained: True

# 训练参数
training:
  batch_size: 8
  epochs: 50
  learning_rate: 0.001

# 评估参数
evaluation:
  metrics: ["epe", "d1"]
  save_predictions: True

配置文件介绍

• data_path: 数据集的存储路径。
• model: 模型的相关配置，包括模型名称和是否使用预训练模型。
• training: 训练过程中的参数设置，包括批量大小、训练轮数和学习率。
• evaluation: 评估过程中的参数设置，包括评估指标和是否保存预测结果。

通过修改 config.yaml 文件中的参数，可以灵活地调整训练和评估的配置。