Skip to main content

OpenMMLab Self-Supervised Learning Toolbox and Benchmark

Project description

<font size="5">OpenMMLab website</font> <font size="4">HOT</font>      <font size="5">OpenMMLab platform</font> <font size="4">TRY IT OUT</font>

PyPI docs badge codecov license open issues

📘Documentation | 🛠️Installation | 👀Model Zoo | 🆕Update News | 🤔Reporting Issues

English | 简体中文


MMSelfSup is an open source self-supervised representation learning toolbox based on PyTorch. It is a part of the OpenMMLab project.

The master branch works with PyTorch 1.5+.

Major features
  • Methods All in One

    MMSelfsup provides state-of-the-art methods in self-supervised learning. For comprehensive comparison in all benchmarks, most of the pre-training methods are under the same setting.

  • Modular Design

    MMSelfSup follows a similar code architecture of OpenMMLab projects with modular design, which is flexible and convenient for users to build their own algorithms.

  • Standardized Benchmarks

    MMSelfSup standardizes the benchmarks including logistic regression, SVM / Low-shot SVM from linearly probed features, semi-supervised classification, object detection and semantic segmentation.

  • Compatibility

    Since MMSelfSup adopts similar design of modulars and interfaces as those in other OpenMMLab projects, it supports smooth evaluation on downstream tasks with other OpenMMLab projects like object detection and segmentation.

What's New

💎 Stable version

MMSelfSup v0.11.0 was released in 30/12/2022.

Highlights of the new version:

  • Support InterCLR
  • Fix some bugs

Please refer to for details and release history.

Differences between MMSelfSup and OpenSelfSup codebases can be found in

🌟 Preview of 1.x version

A brand new version of MMSelfSup v1.0.0rc4 was released in 07/12/2022.

Highlights of the new version:

  • Based on MMEngine and MMCV.
  • Refine all documents.
  • Support BEiT v1, BEiT v2, MILAN, MixMIM, EVA.
  • Support MAE, SimMIM, MoCoV3 with different pre-training epochs and backbones of different scales.
  • More concise APIs.
  • More visualization tools.
  • More powerful data pipeline.
  • Higher accurcy for some algorithms.

Find more new features in 1.x branch. Issues and PRs are welcome!


MMSelfSup relies on PyTorch, MMCV and MMClassification.

Please refer to for more detailed instruction.

Get Started

Please refer to for dataset preparation, for the basic usage and for running benchmarks.

We also provides more detailed tutorials:

Besides, we provide colab tutorial for basic usage.

Please refer to FAQ for frequently asked questions.

Model Zoo

Please refer to for a comprehensive set of pre-trained models and benchmarks.

Supported algorithms:

More algorithms are in our plan.


Benchmarks Setting
ImageNet Linear Classification (Multi-head) Goyal2019
ImageNet Linear Classification (Last)
ImageNet Semi-Sup Classification
Places205 Linear Classification (Multi-head) Goyal2019
iNaturalist2018 Linear Classification (Multi-head) Goyal2019
PASCAL VOC07 SVM Goyal2019
PASCAL VOC07 Low-shot SVM Goyal2019
PASCAL VOC07+12 Object Detection MoCo
COCO17 Object Detection MoCo
Cityscapes Segmentation MMSeg
PASCAL VOC12 Aug Segmentation MMSeg


We appreciate all contributions improving MMSelfSup. Please refer to for more details about the contributing guideline.


MMSelfSup 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 algorithms.

MMSelfSup originates from OpenSelfSup, and we appreciate all early contributions made to OpenSelfSup. A few contributors are listed here: Xiaohang Zhan (@XiaohangZhan), Jiahao Xie (@Jiahao000), Enze Xie (@xieenze), Xiangxiang Chu (@cxxgtxy), Zijian He (@scnuhealthy).


If you use this toolbox or benchmark in your research, please cite this project.

    title={{MMSelfSup}: OpenMMLab Self-Supervised Learning Toolbox and Benchmark},
    author={MMSelfSup Contributors},


This project is released under the Apache 2.0 license.

Projects in OpenMMLab

  • MMCV: OpenMMLab foundational library for computer vision.
  • MIM: MIM installs OpenMMLab packages.
  • MMClassification: OpenMMLab image classification toolbox and benchmark.
  • MMDetection: OpenMMLab detection toolbox and benchmark.
  • MMDetection3D: OpenMMLab's next-generation platform for general 3D object detection.
  • MMYOLO: OpenMMLab YOLO series toolbox and benchmark.
  • MMRotate: OpenMMLab rotated object detection toolbox and benchmark.
  • MMSegmentation: OpenMMLab semantic segmentation toolbox and benchmark.
  • MMOCR: OpenMMLab text detection, recognition, and understanding toolbox.
  • MMPose: OpenMMLab pose estimation toolbox and benchmark.
  • MMHuman3D: OpenMMLab 3D human parametric model toolbox and benchmark.
  • MMSelfSup: OpenMMLab self-supervised learning toolbox and benchmark.
  • MMRazor: OpenMMLab model compression toolbox and benchmark.
  • MMFewShot: OpenMMLab fewshot learning toolbox and benchmark.
  • MMAction2: OpenMMLab's next-generation action understanding toolbox and benchmark.
  • MMTracking: OpenMMLab video perception toolbox and benchmark.
  • MMFlow: OpenMMLab optical flow toolbox and benchmark.
  • MMEditing: OpenMMLab image and video editing toolbox.
  • MMGeneration: OpenMMLab image and video generative models toolbox.
  • MMDeploy: OpenMMLab model deployment framework.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mmselfsup-0.11.0.tar.gz (156.5 kB view hashes)

Uploaded source

Built Distribution

mmselfsup-0.11.0-py3-none-any.whl (359.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page