Home

Neural Network Intelligence

NNI (Neural Network Intelligence) is a toolkit to help users run automated machine learning experiments. The tool dispatches and runs trial jobs that generated by tuning algorithms to search the best neural architecture and/or hyper-parameters in different environments (e.g. local machine, remote servers and cloud).

Who should consider using NNI

• Those who want to try different AutoML algorithms in their training code (model) at their local machine.
• Those who want to run AutoML trial jobs in different environments to speed up search (e.g. remote servers and cloud).
• Researchers and data scientists who want to implement their own AutoML algorithms and compare it with other algorithms.
• ML Platform owners who want to support AutoML in their platform.

Install & Verify

Install through pip

• We only support Linux in current stage, Ubuntu 16.04 or higher are tested and supported. Simply run the following pip install in an environment that has python >= 3.5.

    python3 -m pip install --user nni

Install through source code

• We only support Linux (Ubuntu 16.04 or higher) in our current stage.
• Run the following commands in an environment that has python >= 3.5, git and wget.

    git clone -b v0.3.0 https://github.com/Microsoft/nni.git	
    cd nni	
    source install.sh	

Verify install

• The following example is an experiment built on TensorFlow. Make sure you have TensorFlow installed before running it.
• Download the examples via clone the source code.

    git clone -b v0.3.0 https://github.com/Microsoft/nni.git

• Run the mnist example.

    nnictl create --config nni/examples/trials/mnist/config.yml

• Wait for the message Info: Start experiment success! in the command line. This message indicates that your experiment has been successfully started. You can explore the experiment using the Web UI url.

    Info: Checking experiment...
    ...
    Info: Starting experiment...
    Info: Checking web ui...
    Info: Starting web ui...
    Info: Starting web ui success!
+   Info: Web UI url: http://yourlocalhost:8080   http://youripaddress:8080
+   Info: Start experiment success! The experiment id is LrNK4hae, and the restful server post is 51188.

Documentation

• Get Started

Tutorial

• Tutorial of NNI Python Annotation
• Tutorial of The Command Tool NNICTL

How to

• How to Use Tuner That NNI Supports
• How to Enable Early Stop in Experiment
• How to Run Experiment on Multiple Machine
• How to Run Experiment on OpenPAI
• How to Write Customized Tuner
• How to Write Customized Assessor
• How to Resume Experiment

Contribute

This project welcomes contributions and suggestions, we use GitHub issues for tracking requests and bugs.

Issues with the good first issue label are simple and easy-to-start ones that we recommend new contributors to start with.

License

The entire codebase is under MIT license