Hawkeye 开源项目使用教程

1. 项目目录结构及介绍

Hawkeye 是一个基于 PyTorch 的细粒度图像识别工具箱。以下是项目的目录结构及其介绍：

Hawkeye/
├── Examples/
│   ├── APINet.py
│   ├── BCNN.py
│   └── ...
├── configs/
│   ├── APINet.yaml
│   ├── BCNN_S1.yaml
│   ├── BCNN_S2.yaml
│   └── ...
├── data/
│   ├── bird/
│   │   ├── CUB_200_2011/
│   │   └── ...
│   ├── web-car/
│   │   ├── train/
│   │   ├── val/
│   │   └── ...
│   └── ...
├── metadata/
│   ├── cub/
│   ├── web_car/
│   └── ...
├── model/
│   ├── methods/
│   │   ├── S3N/
│   │   ├── ProtoTree/
│   │   └── ...
│   ├── loss/
│   │   ├── API-Net/
│   │   ├── Pairwise Confusion/
│   │   └── ...
│   └── ...
├── resources/
├── utils/
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── config.py
├── results.csv
├── test.py
└── train.py

目录结构介绍：

• Examples/: 包含各种方法的训练示例文件。
• configs/: 包含各种方法的配置文件。
• data/: 存放数据集的目录。
• metadata/: 包含数据集的元数据文件。
• model/: 包含各种方法的模型和损失函数。
• resources/: 存放项目所需的资源文件。
• utils/: 包含项目所需的工具函数。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• config.py: 配置文件处理脚本。
• results.csv: 实验结果记录文件。
• test.py: 测试脚本。
• train.py: 训练脚本。

2. 项目启动文件介绍

train.py

train.py 是项目的训练脚本，用于启动模型的训练过程。以下是启动训练的示例命令：

python train.py --config configs/APINet.yaml

test.py

test.py 是项目的测试脚本，用于测试已训练好的模型。以下是启动测试的示例命令：

python test.py --config configs/test.yaml

3. 项目的配置文件介绍

配置文件结构

配置文件位于 configs/ 目录下，每个方法都有一个对应的配置文件。以下是 APINet.yaml 配置文件的示例结构：

dataset:
  name: cub
  root_dir: data/bird/CUB_200_2011/images
  meta_dir: metadata/cub

model:
  type: APINet
  params:
    ...

train:
  batch_size: 32
  epochs: 100
  ...

test:
  batch_size: 64
  ...

配置文件参数介绍

• dataset: 数据集配置，包括数据集名称、根目录和元数据目录。
• model: 模型配置，包括模型类型和参数。
• train: 训练配置，包括批量大小、训练轮数等。
• test: 测试配置，包括批量大小等。

通过修改配置文件中的参数，可以调整模型的训练和测试行为。