open-mmlab / mmfewshot

OpenMMLab FewShot Learning Toolbox and Benchmark
https://mmfewshot.readthedocs.io/en/latest/
Apache License 2.0
703 stars 118 forks source link
few-shot-learning openmmlab pytorch
 
OpenMMLab website HOT      OpenMMLab platform TRY IT OUT
 
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mmfewshot)](https://pypi.org/project/mmfewshot/) [![PyPI](https://img.shields.io/pypi/v/mmfewshot)](https://pypi.org/project/mmfewshot) [![docs](https://img.shields.io/badge/docs-latest-blue)](https://mmfewshot.readthedocs.io/en/latest/) [![badge](https://github.com/open-mmlab/mmfewshot/workflows/build/badge.svg)](https://github.com/open-mmlab/mmfewshot/actions) [![codecov](https://codecov.io/gh/open-mmlab/mmfewshot/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmfewshot) [![license](https://img.shields.io/github/license/open-mmlab/mmfewshot.svg)](https://github.com/open-mmlab/mmfewshot/blob/master/LICENSE) [📘Documentation](https://mmfewshot.readthedocs.io/) | [🛠️Installation](https://mmfewshot.readthedocs.io/en/latest/install.html) | [👀Model Zoo](https://mmfewshot.readthedocs.io/en/latest/model_zoo.html) | [🆕Update News](https://mmfewshot.readthedocs.io/en/latest/changelog.html) | [🤔Reporting Issues](https://github.com/open-mmlab/mmfewshot/issues/new/choose)
English | [简体中文](README_zh-CN.md)

Introduction

mmfewshot is an open source few shot learning toolbox based on PyTorch. It is a part of the OpenMMLab project.

The master branch works with PyTorch 1.5+. The compatibility to earlier versions of PyTorch is not fully tested.

Major features

What's New

v0.1.0 was released in 24/11/2021. Please refer to changelog.md for details and release history.

Installation & Dataset Preparation

MMFewShot depends on PyTorch and MMCV. Please refer to install.md for installation of MMFewShot and data preparation for dataset preparation.

Getting Started

If you are new of few shot learning, you can start with learn the basics. If you are familiar with it, check out getting_started.md for the basic usage of mmfewshot.

Refer to the below tutorials to dive deeper:

Benchmark and model zoo

Results and models are available in the model zoo. Supported algorithms:

Classification - [x] [Baseline](configs/classification/baseline/README.md) (ICLR'2019) - [x] [Baseline++](configs/classification/baseline_plus/README.md) (ICLR'2019) - [x] [NegMargin](configs/classification/neg_margin/README.md) (ECCV'2020) - [x] [MatchingNet](configs/classification/matching_net/README.md) (NeurIPS'2016) - [x] [ProtoNet](configs/classification/proto_net/README.md) (NeurIPS'2017) - [x] [RelationNet](configs/classification/relation_net/README.md) (CVPR'2018) - [x] [MetaBaseline](configs/classification/meta_baseline/README.md) (ICCV'2021) - [x] [MAML](configs/classification/maml/README.md) (ICML'2017)
Detection - [x] [TFA](configs/detection/tfa/README.md) (ICML'2020) - [x] [FSCE](configs/detection/fsce/README.md) (CVPR'2021) - [x] [AttentionRPN](configs/detection/attention_rpn/README.md) (CVPR'2020) - [x] [MetaRCNN](configs/detection/meta_rcnn/README.md) (ICCV'2019) - [x] [FSDetView](configs/detection/fsdetview/README.md) (ECCV'2020) - [x] [MPSR](configs/detection/mpsr/README.md) (ECCV'2020)

Contributing

We appreciate all contributions to improve mmfewshot. Please refer to CONTRIBUTING.md in MMFewShot for the contributing guideline.

Acknowledgement

mmfewshot is an open source project that is contributed by researchers and engineers from various colleges and companies. We appreciate all the contributors who implement their methods or add new features, as well as users who give valuable feedbacks. We wish that the toolbox and benchmark could serve the growing research community by providing a flexible toolkit to reimplement existing methods and develop their own new methods.

Citation

If you find this project useful in your research, please consider cite:

@misc{mmfewshot2021,
    title={OpenMMLab Few Shot Learning Toolbox and Benchmark},
    author={mmfewshot Contributors},
    howpublished = {\url{https://github.com/open-mmlab/mmfewshot}},
    year={2021}
}

License

This project is released under the Apache 2.0 license.

Projects in OpenMMLab