示例训练脚本位于 YOUR_CIRTORCH_ROOT/cirtorch/examples/train.py

python3 -m cirtorch.examples.train [-h] [--training-dataset DATASET] [--no-val]
                [--test-datasets DATASETS] [--test-whiten DATASET]
                [--test-freq N] [--arch ARCH] [--pool POOL]
                [--local-whitening] [--regional] [--whitening]
                [--not-pretrained] [--loss LOSS] [--loss-margin LM]
                [--image-size N] [--neg-num N] [--query-size N]
                [--pool-size N] [--gpu-id N] [--workers N] [--epochs N]
                [--batch-size N] [--optimizer OPTIMIZER] [--lr LR]
                [--momentum M] [--weight-decay W] [--print-freq N]
                [--resume FILENAME]
                EXPORT_DIR

如需详细说明选项，请运行：

python3 -m cirtorch.examples.train -h

注意：使用示例脚本时，训练和测试所需的数据及网络将自动下载。

示例测试脚本位于 YOUR_CIRTORCH_ROOT/cirtorch/examples/test.py

python3 -m cirtorch.examples.test [-h] (--network-path NETWORK | --network-offtheshelf NETWORK)
               [--datasets DATASETS] [--image-size N]
               [--multiscale MULTISCALE] [--whitening WHITENING] [--gpu-id N]

如需详细说明选项，请运行：

python3 -m cirtorch.examples.test -h

注意：使用示例脚本时，测试所需的数据将自动下载。

例如，要训练我们在 TPAMI 2018 论文中描述的最佳网络，请运行以下命令。每个 epoch 结束后，微调后的网络将在重新访问的 Oxford 和 Paris 基准测试集上进行测试：

python3 -m cirtorch.examples.train YOUR_EXPORT_DIR --gpu-id '0' --training-dataset 'retrieval-SfM-120k' 
            --test-datasets 'roxford5k,rparis6k' --arch 'resnet101' --pool 'gem' --loss 'contrastive' 
            --loss-margin 0.85 --optimizer 'adam' --lr 5e-7 --neg-num 5 --query-size=2000 
            --pool-size=22000 --batch-size 5 --image-size 362

每个 epoch 结束后，可以使用学习到的白化对网络进行评估（白化在 epoch 结尾时估计）。为此，请运行以下命令。请注意，这会显著减慢整个训练过程，您也可以稍后使用示例测试脚本对已学习白化的网络进行评估。

python3 -m cirtorch.examples.train YOUR_EXPORT_DIR --gpu-id '0' --training-dataset 'retrieval-SfM-120k' 
            --test-datasets 'roxford5k,rparis6k' --test-whiten 'retrieval-SfM-30k' 
            --arch 'resnet101' --pool 'gem' --loss 'contrastive' --loss-margin 0.85 
            --optimizer 'adam' --lr 5e-7 --neg-num 5 --query-size=2000 --pool-size=22000 
            --batch-size 5 --image-size 362

注意：调整后的（较低的）学习率是为了使性能与使用 MatConvNet 和 PyTorch-0.3.0 实现的训练结果相近。

我们提供了使用与 TPAMI 2018 论文相同参数训练的预训练网络，并预先计算了后处理白化步骤。要评估这些网络，请运行：

python3 -m cirtorch.examples.test --gpu-id '0' --network-path 'retrievalSfM120k-resnet101-gem' 
                --datasets 'oxford5k,paris6k,roxford5k,rparis6k' 
                --whitening 'retrieval-SfM-120k'
                --multiscale '[1, 1/2**(1/2), 1/2]'

或

python3 -m cirtorch.examples.test --gpu-id '0' --network-path 'retrievalSfM120k-vgg16-gem' 
                --datasets 'oxford5k,paris6k,roxford5k,rparis6k' 
                --whitening 'retrieval-SfM-120k'
                --multiscale '[1, 1/2**(1/2), 1/2]'

下表展示了使用本框架训练的网络与论文中使用的、基于我们的 CNN Image Retrieval in MatConvNet 训练的网络之间的性能对比：

注（2022年6月）：我们更新了 Oxford 5k 和 Paris 6k 图像的下载文件，以使用原始数据集提供者建议的面部模糊版本。请注意，“实验表明，使用面部模糊版本进行图像检索基准测试，精度损失可忽略不计”。

要使用单尺度且不进行白化学习来评估您训练的网络：

python3 -m cirtorch.examples.test --gpu-id '0' --network-path YOUR_NETWORK_PATH 
                --datasets 'oxford5k,paris6k,roxford5k,rparis6k'

要使用多尺度评估并结合后处理学习到的白化来评估训练好的网络：

python3 -m cirtorch.examples.test --gpu-id '0' --network-path YOUR_NETWORK_PATH 
                --datasets 'oxford5k,paris6k,roxford5k,rparis6k'
                --whitening 'retrieval-SfM-120k' 
                --multiscale '[1, 1/2**(1/2), 1/2]'

现成的网络也可以进行评估，例如：

python3 -m cirtorch.examples.test --gpu-id '0' --network-offtheshelf 'resnet101-gem'
                --datasets 'oxford5k,paris6k,roxford5k,rparis6k'
                --whitening 'retrieval-SfM-120k' 
                --multiscale '[1, 1/2**(1/2), 1/2]'

另一种架构是在全局池化之后加入一个可学习的 FC（投影）层。重要的是，该层的参数应使用学习到的白化结果进行初始化。
要训练这样的设置，可以运行以下命令（性能将每 5 个 epoch 在 roxford5k 和 rparis6k 上评估）：

python3 -m cirtorch.examples.train YOUR_EXPORT_DIR --gpu-id '0' --training-dataset 'retrieval-SfM-120k' 
            --loss 'triplet' --loss-margin 0.5 --optimizer 'adam' --lr 1e-6 
            --arch 'resnet50' --pool 'gem' --whitening 
            --neg-num 5 --query-size=2000 --pool-size=20000 
            --batch-size 5 --image-size 1024 --epochs 100 
            --test-datasets 'roxford5k,rparis6k' --test-freq 5 

或

python3 -m cirtorch.examples.train YOUR_EXPORT_DIR --gpu-id '0' --training-dataset 'retrieval-SfM-120k' 
            --loss 'triplet' --loss-margin 0.5 --optimizer 'adam' --lr 5e-7 
            --arch 'resnet101' --pool 'gem' --whitening 
            --neg-num 4 --query-size=2000 --pool-size=20000 
            --batch-size 5 --image-size 1024 --epochs 100 
            --test-datasets 'roxford5k,rparis6k' --test-freq 5 

或

python3 -m cirtorch.examples.train YOUR_EXPORT_DIR --gpu-id '0' --training-dataset 'retrieval-SfM-120k' 
            --loss 'triplet' --loss-margin 0.5 --optimizer 'adam' --lr 5e-7 
            --arch 'resnet152' --pool 'gem' --whitening 
            --neg-num 3 --query-size=2000 --pool-size=20000 
            --batch-size 5 --image-size 900 --epochs 100 
            --test-datasets 'roxford5k,rparis6k' --test-freq 5 

分别对应 ResNet50、ResNet101 或 ResNet152。

实现细节：

• FC 层使用监督方式在我们的训练数据和现成特征上学习到的白化结果进行初始化。
• 对于这些 FC 层，我们已经为流行的架构和池化方法预计算了白化参数，完整列表请参见 imageretrievalnet.py#L50。
• 当在微调过程中添加此 FC 层时，如果训练和测试时使用的图像具有相似的高分辨率，则性能最佳。
• 添加此 FC 层后，成对距离的分布会发生显著变化，因此对比损失应使用大约两倍大的 margin。在这种情况下，三元组损失的表现略好一些。
• 还可以通过进一步调整超参数来获得更高的性能或更快的训练速度。请注意，在本示例中，--neg-num 和 --image-size 等超参数的选择是为了确保可以在单块拥有 16 GB 显存的 GPU 上进行训练。

我们提供了在 retrieval-SfM-120k (rSfM120k) 和 google-landmarks-2018 (gl18) 训练数据集上训练的带投影层的预训练网络。
对于这种架构，无需再进行白化作为后处理步骤（通常性能提升不明显），尽管也可以选择这样做。
例如，使用高分辨率图像和三元组损失，在 google-landmarks-2018 (gl18) 数据集上训练的带有 GeM 和投影层的 ResNet101 的多尺度评估，可以通过以下脚本完成：

python3 -m cirtorch.examples.test_e2e --gpu-id '0' --network 'gl18-tl-resnet101-gem-w' 
            --datasets 'roxford5k,rparis6k' --multiscale '[1, 2**(1/2), 1/2**(1/2)]'

下表给出了所有可用预训练网络的多尺度性能：

注（2022 年 6 月）：我们已更新了用于 Oxford 5k 和 Paris 6k 图像的下载文件，以使用原始数据集提供者建议的面部模糊版本。请注意，“实验表明，使用面部模糊版本进行图像检索基准测试，精度损失可以忽略不计”。

@article{RTC18,
 title = {Fine-tuning {CNN} Image Retrieval with No Human Annotation},
 author = {Radenovi{\'c}, F. and Tolias, G. and Chum, O.}
 journal = {TPAMI},
 year = {2018}
}

@inproceedings{RTC16,
 title = {{CNN} Image Retrieval Learns from {BoW}: Unsupervised Fine-Tuning with Hard Examples},
 author = {Radenovi{\'c}, F. and Tolias, G. and Chum, O.},
 booktitle = {ECCV},
 year = {2016}
}

@inproceedings{RITAC18,
 author = {Radenovi{\'c}, F. and Iscen, A. and Tolias, G. and Avrithis, Y. and Chum, O.},
 title = {Revisiting Oxford and Paris: Large-Scale Image Retrieval Benchmarking},
 booktitle = {CVPR},
 year = {2018}
}

master（开发中）

• 合并了拉取请求 #78，修复了损坏的下载链接
• 合并了拉取请求 #56，添加了 setup 文件

v1.2（2020年12月7日）

• 添加了使用不同公开可用模型提取描述符的示例脚本
• 添加了 MIT 许可证
• 为新的带有投影层的预训练网络，在 roxford5k 和 rparis6k 数据集上增加了多尺度性能评估，这些网络同时在 retrieval-SfM-120 和 google-landmarks-2018 训练数据集上进行过训练
• 添加了一个新的无后处理的示例测试脚本，适用于包含投影层的网络
• 在训练示例中增加了一些内容：GeMmp 池化、三元组损失，以及一个用于处理超大批次的小技巧
• 在 imageretrievalnet 中增加了更多预计算的白化选项
• 添加了三元组损失
• 添加了具有多个参数的 GeM 池化（每个通道/维度对应一个 p 值）
• 添加了脚本，以支持在 Windows 10 上下载，具体说明见议题 #39，感谢 SongZRui 的贡献
• 修复了下采样查询图像的裁剪问题

v1.1（2019年6月12日）

• 代码迁移到 PyTorch 1.0.0，移除了 Variable，并在评估时添加了 torch.no_grad，以提高速度并减少内存占用
• 添加了刚性网格区域池化，可与任何全局池化方法（R-MAC、R-SPoC、R-GeM）结合使用
• 添加了幂律归一化层
• 在示例测试脚本中增加了使用任意尺度集合进行多尺度测试的功能
• 修复了白化学习过程中协方差矩阵估计的精度误差相关问题
• 修复了一些小 bug

v1.0（2018年7月9日）

• 首个公开版本
• 兼容 PyTorch 0.3.0