Skip to content

Latest commit

 

History

History
169 lines (114 loc) · 7.05 KB

Trials.md

File metadata and controls

169 lines (114 loc) · 7.05 KB

实现 NNI 的 Trial(尝试)代码

**Trial(尝试)**是将一组参数组合(例如,超参)在模型上独立的一次尝试。

定义 NNI 的 Trial,需要首先定义参数组,并更新模型代码。 NNI 有两种方法来实现 Trial:NNI API 以及 NNI Python annotation。 参考这里的更多 Trial 样例。

NNI API

第一步:准备搜索空间参数文件。

样例如下:

{
    "dropout_rate":{"_type":"uniform","_value":[0.1,0.5]},
    "conv_size":{"_type":"choice","_value":[2,3,5,7]},
    "hidden_size":{"_type":"choice","_value":[124, 512, 1024]},
    "learning_rate":{"_type":"uniform","_value":[0.0001, 0.1]}
}

参考 SearchSpaceSpec.md 进一步了解搜索空间。 Tuner 会根据搜索空间来生成配置,即从每个超参的范围中选一个值。

第二步:更新模型代码

  • Import NNI

    在 Trial 代码中加上 import nni

  • 从 Tuner 获得参数值

RECEIVED_PARAMS = nni.get_next_parameter()

RECEIVED_PARAMS 是一个对象,如: {"conv_size": 2, "hidden_size": 124, "learning_rate": 0.0307, "dropout_rate": 0.2029}.

  • 定期返回指标数据(可选)
nni.report_intermediate_result(metrics)

指标可以是任意的 Python 对象。 如果使用了 NNI 内置的 Tuner/Assessor,指标只可以是两种类型:1) 数值类型,如 float、int, 2) dict 对象,其中必须由键名为 default,值为数值的项目。 指标会发送给Assessor。 通常,指标是损失值或精度。

  • 返回配置的最终性能
nni.report_final_result(metrics)

指标也可以是任意的 Python 对象。 如果使用了内置的 Tuner/Assessor,指标格式和 report_intermediate_result 中一样,这个数值表示模型的性能,如精度、损失值等。 指标会发送给 Tuner

第三步:启用 NNI API

要启用 NNI 的 API 模式,需要将 useAnnotation 设置为 false,并提供搜索空间文件的路径(即第一步中定义的文件):

useAnnotation: false
searchSpacePath: /path/to/your/search_space.json

参考 这里 进一步了解如何配置实验。

  • 参考这里,了解更多 NNI API (例如 nni.get_sequence_id())。

NNI Annotation

另一种实现 Trial 的方法是使用 Python 注释来标记 NNI。 就像其它 Python Annotation,NNI 的 Annotation 和代码中的注释一样。 不需要在代码中做大量改动。 只需要添加一些 NNI Annotation,就能够:

  • 标记需要调整的参数变量
  • 指定变量的搜索空间范围
  • 标记哪个变量需要作为中间结果范围给 Assessor
  • 标记哪个变量需要作为最终结果(例如:模型精度)返回给 Tuner

同样以 MNIST 为例,只需要两步就能用 NNI Annotation 来实现 Trial 代码。

第一步:在代码中加入 Annotation

下面是加入了 Annotation 的 TensorFlow 代码片段,高亮的 4 行 Annotation 用于:

  1. 调优 batch_size 和 dropout_rate
  2. 每执行 100 步返回 test_acc
  3. 最后返回 test_acc 作为最终结果。

新添加的代码都是注释,不会影响以前的执行逻辑。因此这些代码仍然能在没有安装 NNI 的环境中运行。

with tf.Session() as sess:
    sess.run(tf.global_variables_initializer())
+   """@nni.variable(nni.choice(50, 250, 500), name=batch_size)"""
    batch_size = 128
    for i in range(10000):
        batch = mnist.train.next_batch(batch_size)
+       """@nni.variable(nni.choice(0.1, 0.5), name=dropout_rate)"""
        dropout_rate = 0.5
        mnist_network.train_step.run(feed_dict={mnist_network.images: batch[0],
                                                mnist_network.labels: batch[1],
                                                mnist_network.keep_prob: dropout_rate})
        if i % 100 == 0:
            test_acc = mnist_network.accuracy.eval(
                feed_dict={mnist_network.images: mnist.test.images,
                            mnist_network.labels: mnist.test.labels,
                            mnist_network.keep_prob: 1.0})
+           """@nni.report_intermediate_result(test_acc)"""

    test_acc = mnist_network.accuracy.eval(
        feed_dict={mnist_network.images: mnist.test.images,
                    mnist_network.labels: mnist.test.labels,
                    mnist_network.keep_prob: 1.0})

+   """@nni.report_final_result(test_acc)"""

注意

  • @nni.variable 会对它的下面一行进行修改,左边被赋值变量必须在 @nni.variablename 参数中指定。
  • @nni.report_intermediate_result/@nni.report_final_result 会将数据发送给 Assessor、Tuner。

Annotation 的语法和用法等,参考 Annotation

第二步:启用 Annotation

在 YAML 配置文件中设置 useAnnotation 为 true 来启用 Annotation:

useAnnotation: true

Trial 存放在什么地方?

本机模式

每个 Trial 都有单独的目录来输出自己的数据。 在每次 Trial 运行后,环境变量 NNI_OUTPUT_DIR 定义的目录都会被导出。 在这个目录中可以看到 Trial 的代码、数据和日志。 此外,Trial 的日志(包括 stdout)还会被重定向到此目录中的 trial.log 文件。

如果使用了 Annotation 方法,转换后的 Trial 代码会存放在另一个临时目录中。 可以在 run.sh 文件中的 NNI_OUTPUT_DIR 变量找到此目录。 文件中的第二行(即:cd)会切换到代码所在的实际路径。 参考 run.sh 文件样例:

#!/bin/bash
cd /tmp/user_name/nni/annotation/tmpzj0h72x6 #This is the actual directory
export NNI_PLATFORM=local
export NNI_SYS_DIR=/home/user_name/nni/experiments/$experiment_id$/trials/$trial_id$
export NNI_TRIAL_JOB_ID=nrbb2
export NNI_OUTPUT_DIR=/home/user_name/nni/experiments/$eperiment_id$/trials/$trial_id$
export NNI_TRIAL_SEQ_ID=1
export MULTI_PHASE=false
export CUDA_VISIBLE_DEVICES=
eval python3 mnist.py 2>/home/user_name/nni/experiments/$experiment_id$/trials/$trial_id$/stderr
echo $? `date +%s000` >/home/user_name/nni/experiments/$experiment_id$/trials/$trial_id$/.nni/state

其它模式

当 Trial 运行在 OpenPAI 这样的远程服务器上时,NNI_OUTPUT_DIR 仅会指向 Trial 的输出目录,而 run.sh 不会在此目录中。 trial.log 文件会被复制回本机的 Trial 目录中。目录的默认位置在 ~/nni/experiments/$experiment_id$/trials/$trial_id$/

详细信息,可参考调试指南

更多 Trial 的样例