Skip to content

Latest commit

 

History

History
341 lines (284 loc) · 18.4 KB

README_zh_CN.md

File metadata and controls

341 lines (284 loc) · 18.4 KB
Raw

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

NNI 文档 | English

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

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

使用场景

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

最新消息！  

NNI 功能一览

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

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

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

安装

安装

NNI 支持并在 Ubuntu >= 16.04, macOS >= 10.14.1, 和 Windows 10 >= 1809 通过了测试。 在 python 64-bit >= 3.6 的环境中，只需要运行 pip install 即可完成安装。

Linux 或 macOS

python3 -m pip install --upgrade nni

Windows

python -m pip install --upgrade nni

如果想试试最新代码，可参考从源代码安装 NNI。

Linux 和 macOS 下 NNI 系统需求参考这里 ，Windows 参考这里。

注意：

  • 如果遇到任何权限问题，可添加 --user 在用户目录中安装 NNI。
  • 目前，Windows 上的 NNI 支持本机，远程和 OpenPAI 模式。 强烈推荐使用 Anaconda 或 Miniconda 在 Windows 上安装 NNI。
  • 如果遇到如 Segmentation fault 等错误参考常见问题。 Windows 上的 FAQ 参考在 Windows 上使用 NNI。

验证安装

  • 通过克隆源代码下载示例。

    git clone -b v2.0 https://github.com/Microsoft/nni.git

  • 运行 MNIST 示例。

    Linux 或 macOS

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

    Windows

    nnictl create --config nni\examples\trials\mnist-pytorch\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

发布和贡献

NNI 有一个月度发布周期（主要发布）。 如果您遇到问题可以通过 创建 issue 来报告。

我们感谢所有的贡献。 如果您计划提供任何 Bug 修复，请放手去做，不需要任何顾虑。

如果您计划提供新的功能、新的 Tuner 和 新的训练平台等， 请先创建一个新的 issue 或重用现有 issue，并与我们讨论该功能。 我们会及时与您讨论这个问题，如有需要会安排电话会议。

如果需要了解更多如何贡献的信息，请参考 如何贡献页面。

再次感谢所有的贡献者！

反馈

加入聊天组：

Gitter 微信
图片 或 image

相关项目

以探索先进技术和开放为目标，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 许可协议