nni README

The project's README from github.com/microsoft/nni. As one markdown file: README.md.


MIT licensed Issues Bugs Pull Requests Version Documentation Status

NNI automates feature engineering, neural architecture search, hyperparameter tuning, and model compression for deep learning. Find the latest features, API, examples and tutorials in our official documentation (简体中文版点这里).

What's NEW!  

Installation

See the NNI installation guide to install from pip, or build from source.

To install the current release:

$ pip install nni

To update NNI to the latest version, add --upgrade flag to the above commands.

NNI capabilities in a glance

Hyperparameter Tuning Neural Architecture Search Model Compression
Algorithms
Supported Frameworks Training Services Tutorials
Supports
  • PyTorch
  • TensorFlow
  • Scikit-learn
  • XGBoost
  • LightGBM
  • MXNet
  • Caffe2
  • More...
webui

Resources

Contribution guidelines

If you want to contribute to NNI, be sure to review the contribution guidelines, which includes instructions of submitting feedbacks, best coding practices, and code of conduct.

We use GitHub issues to track tracking requests and bugs. Please use NNI Discussion for general questions and new ideas. For questions of specific use cases, please go to Stack Overflow.

Participating discussions via the following IM groups is also welcomed.

Gitter WeChat
image OR image

Over the past few years, NNI has received thousands of feedbacks on GitHub issues, and pull requests from hundreds of contributors. We appreciate all contributions from community to make NNI thrive.

Test status

Essentials

Type Status
Fast test Build Status
Full test - HPO Build Status
Full test - NAS Build Status
Full test - compression Build Status

Training services

Type Status
Local - linux Build Status
Local - windows Build Status
Remote - linux to linux Build Status
Remote - windows to windows Build Status
OpenPAI Build Status
Frameworkcontroller Build Status
Kubeflow Build Status
Hybrid Build Status
AzureML Build Status

Targeting at openness and advancing state-of-art technology, Microsoft Research (MSR) had also released few other open source projects.

We encourage researchers and students leverage these projects to accelerate the AI development and research.

License

The entire codebase is under MIT license.

nni (microsoft/nni)

Searching Database…

14.4K ·GitHub
archived
What is this?NNI (Neural Network Intelligence) is Microsoft's open-source AutoML toolkit that automates the machine learning lifecycle: feature engineering, neural architecture search, model compression, and hyperparameter tuning.
So is it a Python library I import, or a bigger platform?It's a Python toolkit you install with pip and drive from your training code, but it can also scale experiments out to training services like Kubernetes, OpenPAI, Kubeflow, or AzureML.
Which ML frameworks does it work with?Out of the box it supports PyTorch, TensorFlow, Scikit-learn, XGBoost, LightGBM, and MXNet, plus Caffe2 and more — so you plug it into the framework your model already uses.
Is it still actively maintained?No — the repository is archived, so development has stopped. The last release was the v3.0 preview from May 2022; expect no new features or fixes.
Can I run it on Windows, or is it Linux-only?Both: its test matrix covers local training on Linux and on Windows, plus remote scenarios like Linux-to-Linux and Windows-to-Windows.
What exactly can it automate for me?Four things: hyperparameter tuning with exhaustive, heuristic, and Bayesian search; neural architecture search in multi-trial and one-shot modes; model compression via pruning and quantization; plus feature engineering.
Does it scale beyond my laptop to a cluster?Yes — Kubernetes-based training services are supported: OpenPAI, FrameworkController, and Kubeflow, plus AzureML and hybrid setups for larger tuning and NAS runs.
Is there video material to see it in action?Yes — there's a demo on YouTube and a Bilibili channel (last updated June 2022), and a webinar introduces Retiarii, NNI's deep learning exploratory-training framework.
Creator
microsoft
Size
130 MB
Stars
14.4K
Age
8y
Commits · 90 Days