简介

mmfewshot 是一个基于 PyTorch 的开源小样本学习工具箱，隶属于 OpenMMLab 项目。

主分支支持 PyTorch 1.5 及以上版本。对于更早版本的 PyTorch，兼容性尚未完全测试。

主要特性

• 支持小样本学习中的多种任务

  MMFewShot 提供了小样本分类和检测的统一实现与评估框架。

• 模块化设计

  我们将小样本学习框架拆分为多个组件，使得通过组合不同模块来构建新模型变得更加简单灵活。

• 强大的基线与最先进方法

  该工具箱提供了小样本分类和检测领域的强大基线以及当前最先进的方法。

最新动态

v0.1.0 于 2021年11月24日发布。详细信息及发布历史请参阅 changelog.md。

安装与数据准备

MMFewShot 依赖于 PyTorch 和 MMCV。请参考 install.md 进行 MMFewShot 的安装，并参考 数据准备 进行数据集的准备工作。

快速入门

如果您是小样本学习的新手，可以从 基础知识 开始学习。如果您已经熟悉相关概念，请查看 getting_started.md，了解 mmfewshot 的基本用法。

欲深入了解，可参考以下教程：

• 小样本分类

  • 概述
  • 配置
  • 自定义数据集
  • 自定义模型
  • 自定义运行时

• 小样本检测

  • 概述
  • 配置
  • 自定义数据集
  • 自定义模型
  • 自定义运行时

基准与模型库

结果和模型可在 模型库 中找到。支持的算法如下：

分类

• Baseline (ICLR'2019)
• Baseline++ (ICLR'2019)
• NegMargin (ECCV'2020)
• MatchingNet (NeurIPS'2016)
• ProtoNet (NeurIPS'2017)
• RelationNet (CVPR'2018)
• MetaBaseline (ICCV'2021)
• MAML (ICML'2017)

检测

• TFA (ICML'2020)
• FSCE (CVPR'2021)
• AttentionRPN (CVPR'2020)
• MetaRCNN (ICCV'2019)
• FSDetView (ECCV'2020)
• MPSR (ECCV'2020)

贡献

我们非常欢迎所有有助于改进 mmfewshot 的贡献。请参阅 MMFewShot 中的 CONTRIBUTING.md，了解贡献指南。

致谢

mmfewshot 是一个由来自不同院校和企业的研究人员与工程师共同贡献的开源项目。我们感谢所有实现其方法或添加新功能的贡献者，也感谢提供宝贵反馈的用户。我们希望这个工具箱和基准能够为不断壮大的研究社区服务，提供一个灵活的工具平台，用于复现现有方法并开发新的方法。

引用

如果您在研究中使用了本项目，请考虑引用：

@misc{mmfewshot2021,
    title={OpenMMLab 小样本学习工具箱与基准},
    author={mmfewshot Contributors},
    howpublished = {\url{https://github.com/open-mmlab/mmfewshot}},
    year={2021}
}

许可证

本项目采用 Apache 2.0 许可证 发布。

OpenMMLab 项目

• MMCV：OpenMMLab 计算机视觉基础库。
• MIM：MIM 用于安装 OpenMMLab 相关软件包。
• MMClassification：OpenMMLab 图像分类工具箱及基准测试。
• MMDetection：OpenMMLab 目标检测工具箱及基准测试。
• MMDetection3D：OpenMMLab 下一代通用 3D 物体检测平台。
• MMRotate：OpenMMLab 旋转目标检测工具箱及基准测试。
• MMSegmentation：OpenMMLab 语义分割工具箱及基准测试。
• MMOCR：OpenMMLab 文本检测、识别与理解工具箱。
• MMPose：OpenMMLab 人体姿态估计工具箱及基准测试。
• MMHuman3D：OpenMMLab 3D 人体参数化模型工具箱及基准测试。
• MMSelfSup：OpenMMLab 自监督学习工具箱及基准测试。
• MMRazor：OpenMMLab 模型压缩工具箱及基准测试。
• MMFewShot：OpenMMLab 少样本学习工具箱及基准测试。
• MMAction2：OpenMMLab 下一代动作理解工具箱及基准测试。
• MMTracking：OpenMMLab 视频感知工具箱及基准测试。
• MMFlow：OpenMMLab 光流估计工具箱及基准测试。
• MMEditing：OpenMMLab 图像与视频编辑工具箱。
• MMGeneration：OpenMMLab 生成模型工具箱及基准测试。
• MMDeploy：OpenMMLab 深度学习模型部署工具集。

MMFewShot 快速上手指南

MMFewShot 是基于 PyTorch 的开源小样本学习（Few Shot Learning）工具箱，由 OpenMMLab 团队开发。它统一实现了小样本分类和小样本检测任务，提供模块化设计、强基线模型及最先进（SOTA）算法支持。

1. 环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统: Linux (推荐), Windows, macOS
• Python: 3.7+
• PyTorch: 1.5+ (主分支已测试版本)
• CUDA: 根据 PyTorch 版本匹配对应的 CUDA toolkit

前置依赖： MMFewShot 强依赖于 MMCV。建议先安装好 PyTorch 和 MMCV。

国内加速建议：推荐使用清华源或阿里源加速 Python 包和 PyTorch 的安装。

2. 安装步骤

步骤一：安装 PyTorch

请访问 PyTorch 官网 获取适合您环境的安装命令。例如使用 pip 安装 CUDA 11.1 版本：

pip install torch==1.9.0+cu111 torchvision==0.10.0+cu111 torchaudio==0.9.0 -f https://download.pytorch.org/whl/torch_stable.html

步骤二：安装 MMCV

MMFewShot 需要特定版本的 MMCV。推荐使用 mim 工具进行安装（自动处理依赖）：

pip install -U openmim
mim install mmcv-full

或者直接通过 pip 安装（需指定版本，具体版本兼容性请参考官方文档）：

pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu111/torch1.9.0/index.html

步骤三：安装 MMFewShot

方式 A：从 PyPI 安装（推荐用于推理或简单使用）

pip install mmfewshot

方式 B：从源码安装（推荐用于开发或修改代码）

git clone https://github.com/open-mmlab/mmfewshot.git
cd mmfewshot
pip install -e .

3. 基本使用

MMFewShot 的核心使用流程包括：准备数据 -> 配置模型 -> 训练/测试。以下以小样本分类为例展示最简使用流程。

3.1 数据准备

您需要将数据集整理为 MMFewShot 支持的格式。通常需要将数据划分为 base (基类) 和 novel (新类) 阶段。详细的数据转换脚本位于 tools/data/ 目录下。

假设您已准备好 MiniImageNet 数据集，目录结构如下：

data/
└── mini_imagenet/
    ├── base/
    ├── val/
    └── novel/

3.2 模型训练

使用提供的配置文件启动训练。以下示例使用 Baseline 算法在 MiniImageNet 上进行 5-way 5-shot 训练：

python tools/train.py configs/classification/baseline/mini_imagenet_resnet12_5way_5shot.py --work-dir work_dirs/baseline_mini

• configs/classification/baseline/...: 配置文件路径。
• --work-dir: 指定模型权重和日志的输出目录。

3.3 模型测试

训练完成后，使用测试脚本评估模型性能：

python tools/test.py configs/classification/baseline/mini_imagenet_resnet12_5way_5shot.py work_dirs/baseline_mini/epoch_100.pth --eval accuracy

3.4 小样本检测示例

对于检测任务，流程类似。以下是使用 TFA 算法进行训练的示例：

python tools/train.py configs/detection/tfa/faster_rcnn_r50_fpn_1x_coco.py --work-dir work_dirs/tfa_demo

进阶资源

• 完整文档: https://mmfewshot.readthedocs.io/
• 模型库 (Model Zoo): 查看支持的算法列表及预训练模型下载链接。
• 教程: 参考 docs/ 目录下的分类与检测定制化教程，学习如何修改数据集、模型架构及运行时配置。