GitHub 源码知乎专栏

标准化接口参数详情-训练

查 job模板/训练pipeline/task/调度实例/workflow/超参搜索六个模型字段（资源 cpu/gpu/内存校验、调度类型、报警状态等）时读这篇

06-二次开发 / API参考 / 标准化接口参数详情
job模板job_templatepipelinetask任务流runhistory定时调度workflownni超参搜索资源配置

训练 参数详情

字段「默认值/必填/可选值」为后端表单（add/edit_form_extra_fields）静态快照，运行时可能随用户、配置或 _info 接口动态变化，联调时以 $view/api/_info 返回为准。通用调用约定见 README 与 标准化接口。

job模板管理

/job_template_modelview/api，表名：job_template，视图：Job_Template_ModelView_Api，模型：Job_Template。

源码：myapp/views/view_job_template.py，myapp/models/model_job.py。

新增参数

参数 名称 类型 必填 默认值 唯一 说明 校验/可选值
project project relation 否 否 项目组id
images images relation 否 否 镜像id
name 名称 string 是 是 英文名(小写字母、数字、- 组成)，最长50个字符 Regexp('^[a-z][a-z0-9\-]*[a-z0-9]$'); Length(1, 54)
version 版本 string(enum) 否 否 job模板的版本，release版本的模板才能被所有用户看到 choices=version_list
describe 描述 string 是 否 模板的描述将直接显示在pipeline编排界面 DataRequired()
workdir 工作目录 string 否 否 工作目录，不填写将直接使用镜像默认的工作目录 Regexp('^[\x00-\x7f]*$')
entrypoint 启动命令 string 是 否 镜像的入口命令，直接写成单行字符串，例如python xx.py，无需添加[] DataRequired(); Regexp('^[\x00-\x7f]*$')
volume_mount 挂载 string 否 否 使用该模板的task，会在添加时，自动添加该挂载。格式示例:；$pvc_name1(pvc):/$container_path1,$hostpath1(hostpath):/$container_path2；注意pvc会自动挂载对应目录下的个人username子目录 Regexp('^[\x00-\x7f]*$')
args args string 否 否 启动参数
env 环境变量 string 否 否 使用模板的task自动添加的环境变量，支持模板变量。；书写格式:每行一个环境变量env_key=env_value
hostAliases 域名解析 string 否 否 添加到容器内的host映射。；书写格式:每行一个dns解析记录，ip host1 host2，；示例：1.1.1.1 example1.oa.com example2.oa.com Regexp('^[\x00-\x7f]*$')
privileged 超级权限 boolean 否 False 否 是否启动超级权限
accounts k8s账号 string 否 否 k8s的ServiceAccount，在此类任务运行时会自动挂载此账号，多用于任务操作k8s pod时使用 Regexp('^[a-z][a-z0-9\-]*[a-z0-9]$'); Length(0, 54)
expand 扩展 string 否 json.dumps({'index': 0, 'help_url': conf.get('DOCUMENTATI... 否 json格式的扩展字段，支持； "index":"$模板展示顺序号"，；"help_url":"$帮助文档地址"，；"HostNetwork":true 启动主机端口监听

修改参数

参数 名称 类型 必填 默认值 唯一 说明 校验/可选值
project project relation 否 否 项目组id
images images relation 否 否 镜像id
name 名称 string 是 是 英文名(小写字母、数字、- 组成)，最长50个字符 Regexp('^[a-z][a-z0-9\-]*[a-z0-9]$'); Length(1, 54)
version 版本 string(enum) 否 否 job模板的版本，release版本的模板才能被所有用户看到 choices=version_list
describe 描述 string 是 否 模板的描述将直接显示在pipeline编排界面 DataRequired()
workdir 工作目录 string 否 否 工作目录，不填写将直接使用镜像默认的工作目录 Regexp('^[\x00-\x7f]*$')
entrypoint 启动命令 string 是 否 镜像的入口命令，直接写成单行字符串，例如python xx.py，无需添加[] DataRequired(); Regexp('^[\x00-\x7f]*$')
volume_mount 挂载 string 否 否 使用该模板的task，会在添加时，自动添加该挂载。格式示例:；$pvc_name1(pvc):/$container_path1,$hostpath1(hostpath):/$container_path2；注意pvc会自动挂载对应目录下的个人username子目录 Regexp('^[\x00-\x7f]*$')
args args string 否 否 启动参数
env 环境变量 string 否 否 使用模板的task自动添加的环境变量，支持模板变量。；书写格式:每行一个环境变量env_key=env_value
hostAliases 域名解析 string 否 否 添加到容器内的host映射。；书写格式:每行一个dns解析记录，ip host1 host2，；示例：1.1.1.1 example1.oa.com example2.oa.com Regexp('^[\x00-\x7f]*$')
privileged 超级权限 boolean 否 False 否 是否启动超级权限
accounts k8s账号 string 否 否 k8s的ServiceAccount，在此类任务运行时会自动挂载此账号，多用于任务操作k8s pod时使用 Regexp('^[a-z][a-z0-9\-]*[a-z0-9]$'); Length(0, 54)
expand 扩展 string 否 json.dumps({'index': 0, 'help_url': conf.get('DOCUMENTATI... 否 json格式的扩展字段，支持； "index":"$模板展示顺序号"，；"help_url":"$帮助文档地址"，；"HostNetwork":true 启动主机端口监听

查看参数

参数 名称 类型 必填 默认值 唯一 说明 校验/可选值
project project relation 否 否 项目组id
name 名称 string 是 是 英文名(小写字母、数字、- 组成)，最长50个字符 Regexp('^[a-z][a-z0-9\-]*[a-z0-9]$'); Length(1, 54)
version 版本 string(enum) 否 否 job模板的版本，release版本的模板才能被所有用户看到 choices=version_list
describe 描述 string 是 否 模板的描述将直接显示在pipeline编排界面 DataRequired()
images images relation 否 否 镜像id
workdir 工作目录 string 否 否 工作目录，不填写将直接使用镜像默认的工作目录 Regexp('^[\x00-\x7f]*$')
entrypoint 启动命令 string 是 否 镜像的入口命令，直接写成单行字符串，例如python xx.py，无需添加[] DataRequired(); Regexp('^[\x00-\x7f]*$')
args args string 否 否 启动参数
demo demo string 否 否 填写demo
env 环境变量 string 否 否 使用模板的task自动添加的环境变量，支持模板变量。；书写格式:每行一个环境变量env_key=env_value
hostAliases 域名解析 string 否 否 添加到容器内的host映射。；书写格式:每行一个dns解析记录，ip host1 host2，；示例：1.1.1.1 example1.oa.com example2.oa.com Regexp('^[\x00-\x7f]*$')
privileged 超级权限 boolean 否 False 否 是否启动超级权限
expand 扩展 string 否 json.dumps({'index': 0, 'help_url': conf.get('DOCUMENTATI... 否 json格式的扩展字段，支持； "index":"$模板展示顺序号"，；"help_url":"$帮助文档地址"，；"HostNetwork":true 启动主机端口监听

训练pipeline管理

/pipeline_modelview/api，表名：pipeline，视图：Pipeline_ModelView_Api，模型：Pipeline。

源码：myapp/views/view_pipeline.py，myapp/models/model_job.py。

新增参数

参数 名称 类型 必填 默认值 唯一 说明 校验/可选值
project 项目组 relation 是 否 项目组id
name 名称 string 是 是 英文名(小写字母、数字、- 组成)，最长50个字符 Regexp('^[a-z][a-z0-9\-]*[a-z0-9]$'); Length(1, 54); DataRequired()
describe 描述 string 是 否 描述 DataRequired()

修改参数

参数 名称 类型 必填 默认值 唯一 说明 校验/可选值
project 项目组 relation 是 否 项目组id
name 名称 string 是 是 英文名(小写字母、数字、- 组成)，最长50个字符 Regexp('^[a-z][a-z0-9\-]*[a-z0-9]$'); Length(1, 54); DataRequired()
describe 描述 string 是 否 描述 DataRequired()
priority 优先级 string(enum) 否 high 否 调度优先级，同项目组，在资源不足情况下，低优先级会主动释放资源给高优先级任务流 choices=[['high', 'high'], ['low', 'low']]
schedule_type 调度类型 string(enum) 否 once 否 调度类型，once仅运行一次，crontab周期运行，crontab配置保存一个小时候后才生效 choices=[['once', 'once'], ['crontab', 'crontab']]
cron_time 调度周期 string 否 否 周期任务的时间设定 * * * * * 表示为 minute hour day month week
cronjob_start_time cronjob_start_time string 否 否 定时调度补录起点
depends_on_past 过往依赖 boolean 否 True 否 任务运行是否依赖上一次的示例状态
max_active_runs 最大激活数 integer 是 1 否 当前pipeline可同时运行的任务流实例数目 DataRequired()
expired_limit 过期保留数 integer 是 1 否 定时调度最新实例限制数目，0表示不限制 DataRequired()
parallelism 并发数 integer 是 3 否 一个任务流实例中可同时运行的task数目 DataRequired()
global_env 全局环境变量 string 否 否 公共环境变量会以环境变量的形式传递给每个task，可以配置多个公共环境变量，每行一个，支持datetime/creator/runner/uuid/pipeline_id等变量 例如：USERNAME={{creator}}
alert_status alert_status array 否 Pending,Running,Succeeded,Failed,Terminated 否 选择通知状态 Length(0, 400); choices=[[x, x] for x in ['Created', 'Pending', 'Running', 'Succeeded', 'Failed', 'Unknown', 'Waiting', 'Terminated']]
alert_user alert_user string 否 否 选择通知用户，每个用户使用逗号分隔
dag_json 上下游关系 string 否 {} 否 任务的上下游关系，目前不需要手动修改
expand 前端扩展 string 否 {} 否 前端扩展参数，前端用于记录任务流节点位置和连线关系
parameter 后端扩展 string 否 {} 否 后端扩展参数，用于配置是否为demo或固化任务流

查看参数

参数 名称 类型 必填 默认值 唯一 说明 校验/可选值
project 项目组 relation 是 否 项目组id
name 名称 string 是 是 英文名(小写字母、数字、- 组成)，最长50个字符 Regexp('^[a-z][a-z0-9\-]*[a-z0-9]$'); Length(1, 54); DataRequired()
describe 描述 string 是 否 描述 DataRequired()
priority 优先级 string(enum) 否 high 否 调度优先级，同项目组，在资源不足情况下，低优先级会主动释放资源给高优先级任务流 choices=[['high', 'high'], ['low', 'low']]
schedule_type 调度类型 string(enum) 否 once 否 调度类型，once仅运行一次，crontab周期运行，crontab配置保存一个小时候后才生效 choices=[['once', 'once'], ['crontab', 'crontab']]
cron_time 调度周期 string 否 否 周期任务的时间设定 * * * * * 表示为 minute hour day month week
depends_on_past 过往依赖 boolean 否 True 否 任务运行是否依赖上一次的示例状态
max_active_runs 最大激活数 integer 是 1 否 当前pipeline可同时运行的任务流实例数目 DataRequired()
expired_limit 过期保留数 integer 是 1 否 定时调度最新实例限制数目，0表示不限制 DataRequired()
parallelism 并发数 integer 是 3 否 一个任务流实例中可同时运行的task数目 DataRequired()
global_env 全局环境变量 string 否 否 公共环境变量会以环境变量的形式传递给每个task，可以配置多个公共环境变量，每行一个，支持datetime/creator/runner/uuid/pipeline_id等变量 例如：USERNAME={{creator}}
dag_json 上下游关系 string 否 {} 否 任务的上下游关系，目前不需要手动修改
pipeline_file pipeline_file string 否 否 workflow yaml文件
pipeline_argo_id pipeline_argo_id string 否 否 argo workflow id
run_id run_id string 否 否 workflow run id
created_by created_by computed 否 否
changed_by changed_by computed 否 否
created_on created_on computed 否 否
changed_on changed_on computed 否 否
expand 前端扩展 string 否 {} 否 前端扩展参数，前端用于记录任务流节点位置和连线关系
parameter 后端扩展 string 否 {} 否 后端扩展参数，用于配置是否为demo或固化任务流
alert_status alert_status array 否 Pending,Running,Succeeded,Failed,Terminated 否 选择通知状态 Length(0, 400); choices=[[x, x] for x in ['Created', 'Pending', 'Running', 'Succeeded', 'Failed', 'Unknown', 'Waiting', 'Terminated']]
alert_user alert_user string 否 否 选择通知用户，每个用户使用逗号分隔
cronjob_start_time cronjob_start_time string 否 否 定时调度补录起点

训练task管理

/task_modelview/api，表名：task，视图：Task_ModelView_Api，模型：Task。

源码：myapp/views/view_task.py，myapp/models/model_job.py。

新增参数

参数 名称 类型 必填 默认值 唯一 说明 校验/可选值
name name string 是 否 英文名(小写字母、数字、- 组成)，最长50个字符 Regexp('^[a-z][a-z0-9\-]*[a-z0-9]$'); Length(1, 54); DataRequired()
label label string 是 否 中文名 DataRequired()
job_template 任务模板 relation 否 否 任务模板id
pipeline 任务流 relation 否 否 任务流id
working_dir working_dir string 否 否 工作目录，容器启动的初始所在目录，不填默认使用Dockerfile内定义的工作目录
command command string 否 否 启动命令
args 启动参数 string 否 否 任务启动参数
volume_mount volume_mount string 否 kubeflow-user-workspace(pvc):/mnt 否 外部挂载，格式:；$pvc_name1(pvc):/$container_path1,$hostpath1(hostpath):/$container_path2；注意pvc会自动挂载对应目录下的个人username子目录 Regexp('^[\x00-\x7f]*$')
node_selector node_selector string 否 模型默认值，见 _info 接口 否 运行当前task所在的机器
resource_memory resource_memory string 是 模型默认值，见 _info 接口 否 内存的资源使用配置，示例1G，10G， 最大100G，如需更多联系管理员 DataRequired(); Regexp('^[0-9]*G$')
resource_cpu resource_cpu string 是 模型默认值，见 _info 接口 否 cpu的资源使用配置(单位核)，示例 0.4，10，最大50核，如需更多联系管理员 DataRequired(); Regexp('^[0-9]*$')
resource_gpu gpu string 是 0 否 gpu的资源使用配置(单位卡)，示例:1，2，训练任务每个容器独占整卡。申请具体的卡型号，可以类似 1(V100) DataRequired(); Regexp('^[\-\.0-9,a-zA-Z\(\)]*$')
resource_rdma rdma string 否 0 否 RDMA的资源使用配置，示例 0，1，10，填写方式咨询管理员
timeout timeout integer 否 模型默认值，见 _info 接口 否 task运行时长限制，为0表示不限制(单位s)
retry retry integer 否 模型默认值，见 _info 接口 否 task重试次数
skip skip boolean 否 False 否 是否跳过
expand expand string 否 否 扩展参数

修改参数

参数 名称 类型 必填 默认值 唯一 说明 校验/可选值
name name string 是 否 英文名(小写字母、数字、- 组成)，最长50个字符 Regexp('^[a-z][a-z0-9\-]*[a-z0-9]$'); Length(1, 54); DataRequired()
label label string 是 否 中文名 DataRequired()
working_dir working_dir string 否 否 工作目录，容器启动的初始所在目录，不填默认使用Dockerfile内定义的工作目录
command command string 否 否 启动命令
args 启动参数 string 否 否 任务启动参数
volume_mount volume_mount string 否 kubeflow-user-workspace(pvc):/mnt 否 外部挂载，格式:；$pvc_name1(pvc):/$container_path1,$hostpath1(hostpath):/$container_path2；注意pvc会自动挂载对应目录下的个人username子目录 Regexp('^[\x00-\x7f]*$')
resource_memory resource_memory string 是 模型默认值，见 _info 接口 否 内存的资源使用配置，示例1G，10G， 最大100G，如需更多联系管理员 DataRequired(); Regexp('^[0-9]*G$')
resource_cpu resource_cpu string 是 模型默认值，见 _info 接口 否 cpu的资源使用配置(单位核)，示例 0.4，10，最大50核，如需更多联系管理员 DataRequired(); Regexp('^[0-9]*$')
resource_gpu gpu string 是 0 否 gpu的资源使用配置(单位卡)，示例:1，2，训练任务每个容器独占整卡。申请具体的卡型号，可以类似 1(V100) DataRequired(); Regexp('^[\-\.0-9,a-zA-Z\(\)]*$')
resource_rdma rdma string 否 0 否 RDMA的资源使用配置，示例 0，1，10，填写方式咨询管理员
timeout timeout integer 否 模型默认值，见 _info 接口 否 task运行时长限制，为0表示不限制(单位s)
retry retry integer 否 模型默认值，见 _info 接口 否 task重试次数
skip skip boolean 否 False 否 是否跳过
expand expand string 否 否 扩展参数

查看参数

参数 名称 类型 必填 默认值 唯一 说明 校验/可选值
name name string 是 否 英文名(小写字母、数字、- 组成)，最长50个字符 Regexp('^[a-z][a-z0-9\-]*[a-z0-9]$'); Length(1, 54); DataRequired()
label label string 是 否 中文名 DataRequired()
pipeline 任务流 relation 否 否 任务流id
job_template 任务模板 relation 否 否 任务模板id
volume_mount volume_mount string 否 kubeflow-user-workspace(pvc):/mnt 否 外部挂载，格式:；$pvc_name1(pvc):/$container_path1,$hostpath1(hostpath):/$container_path2；注意pvc会自动挂载对应目录下的个人username子目录 Regexp('^[\x00-\x7f]*$')
node_selector node_selector string 否 模型默认值，见 _info 接口 否 运行当前task所在的机器
command command string 否 否 启动命令
overwrite_entrypoint overwrite_entrypoint boolean 否 False 否 启动命令是否覆盖Dockerfile中ENTRYPOINT，不覆盖则叠加。
working_dir working_dir string 否 否 工作目录，容器启动的初始所在目录，不填默认使用Dockerfile内定义的工作目录
args 启动参数 string 否 否 任务启动参数
resource_memory resource_memory string 是 模型默认值，见 _info 接口 否 内存的资源使用配置，示例1G，10G， 最大100G，如需更多联系管理员 DataRequired(); Regexp('^[0-9]*G$')
resource_cpu resource_cpu string 是 模型默认值，见 _info 接口 否 cpu的资源使用配置(单位核)，示例 0.4，10，最大50核，如需更多联系管理员 DataRequired(); Regexp('^[0-9]*$')
resource_gpu gpu string 是 0 否 gpu的资源使用配置(单位卡)，示例:1，2，训练任务每个容器独占整卡。申请具体的卡型号，可以类似 1(V100) DataRequired(); Regexp('^[\-\.0-9,a-zA-Z\(\)]*$')
resource_rdma rdma string 否 0 否 RDMA的资源使用配置，示例 0，1，10，填写方式咨询管理员
timeout timeout integer 否 模型默认值，见 _info 接口 否 task运行时长限制，为0表示不限制(单位s)
retry retry integer 否 模型默认值，见 _info 接口 否 task重试次数
skip skip boolean 否 False 否 是否跳过
created_by created_by computed 否 否
changed_by changed_by computed 否 否
created_on created_on computed 否 否
changed_on changed_on computed 否 否
monitoring monitoring string 否 {} 否 该任务的监控信息
expand expand string 否 否 扩展参数

定时调度实例管理

/runhistory_modelview/api，表名：runhistory，视图：RunHistory_ModelView_Api，模型：RunHistory。

源码：myapp/views/view_runhistory.py，myapp/models/model_job.py。

新增参数

无。

修改参数

参数 名称 类型 必填 默认值 唯一 说明 校验/可选值
status 状态 string(enum) 否 comed 否 状态comed为已识别未提交，created为已提交 choices=[['comed', 'comed'], ['created', 'created']]

查看参数

无。

workflow管理

/workflow_modelview/api，表名：workflow，视图：Workflow_ModelView_Api，模型：Workflow。

源码：myapp/views/view_workflow.py。

新增参数

无。

修改参数

无。

查看参数

参数 名称 类型 必填 默认值 唯一 说明 校验/可选值
name name computed 否 否
namespace namespace computed 否 否
create_time create_time computed 否 否
status status computed 否 否
task_status task_status computed 否 否
annotations_html annotations_html computed 否 否
labels_html labels_html computed 否 否
spec_html spec_html computed 否 否
status_more_html status_more_html computed 否 否
info_json_html info_json_html computed 否 否

超参搜索管理

/nni_modelview/api，表名：nni，视图：NNI_ModelView_Api，模型：NNI。

源码：myapp/views/view_nni.py，myapp/models/model_nni.py。

新增参数

参数 名称 类型 必填 默认值 唯一 说明 校验/可选值
project project relation 是 否 项目组id
name name string 是 是 英文名
describe describe string 否 否 描述
parallel_trial_count parallel_trial_count integer 否 3 否 最大并行数
parallel_trial_type parallel_trial_type string 否 multi-process 否 并行方式
max_trial_count max_trial_count integer 否 12 否 最大搜索次数
objective_type objective_type string(enum) 否 maximize 否 搜索目标类型
objective_goal objective_goal number 否 0.99 否 搜索目标值
objective_metric_name objective_metric_name string 否 accuracy 否 目标度量名称
algorithm_name algorithm_name string 否 Random 否 算法名
algorithm_setting algorithm_setting string 否 否 算法配置
parameters parameters string 否 {} 否 搜索超参的配置
job_json job_json string 否 {} 否 根据不同算法和参数写入的task模板
working_dir working_dir string 否 否 启动目录
node_selector node_selector string 否 cpu=true,train=true 否 机器选择器
resource_memory resource_memory string 否 1G 否 申请内存
resource_cpu resource_cpu string 否 1 否 申请cpu
resource_gpu resource_gpu string 否 0 否 申请gpu
alert_status alert_status string 否 Pending,Running,Succeeded,Failed,Terminated 否 哪些状态会报警Pending,Running,Succeeded,Failed,Unknown,Waiting,Terminated
job_worker_image job_worker_image string 否 否 执行镜像
job_worker_command job_worker_command string 否 否 执行命令

修改参数

参数 名称 类型 必填 默认值 唯一 说明 校验/可选值
project project relation 是 否 项目组id
name 名称 string 是 是 英文名(小写字母、数字、- 组成)，最长50个字符 DataRequired(); Regexp('^[a-z][a-z0-9\-]*[a-z0-9]$'); Length(1, 54)
describe 描述 string 是 否 中文描述 DataRequired()
parallel_trial_count 任务并行数 integer 是 模型默认值，见 _info 接口 否 可并行的计算实例数目 DataRequired(); Regexp('^[0-9]*$')
parallel_trial_type 任务并行方式 string(enum) 是 multi-process 否 任务并行方式 DataRequired(); choices=[['multi-process', 'multi-process'], ['multi-machine', 'multi-machine']]
max_trial_count 最大任务数 integer 是 模型默认值，见 _info 接口 否 最大并行的计算实例数目 DataRequired(); Regexp('^[0-9]*$')
objective_type 目标函数类型 string(enum) 是 模型默认值，见 _info 接口 否 目标函数类型（和自己代码中对应） DataRequired(); choices=[['maximize', 'maximize'], ['minimize', 'minimize']]
objective_goal 目标门限 number 是 模型默认值，见 _info 接口 否 目标门限 DataRequired(); Regexp('^[\.0-9]*$')
objective_metric_name 目标指标名 string 是 模型默认值，见 _info 接口 否 目标指标名（和自己代码中对应） DataRequired()
algorithm_name 搜索算法 string(enum) 是 模型默认值，见 _info 接口 否 算法名 DataRequired(); choices=algorithm_name_choices
algorithm_setting 搜索算法配置 string 否 模型默认值，见 _info 接口 否 算法配置
parameters parameters string 否 {} 否 搜索超参的配置
job_json job_json string 否 {} 否 根据不同算法和参数写入的task模板
working_dir 工作目录 string 否 模型默认值，见 _info 接口 否 代码所在目录，nni代码、配置和log都将在/mnt/${username}/nni/目录下进行。打开目录 Regexp('^[\x00-\x7f]*$')
node_selector 机器选择 string 否 模型默认值，见 _info 接口 否 部署task所在的机器(目前无需填写)
resource_memory memory string 是 模型默认值，见 _info 接口 否 内存的资源使用配置(每个测试实例)，示例：1G，20G DataRequired(); Regexp('^.*G$')
resource_cpu cpu string 是 模型默认值，见 _info 接口 否 cpu的资源使用配置(每个测试实例)(单位：核)，示例：2 DataRequired(); Regexp('^[0-9]*$')
resource_gpu gpu string 是 0 否 申请的gpu卡数目，示例:2，每个容器独占整卡。-1为共享占用方式，小数(0.1)为vgpu方式，申请具体的卡型号，可以类似 1(V100) DataRequired(); Regexp('^[\-\.0-9,a-zA-Z\(\)]*$')
alert_status alert_status array 否 Pending,Running,Succeeded,Failed,Terminated 否 选择通知状态 choices=[[x, x] for x in ['Pending', 'Running', 'Succeeded', 'Failed', 'Unknown', 'Waiting', 'Terminated']]
job_worker_image job_worker_image string 否 否 执行镜像
job_worker_command job_worker_command string 否 否 执行命令

查看参数

参数 名称 类型 必填 默认值 唯一 说明 校验/可选值
project project relation 是 否 项目组id
created_by created_by computed 否 否
changed_by changed_by computed 否 否
created_on created_on computed 否 否
changed_on changed_on computed 否 否
job_type job_type string(enum) 否 Job 否 任务类型
name 名称 string 是 是 英文名(小写字母、数字、- 组成)，最长50个字符 DataRequired(); Regexp('^[a-z][a-z0-9\-]*[a-z0-9]$'); Length(1, 54)
namespace 命名空间 string 是 模型默认值，见 _info 接口 否 命名空间 DataRequired(); Regexp('^[a-z][a-z0-9\-]*[a-z0-9]$'); Length(1, 54)
describe 描述 string 是 否 中文描述 DataRequired()
parallel_trial_count 任务并行数 integer 是 模型默认值，见 _info 接口 否 可并行的计算实例数目 DataRequired(); Regexp('^[0-9]*$')
parallel_trial_type 任务并行方式 string(enum) 是 multi-process 否 任务并行方式 DataRequired(); choices=[['multi-process', 'multi-process'], ['multi-machine', 'multi-machine']]
max_trial_count 最大任务数 integer 是 模型默认值，见 _info 接口 否 最大并行的计算实例数目 DataRequired(); Regexp('^[0-9]*$')
objective_type 目标函数类型 string(enum) 是 模型默认值，见 _info 接口 否 目标函数类型（和自己代码中对应） DataRequired(); choices=[['maximize', 'maximize'], ['minimize', 'minimize']]
parameters parameters string 否 {} 否 搜索超参的配置
objective_goal 目标门限 number 是 模型默认值，见 _info 接口 否 目标门限 DataRequired(); Regexp('^[\.0-9]*$')
objective_metric_name 目标指标名 string 是 模型默认值，见 _info 接口 否 目标指标名（和自己代码中对应） DataRequired()
objective_additional_metric_names 其他目标指标名 string 否 模型默认值，见 _info 接口 否 其他目标指标名（和自己代码中对应）
algorithm_name 搜索算法 string(enum) 是 模型默认值，见 _info 接口 否 算法名 DataRequired(); choices=algorithm_name_choices
algorithm_setting 搜索算法配置 string 否 模型默认值，见 _info 接口 否 算法配置
trial_spec trial_spec string 否 否 根据不同算法和参数写入的task模板
job_worker_image job_worker_image string 否 否 执行镜像
job_worker_command job_worker_command string 否 否 执行命令
working_dir 工作目录 string 否 模型默认值，见 _info 接口 否 代码所在目录，nni代码、配置和log都将在/mnt/${username}/nni/目录下进行。打开目录 Regexp('^[\x00-\x7f]*$')
volume_mount 挂载 string 否 模型默认值，见 _info 接口 否 外部挂载，格式:；$pvc_name1(pvc):/$container_path1,$hostpath1(hostpath):/$container_path2；注意pvc会自动挂载对应目录下的个人username子目录 Regexp('^[\x00-\x7f]*$')
node_selector 机器选择 string 否 模型默认值，见 _info 接口 否 部署task所在的机器(目前无需填写)
image_pull_policy 拉取策略 string(enum) 否 Always 否 镜像拉取策略(always为总是拉取远程镜像，IfNotPresent为若本地存在则使用本地镜像) choices=[['Always', 'Always'], ['IfNotPresent', 'IfNotPresent']]
resource_memory memory string 是 模型默认值，见 _info 接口 否 内存的资源使用配置(每个测试实例)，示例：1G，20G DataRequired(); Regexp('^.*G$')
resource_cpu cpu string 是 模型默认值，见 _info 接口 否 cpu的资源使用配置(每个测试实例)(单位：核)，示例：2 DataRequired(); Regexp('^[0-9]*$')
resource_gpu gpu string 是 0 否 申请的gpu卡数目，示例:2，每个容器独占整卡。-1为共享占用方式，小数(0.1)为vgpu方式，申请具体的卡型号，可以类似 1(V100) DataRequired(); Regexp('^[\-\.0-9,a-zA-Z\(\)]*$')
experiment experiment string 否 否 构建出来的实验体
alert_status alert_status array 否 Pending,Running,Succeeded,Failed,Terminated 否 选择通知状态 choices=[[x, x] for x in ['Pending', 'Running', 'Succeeded', 'Failed', 'Unknown', 'Waiting', 'Terminated']]
最后更新 2026-06-30完整文档以官方仓库为准：GitHub Wiki