Skip to content

Latest commit

 

History

History
469 lines (293 loc) · 11.4 KB

NNICTLDOC.md

File metadata and controls

469 lines (293 loc) · 11.4 KB

nnictl

介绍

nnictl 是一个命令行工具，用来控制 NNI Experiment，如启动、停止、继续 Experiment，启动、停止 NNIBoard 等等。

命令

nnictl 支持的命令：

管理 Experiment

  • nnictl create

    • 说明

      此命令使用参数中的配置文件，来创建新的 Experiment。

      此命令成功完成后，上下文会被设置为此 Experiment。这意味着如果不显式改变上下文（暂不支持），输入的以下命令，都作用于此 Experiment。

    • 用法

      nnictl create [OPTIONS]

    • 选项

    参数及缩写 是否必需 默认值 说明
    --config, -c True Experiment 的 YAML 配置文件
    --port, -p False RESTful 服务的端口

  • nnictl resume

    • 说明

      使用此命令恢复已停止的 Experiment。

    • 用法

      nnictl resume [OPTIONS]

    • 选项

    参数及缩写 是否必需 默认值 说明
    id False 要恢复的 Experiment 标识
    --port, -p False 要恢复的 Experiment 使用的 RESTful 服务端口

  • nnictl stop

    • 说明

      使用此命令来停止正在运行的单个或多个 Experiment。

    • 用法

      nnictl stop [id]

    • 详细说明

      1. 如果指定了 id，并且此 id 匹配正在运行的 Experiment，nnictl 会停止相应的 Experiment，否则会输出错误信息。
      2. 如果没有指定 id，并且当前有运行的 Experiment，则会停止该 Experiment，否则会输出错误信息。
      3. 如果 id 以 * 结尾，nnictl 会停止所有匹配此通配符的 Experiment。
      4. 如果 id 不存在，但匹配了某个Experiment 的 id 前缀，nnictl 会停止匹配的Experiment 。
      5. 如果 id 不存在，但匹配多个 Experiment id 的前缀，nnictl 会输出这些 id 的信息。
      6. 可使用 'nnictl stop all' 来停止所有的 Experiment。

  • nnictl update

    • nnictl update searchspace

      • 说明

        可以用此命令来更新 Experiment 的搜索空间。

      • 用法

        nnictl update searchspace [OPTIONS]

      • 选项

    参数及缩写 是否必需 默认值 说明
    id False 需要设置的 Experiment 的 id
    --filename, -f True 新的搜索空间文件名

    • nnictl update concurrency

      • 说明

        可以用此命令来更新 Experiment 的并发设置。

      • 用法

        nnictl update concurrency [OPTIONS]

      • 选项

    参数及缩写 是否必需 默认值 说明
    id False 需要设置的 Experiment 的 id
    --value, -v True 允许同时运行的 Trial 的数量

    • nnictl update duration

      • 说明

        可以用此命令来更新 Experiment 的运行时间。

      • 用法

        nnictl update duration [OPTIONS]

      • 选项 | 参数及缩写 | 是否必需 | 默认值 | 说明 | | ----------- | ----- | --- | ----------------------------------------------------------------------- | | id | False | | 需要设置的 Experiment 的 id | | --value, -v | True | | Experiment 持续时间如没有单位，则为秒。 后缀可以为 's' 即秒 (默认值), 'm' 即分钟, 'h' 即小时或 'd' 即天。 |

    • nnictl update trialnum

      • 说明

        可以用此命令来更新 Experiment 的最大 Trial 数量。

      • 用法

        nnictl update trialnum [OPTIONS]

      • 选项

    参数及缩写 是否必需 默认值 说明
    id False 需要设置的 Experiment 的 id
    --value, -v True 需要设置的 maxtrialnum 的数量

  • nnictl trial

    • nnictl trial ls

      • 说明

        使用此命令来查看 Trial 的信息。

      • 用法

        nnictl trial ls

      • 选项

    参数及缩写 是否必需 默认值 说明
    id False 需要设置的 Experiment 的 id

    • nnictl trial kill

      • 说明

        此命令用于终止 Trial。

      • 用法

        nnictl trial kill [OPTIONS]

      • 选项

    参数及缩写 是否必需 默认值 说明
    id False 需要设置的 Experiment 的 id
    --trialid, -t True 需要终止的 Trial 的 id。

  • nnictl top

    • 说明

      查看正在运行的 Experiment。

    • 用法

      nnictl top

    • 选项

    参数及缩写 是否必需 默认值 说明
    id False 需要设置的 Experiment 的 id
    --time, -t False 刷新 Experiment 状态的时间间隔，单位为秒，默认值为 3 秒。

管理 Experiment 信息

  • nnictl experiment show

    • 说明

      显示 Experiment 的信息。

    • 用法

      nnictl experiment show

    • 选项

    参数及缩写 是否必需 默认值 说明
    id False 需要设置的 Experiment 的 id

  • nnictl experiment status

    • 说明

      显示 Experiment 的状态。

    • 用法

      nnictl experiment status

    • 选项

    参数及缩写 是否必需 默认值 说明
    id False 需要设置的 Experiment 的 id

  • nnictl experiment list

    • 说明

      显示正在运行的 Experiment 的信息

    • 用法

      nnictl experiment list

  • nnictl config show

    • 说明

      显示当前上下文信息。

    • 用法

      nnictl config show

管理日志

  • nnictl log stdout

    • 说明

      显示 stdout 日志内容。

    • 用法

      nnictl log stdout [options]

    • 选项

    参数及缩写 是否必需 默认值 说明
    id False 需要设置的 Experiment 的 id
    --head, -h False 显示 stdout 开始的若干行
    --tail, -t False 显示 stdout 结尾的若干行
    --path, -p False 显示 stdout 文件的路径

  • nnictl log stderr

    • 说明

      显示 stderr 日志内容。

    • 用法

      nnictl log stderr [options]

    • 选项

    参数及缩写 是否必需 默认值 说明
    id False 需要设置的 Experiment 的 id
    --head, -h False 显示 stderr 开始的若干行
    --tail, -t False 显示 stderr 结尾的若干行
    --path, -p False 显示 stderr 文件的路径

  • nnictl log trial

    • 说明

      显示 Trial 日志的路径。

    • 用法

      nnictl log trial [options]

    • 选项

    参数及缩写 是否必需 默认值 说明
    id False Trial 的 id

管理网页

  • nnictl webui url

管理 tensorboard

  • nnictl tensorboard start

    • 说明

      启动 tensorboard 进程。

    • 用法

      nnictl tensorboard start

    • 选项

    参数及缩写 是否必需 默认值 说明
    id False 需要设置的 Experiment 的 id
    --trialid False Trial 的 id
    --port False 6006 tensorboard 进程的端口

    • 详细说明

      1. NNICTL 当前仅支持本机和远程平台的 tensorboard，其它平台暂不支持。
      2. 如果要使用 tensorboard，需要将 tensorboard 日志输出到环境变量 [NNI_OUTPUT_DIR] 路径下。
      3. 在 local 模式中，nnictl 会直接设置 --logdir=[NNI_OUTPUT_DIR] 并启动 tensorboard 进程。
      4. 在 remote 模式中，nnictl 会创建一个 ssh 客户端来将日志数据从远程计算机复制到本机临时目录中，然后在本机开始 tensorboard 进程。 需要注意的是，nnictl 只在使用此命令时复制日志数据，如果要查看最新的 tensorboard 结果，需要再次执行 nnictl tensorboard 命令。
      5. 如果只有一个 Trial 任务，不需要设置 trialid。 如果有多个运行的 Trial 作业，需要设置 trialid，或使用 [nnictl tensorboard start --trialid all] 来将 --logdir 映射到所有 Trial 的路径。

  • nnictl tensorboard stop

    • 说明

      停止所有 tensorboard 进程。

    • 用法

      nnictl tensorboard stop

    • 选项

    参数及缩写 是否必需 默认值 说明
    id False 需要设置的实验的 id

管理安装包

  • nnictl package install

    • 说明

      安装 NNI 实验所需要的包。

    • 用法

      nnictl package install [OPTIONS]

    • 选项

    参数及缩写 是否必需 默认值 说明
    --name True 要安装的包名称

  • nnictl package show

    • 说明

      列出支持的安装包

    • 用法

      nnictl package show

检查 NNI 版本

  • nnictl --version

    • 说明

      显示当前安装的 NNI 的版本。

    • 用法

      nnictl --version