OpenMMLab Pre-training Toolbox and Benchmark
 
 
 
 
Go to file
Ma Zerun 1d6d142b42
[Docs] Use PyTorch style docs theme (#457)
* Change docs theme to pytorch-theme

* Update docs rst

* Fix docs title level.

* Add static resources

* Fix lint
2021-09-23 22:21:03 +08:00
.github [Feature] timm backbones wrapper (#427) 2021-09-06 11:05:31 +08:00
configs [Docs] Update metafile and Readme (#435) 2021-09-18 16:32:46 +08:00
demo [Docs] Add Copyright information. (#413) 2021-08-17 19:52:42 +08:00
docker Bump version to v0.15.0 (#426) 2021-08-31 14:33:32 +08:00
docs [Docs] Use PyTorch style docs theme (#457) 2021-09-23 22:21:03 +08:00
docs_zh-CN [Docs] Use PyTorch style docs theme (#457) 2021-09-23 22:21:03 +08:00
mmcls [Refactor] Fix TnT compatibility and verbose warning. (#436) 2021-09-22 19:37:24 +08:00
requirements [Docs] Use PyTorch style docs theme (#457) 2021-09-23 22:21:03 +08:00
resources Add README 2020-07-12 00:06:54 +08:00
tests [Refactor] Fix TnT compatibility and verbose warning. (#436) 2021-09-22 19:37:24 +08:00
tools [Enhance] Support setting `--out-items` in `tools/test.py`. (#437) 2021-09-15 11:06:16 +08:00
.gitignore [Enhance] Improve downstream repositories compatibility (#421) 2021-09-08 10:38:57 +08:00
.pre-commit-config.yaml Update CONTRIBUTING.md according to mmcv (#210) 2021-04-14 21:22:37 +08:00
.readthedocs.yml Support output pdf version readthedocs document. (#382) 2021-07-31 14:11:50 +08:00
CITATION.cff [Docs] Add `CITATION.cff` (#428) 2021-09-01 17:07:27 +08:00
LICENSE [Docs] Add Copyright information. (#413) 2021-08-17 19:52:42 +08:00
MANIFEST.in [Feature] Support mim (#376) 2021-07-27 17:58:04 +08:00
README.md Bump version to v0.15.0 (#426) 2021-08-31 14:33:32 +08:00
README_zh-CN.md Bump version to v0.15.0 (#426) 2021-08-31 14:33:32 +08:00
model-index.yml [Docs] Update metafile and Readme (#435) 2021-09-18 16:32:46 +08:00
requirements.txt workflow: modify build, add deploy (#61) 2020-10-10 22:15:50 +08:00
setup.cfg [Docs] Use PyTorch style docs theme (#457) 2021-09-23 22:21:03 +08:00
setup.py [Docs] Add `CITATION.cff` (#428) 2021-09-01 17:07:27 +08:00

README.md

Build Status Documentation Status codecov license

Introduction

English | 简体中文

MMClassification is an open source image classification toolbox based on PyTorch. It is a part of the OpenMMLab project.

Documentation: https://mmclassification.readthedocs.io/en/latest/

demo

Major features

  • Various backbones and pretrained models
  • Bag of training tricks
  • Large-scale training configs
  • High efficiency and extensibility

License

This project is released under the Apache 2.0 license.

Changelog

v0.15.0 was released in 31/8/2021. Please refer to changelog.md for details and release history.

Benchmark and model zoo

Results and models are available in the model zoo.

Supported backbones:

  • ResNet
  • ResNeXt
  • SE-ResNet
  • SE-ResNeXt
  • RegNet
  • ShuffleNetV1
  • ShuffleNetV2
  • MobileNetV2
  • MobileNetV3
  • Swin-Transformer

Installation

Please refer to install.md for installation and dataset preparation.

Getting Started

Please see getting_started.md for the basic usage of MMClassification. There are also tutorials for finetuning models, adding new dataset, designing data pipeline, and adding new modules.

Citation

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

@misc{2020mmclassification,
    title={OpenMMLab's Image Classification Toolbox and Benchmark},
    author={MMClassification Contributors},
    howpublished = {\url{https://github.com/open-mmlab/mmclassification}},
    year={2020}
}

Contributing

We appreciate all contributions to improve MMClassification. Please refer to CONTRUBUTING.md for the contributing guideline.

Acknowledgement

MMClassification 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 classifiers.

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.
  • MMSegmentation: OpenMMLab semantic segmentation toolbox and benchmark.
  • MMAction2: OpenMMLab's next-generation action understanding toolbox and benchmark.
  • MMTracking: OpenMMLab video perception toolbox and benchmark.
  • MMPose: OpenMMLab pose estimation toolbox and benchmark.
  • MMEditing: OpenMMLab image and video editing toolbox.
  • MMOCR: OpenMMLab toolbox for text detection, recognition and understanding.
  • MMGeneration: OpenMMlab toolkit for generative models.