Skip to content

Latest commit

 

History

History
373 lines (304 loc) · 18.8 KB

README_zh_CN.md

File metadata and controls

373 lines (304 loc) · 18.8 KB
Raw

MIT 许可证 生成状态 问题 Bug 拉取请求 版本 进入 https://gitter.im/Microsoft/nni 聊天室提问 文档状态

English

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

NNI 管理自动机器学习 (AutoML) 的 Experiment，调度运行由调优算法生成的 Trial 任务来找到最好的神经网络架构和/或超参，支持各种训练环境，如本机，远程服务器，OpenPAI，Kubeflow，基于 K8S 的 FrameworkController（如，AKS 等)，以及其它云服务。

使用场景

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

NNI v1.3 已发布！  

NNI 功能一览

NNI 提供命令行工具以及友好的 WebUI 来管理训练的 Experiment。 通过可扩展的 API，可定制自动机器学习算法和训练平台。 为了方便新用户，NNI 内置了最新的自动机器学习算法，并为流行的训练平台提供了开箱即用的支持。

下表中，包含了 NNI 的功能，同时在不断地增添新功能，也非常希望您能贡献其中。

支持的框架和库 算法 训练平台
内置
  • 支持的框架
    • PyTorch
    • Keras
    • TensorFlow
    • MXNet
    • Caffe2
      • 更多...
  • 支持的库
 超参调优 神经网络架构搜索 模型压缩 特征工程（测试版） 提前终止算法
参考

安装和验证

通过 pip 命令安装

  • 当前支持 Linux，MacOS 和 Windows（本机，远程，OpenPAI 模式），在 Ubuntu 16.04 或更高版本，MacOS 10.14.1 以及 Windows 10.1809 上进行了测试。 在 python >= 3.5 的环境中，只需要运行 pip install 即可完成安装。

Linux 和 macOS

python3 -m pip install --upgrade nni

Windows

python -m pip install --upgrade nni

注意：

  • 如果需要将 NNI 安装到自己的 home 目录中，可使用 --user，这样也不需要任何特殊权限。
  • 目前，Windows 上的 NNI 支持本机，远程和 OpenPAI 模式。 强烈推荐使用 Anaconda 或 Miniconda 在 Windows 上安装 NNI。
  • 如果遇到如Segmentation fault 这样的任何错误请参考常见问题。

通过源代码安装

  • 当前支持 Linux（Ubuntu 16.04 或更高版本），MacOS（10.14.1）以及 Windows 10（1809 版）。

Linux 和 MacOS

  • 在 python >= 3.5 的环境中运行命令： git 和 wget，确保安装了这两个组件。
    git clone -b v1.3 https://github.com/Microsoft/nni.git
    cd nni
    source install.sh

Windows

  • 在 python >=3.5 的环境中运行命令： git 和 PowerShell，确保安装了这两个组件。
  git clone -b v1.3 https://github.com/Microsoft/nni.git
  cd nni
  powershell -ExecutionPolicy Bypass -file install.ps1

参考安装 NNI 了解系统需求。

Windows 上参考 Windows 上使用 NNI。

验证安装

以下示例 Experiment 依赖于 TensorFlow 。 在运行前确保安装了 TensorFlow 1.x。 注意，目前不支持 TensorFlow 2.0。

  • 通过克隆源代码下载示例。
    git clone -b v1.3 https://github.com/Microsoft/nni.git

Linux 和 MacOS

  • 运行 MNIST 示例。
    nnictl create --config nni/examples/trials/mnist-tfv1/config.yml

Windows

  • 运行 MNIST 示例。
    nnictl create --config nni\examples\trials\mnist-tfv1\config_windows.yml
  • 在命令行中等待输出 INFO: Successfully started experiment!。 此消息表明 Experiment 已成功启动。 通过命令行输出的 Web UI url 来访问 Experiment 的界面。
INFO: Starting restful server...
INFO: Successfully started Restful server!
INFO: Setting local config...
INFO: Successfully set local config!
INFO: Starting experiment...
INFO: Successfully started experiment!
-----------------------------------------------------------------------
The experiment id is egchD4qy
The Web UI urls are: http://223.255.255.1:8080   http://127.0.0.1:8080
-----------------------------------------------------------------------

You can use these commands to get more information about the experiment
-----------------------------------------------------------------------
         commands                       description

1. nnictl experiment show        show the information of experiments
2. nnictl trial ls               list all of trial jobs
3. nnictl top                    monitor the status of running experiments
4. nnictl log stderr             show stderr log content
5. nnictl log stdout             show stdout log content
6. nnictl stop                   stop an experiment
7. nnictl trial kill             kill a trial job by id
8. nnictl --help                 get help information about nnictl
-----------------------------------------------------------------------
  • 在浏览器中打开 Web UI url，可看到下图的 Experiment 详细信息，以及所有的 Trial 任务。 查看这里的更多页面。
drawing drawing

文档

贡献

本项目欢迎任何贡献和建议。 大多数贡献都需要你同意参与者许可协议（CLA），来声明你有权，并实际上授予我们有权使用你的贡献。 有关详细信息，请访问 https://cla.microsoft.com。

当你提交拉取请求时，CLA机器人会自动检查你是否需要提供CLA，并修饰这个拉取请求(例如，标签、注释)。 只需要按照机器人提供的说明进行操作即可。 CLA 只需要同意一次，就能应用到所有的代码仓库上。

该项目采用了 Microsoft 开源行为准则 。 有关详细信息，请参阅常见问题解答，如有任何疑问或意见可联系 opencode@microsoft.com。

熟悉贡献协议后，即可按照 NNI 开发人员教程，创建第一个 PR =)：

其它代码库和参考

经作者许可的一些 NNI 用法示例和相关文档。

反馈

相关项目

以探索先进技术和开放为目标，Microsoft Research (MSR) 还发布了一些相关的开源项目。

  • OpenPAI：作为开源平台，提供了完整的 AI 模型训练和资源管理能力，能轻松扩展，并支持各种规模的私有部署、云和混合环境。
  • FrameworkController：开源的通用 Kubernetes Pod 控制器，通过单个控制器来编排 Kubernetes 上所有类型的应用。
  • MMdnn：一个完整、跨框架的解决方案，能够转换、可视化、诊断深度神经网络模型。 MMdnn 中的 "MM" 表示 model management（模型管理），而 "dnn" 是 deep neural network（深度神经网络）的缩写。
  • SPTAG : Space Partition Tree And Graph (SPTAG) 是用于大规模向量的最近邻搜索场景的开源库。

我们鼓励研究人员和学生利用这些项目来加速 AI 开发和研究。

许可协议

代码库遵循 MIT 许可协议