OpenMMLab Pre-training Toolbox and Benchmark
 
 
 
 
Go to file
Kai Chen 18c5dfc5f9
Merge pull request #2 from yl-1993/fix/docs
Add requirements during readthedocs build
2020-07-13 01:33:22 +08:00
.github add github action (manually squash) 2020-07-12 00:07:05 +08:00
configs add github action (manually squash) 2020-07-12 00:07:05 +08:00
docs add docs conf 2020-07-13 00:47:13 +08:00
mmcls Add ResNet_CIFAR 2020-07-12 00:06:56 +08:00
requirements add .readthedocs.yml 2020-07-13 01:08:40 +08:00
resources Add README 2020-07-12 00:06:54 +08:00
tests Add ResNet_CIFAR 2020-07-12 00:06:56 +08:00
tools update shufflenet_v1 2020-07-12 00:06:55 +08:00
.gitignore init commit 2020-05-21 21:21:43 +08:00
.pre-commit-config.yaml init commit 2020-05-21 21:21:43 +08:00
.readthedocs.yml add .readthedocs.yml 2020-07-13 01:08:40 +08:00
README.md Add README 2020-07-12 00:06:54 +08:00
requirements.txt add github action (manually squash) 2020-07-12 00:07:05 +08:00
setup.cfg Add RandomCrop, RandomResizedCrop, RandomGrayscale, impad 2020-07-12 00:06:55 +08:00
setup.py add github action (manually squash) 2020-07-12 00:07:05 +08:00

README.md

Introduction

MMClassification is an open source image classification toolbox based on PyTorch. It is a part of the OpenMMLab project developed by Multimedia Laboratory, CUHK.

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.

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

Installation

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

Get 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.

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 detectors.

Many thanks to Wenwei Zhang (@ZwwWayne), Jiarui Xu (@xvjiarui), Xintao Wang (@xinntao) and Zhizhong Li (@innerlee) for their valuable advices and discussions.

Citation

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

@misc{mmclassification,
  author =       {Yang, Lei and Li, Xiaojie and Lou, Zan and Yang, Mingmin and
                  Wang, Fei and Qian, Chen and Chen, Kai and Lin, Dahua},
  title =        {{MMClassification}},
  howpublished = {\url{https://github.com/open-mmlab/mmclassification}},
  year =         {2020}
}

Contact

This repo is currently maintained by Lei Yang (@yl-1993), Xiaojie Li (@xiaojieli0903) and Kai Chen (@hellock).