Package: mmrazor
OpenMMLab websiteHOTOpenMMLab platformTRY IT OUT📘Documentation|🛠️Installation|👀Model Zoo|🤔Reporting IssuesEnglish |简体中文IntroductionMMRazor is a model compression toolkit for model slimming and AutoML, which includes 3 mainstream technologies:Neural Architecture Search (NAS)PruningKnowledge Distillation (KD)QuantizationIt is a part of theOpenMMLabproject.Major features:CompatibilityMMRazor can be easily applied to various projects in OpenMMLab, due to the similar architecture design of OpenMMLab as well as the decoupling of slimming algorithms and vision tasks.FlexibilityDifferent algorithms, e.g., NAS, pruning and KD, can be incorporated in a plug-n-play manner to build a more powerful system.ConvenienceWith better modular design, developers can implement new model compression algorithms with only a few codes, or even by simply modifying config files.About MMRazor's design and implementation, please refer totutorialsfor more details.Latest UpdatesThe default branch is nowmainand the code on the branch has been upgraded to v1.0.0. The oldmasterbranch code now exists on the 0.x branchMMRazor v1.0.0 was released in 2023-4-24, Major updates from 1.0.0rc2 include:MMRazor quantization is released.Add a new pruning algorithm named GroupFisher.Support distilling rtmdet with MMRazor.To know more about the updates in MMRazor 1.0, please refer toChangelogfor more details!Benchmark and model zooResults and models are available in themodel zoo.Supported algorithms:Neural Architecture SearchDARTS(ICLR'2019)DetNAS(NeurIPS'2019)SPOS(ECCV'2020)PruningAutoSlim(NeurIPS'2019)L1-normGroup FisherDMCPKnowledge DistillationCWD(ICCV'2021)WSLD(ICLR'2021)ABLossBYOTDAFLDFADDKDFactor TransferFitNetsKDOFDRKDZSKTFBKDQuantizationPTQQATLSQInstallationMMRazor depends onPyTorch,MMCVandMMEngine.Please refer toinstallation.mdfor more detailed instruction.Getting StartedPlease refer touser guidesfor the basic usage of MMRazor. There are alsoadvanced guides:ContributingWe appreciate all contributions to improve MMRazor.
Please refer toCONTRUBUTING.mdfor the contributing guideline.AcknowledgementMMRazor 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 model compression methods.CitationIf you find this project useful in your research, please consider cite:@misc{2021mmrazor,title={OpenMMLab Model Compression Toolbox and Benchmark},author={MMRazor Contributors},howpublished={\url{https://github.com/open-mmlab/mmrazor}},year={2021}}LicenseThis project is released under theApache 2.0 license.Projects in OpenMMLabMMCV: 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.MMRotate: OpenMMLab rotated object detection toolbox and benchmark.MMYOLO: OpenMMLab YOLO series 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.