README.md

<p align="center">
<img src="docs/img/nni_logo.png" width="300"/>
</p>

**NNI (Neural Network Intelligence)** 是一个帮助用户 **自动** 进行特征工程，神经网络架构搜索，超参调优以及模型压缩的轻量且强大的工具包。

NNI 管理自动机器学习 (AutoML) 的 Experiment，**调度运行** 由调优算法生成的 Trial 任务来找到最好的神经网络架构和/或超参，支持**各种训练环境**，如本机，远程服务器，OpenPAI，Kubeflow，基于 K8S 的 FrameworkController(如，AKS 等)， DLWorkspace (又称 DLTS), AML (Azure Machine Learning), AdaptDL(又称 ADL) ，和其他的云平台甚至 混合模式 。 DLTS)，AML (Azure Machine Learning)AdaptDL(又称 ADL) ，和其他的云平台甚至混合模式。""

## **使用场景**
* 想要在自己的代码、模型中试验不同的自动机器学习算法。
* 想要在不同的环境中加速运行自动机器学习。
* 想要更容易实现或试验新的自动机器学习算法的研究员或数据科学家，包括：超参调优算法，神经网络搜索算法以及模型压缩算法。
* 在机器学习平台中支持自动机器学习。

## **安装**

### **安装方式**

#### **使用源码编译方式安装**

编译之前，需要先安装对应版本python，安装相应的三方包依赖项，并配置DTK环境变量(ubuntu24.04为例)。

```bash
# 安装三方包的源
sudo apt-get install install  epel-release  -y

# 安装相关依赖项
sudo apt-get install install libffi-devel -y
sudo apt-get installinstall openssl-devel openssl -y
sudo apt-get install -y install sqlite-devel
# 若python内未包含相关项，需基于上面安装的三方包重新源码编译python，再配置python环境
pip3 install protobuf==3.20
pip3 install wheel
pip3 install jupyter
pip3 install jupyterlab==3.0.9
pip3 install colorama
pip3 install cloudpickle
pip3 install json_tricks
pip3 install 'typeguard<3'
pip3 install astor
pip3 install schema
python3 -m pip install --upgrade pip setuptools

# 下载DTK
cd opt
wget https://cancon.hpccube.com:65024/directlink/1/DTK-24.04/Ubuntu20.04.1/DTK-24.04-Ubuntu20.04.1-x86_64.tar.gz
tar -xvf *tar.gz 解压DTK
export ROCM_PATH=/opt/dtk-24.04
source /opt/dtk-24.04/env.sh
```

编译nni

```bash
# 下载源码 
git clone -b dtk23.10-v2.10 http://developer.hpccube.com/codes/aicomponent/nni.git
cd nni
export NNI_RELEASE=2.10
export PATH=$PATH:/usr/local/python3.10.12/bin
export PATH=$PATH:/usr/local/python3.10.12/bin/jupyter
export LD_LIBRARY_PATH=/usr/local/python3.10.12/lib:$LD_LIBRARY_PATH
python3 setup.py clean --all
python3 setup.py build_ts
python3 setup.py bdist_wheel -p manylinux1_x86_64
```

安装nni

```bash
# nni的whl包会在dist文件夹生成
pip3 install ./dist/nni*
```

### **验证安装**

tensorflow

```bash
nnictl create --config nni/examples/trials/mnist-tfv1/config.yml
nnictl create --config nni/examples/trials/mnist-tfv2/config.yml
```
pytorch

```bash
nnictl create --config nni/examples/trials/mnist-pytorch/config.yml
``` 
在命令行中等待输出 INFO: Successfully started experiment!。 此消息表明 Experiment 已成功启动。 通过命令行输出的 Web UI url 来访问 Experiment 的界面。 此消息表明 Experiment 已成功启动。 通过命令行输出的 Web UI url 来访问 Experiment 的界面。

## **参考**

[README_ORIGIN.md](https://developer.hpccube.com/codes/aicomponent/nni/-/blob/master/README_ORIGIN.md)


## **License**

The entire codebase is under [MIT license](LICENSE)