保存横向联邦学习作业
功能介绍
保存横向联邦学习作业
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/leagues/{league_id}/fl-jobs/{job_id}
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID，最大32位，由字母和数字组成 |
league_id |
是 |
String |
联盟ID，最大32位，由字母和数字组成 |
job_id |
是 |
String |
任务id，最大32位，由字母和数字组成 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。由一个或多个字母数字+-=符号组成 通过调用接口获取用户Token接口获取。 |
X-Language |
是 |
String |
根据自己偏好的语言来获取不同语言的返回内容,zh-cn或者en_us |
Content-Type |
是 |
String |
发送的实体的MIME类型 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
description |
否 |
String |
作业描述，最大长度512 最小长度：0 最大长度：512 |
round |
是 |
Integer |
训练轮数，最小值1最大值1000 最小值：1 最大值：1000 |
epoch |
是 |
Integer |
迭代数，最小值1最大值1000 最小值：1 最大值：1000 |
datasets |
是 |
String |
数据集列表，最大值1024 最小长度：0 最大长度：1024 |
ext |
否 |
String |
参数等额外信息，最大值1024 最小长度：0 最大长度：1024 |
job_name |
是 |
String |
作业名称。名称不能以空白字符开头结尾、或者包含下列任何字符：\ / : * ? " < > |，长度要求在1~128之间 最小长度：0 最大长度：128 |
hfl_type |
是 |
String |
fl作业类型枚举。TRAIN，EVALUATE。 枚举值：
|
hfl_platform_type |
是 |
String |
联邦学习运行平台枚举值。LOCAL，MODEL_ARTS 枚举值：
|
host_agent_id |
是 |
String |
发起方agent id，最大长度32 最小长度：0 最大长度：32 |
host_agent_name |
是 |
String |
发起方agent别名，最大长度128 最小长度：0 最大长度：128 |
boot_file_url |
是 |
String |
训练脚本路径，最大长度512 最小长度：0 最大长度：512 |
model_file_url |
是 |
String |
模型路径，最大长度512 最小长度：0 最大长度：512 |
engine_id |
否 |
String |
引擎id，最大长度50 最小长度：0 最大长度：50 |
spec_id |
否 |
String |
资源规格id，最大长度50 最小长度：0 最大长度：50 |
initial_weight_url |
否 |
String |
初始权重路径，最大长度512 最小长度：0 最大长度：512 |
eval_dataset_name |
否 |
String |
评估数据集名。名称不能以空白字符开头结尾、或者包含下列任何字符：\ / : * ? " < > |，长度要求在1~128之间 最小长度：0 最大长度：128 |
响应参数
无
请求示例
{"job_name":"hori","hfl_type":"TRAIN","hfl_platform_type":"LOCAL","boot_file_url":"/uploadfiles/iris_train.py","model_file_url":"/uploadfiles/model.h5","round":2,"epoch":2,"host_agent_id":"0573513cac934b6aab79856c355ee7a2","host_agent_name":"agent_1656","eval_dataset_name":"ief_iris2","datasets":"league_creator.iris1,league_creator.ief_iris2"}
put https://100.1.1.1:31000/v1/{project_id}/leagues/{league_id}/fl-jobs/{job_id}
保存横向联邦学习作业
响应示例
无
状态码
状态码 |
描述 |
|---|---|
200 |
保存横向联邦学习作业成功 |
401 |
操作无权限 |
500 |
内部服务器错误 |
