获取横向联邦学习作业详情
功能介绍
获取横向联邦学习作业详情
调用方法
请参见如何调用API。
URI
GET /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类型 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
description |
String |
作业描述,最大长度512 |
round |
Integer |
训练轮数,最小值1,最大值1000 |
epoch |
Integer |
迭代数,最小值1,最大值1000 |
datasets |
String |
数据集列表,最大长度1024 |
ext |
String |
参数等额外信息,最大长度1024 |
job_name |
String |
作业名称。名称不能以空白字符开头结尾、或者包含下列任何字符:\ / : * ? " < > |,长度要求在1~128之间 |
hfl_type |
String |
fl作业类型枚举。TRAIN, EVALUATE |
hfl_platform_type |
String |
联邦学习运行平台枚举值。LOCAL,MODEL_ARTS |
host_agent_id |
String |
发起方agent id,最大32位,由字母和数字组成 |
host_agent_name |
String |
发起方可信计算节点名称,最大长度128 |
boot_file_url |
String |
训练脚本路径,最大长度512 |
model_file_url |
String |
模型路径,最大长度512 |
engine_id |
String |
引擎id,最大长度50 |
spec_id |
String |
资源规格id,最大长度50 |
initial_weight_url |
String |
初始权重路径,最大长度512 |
eval_dataset_name |
String |
评估数据集名。名称不能以空白字符开头结尾、或者包含下列任何字符:\ / : * ? " < > |,长度要求在1~128之间 |
请求示例
获取横向联邦学习作业详情
get https://x.x.x.x:12345/v1/{project_id}/leagues/{league_id}/fl-jobs/{job_id}
响应示例
状态码: 200
获取横向联邦学习作业详情成功
{ "description" : null, "round" : 1, "epoch" : 1, "datasets" : "space_creator.host_f40_10w,tics002.guest_f1_10w_20", "ext" : null, "job_name" : "test_heng", "hfl_type" : "TRAIN", "hfl_platform_type" : "LOCAL", "host_agent_id" : "edc8357011b0449ca985daabd531083c", "host_agent_name" : "agent_test", "boot_file_url" : "/uploadfiles/solubility_train.py", "model_file_url" : "/uploadfiles/solubility_model.h5", "engine_id" : null, "spec_id" : null, "initial_weight_url" : null, "eval_dataset_name" : "host_f40_10w" }
状态码
状态码 |
描述 |
---|---|
200 |
获取横向联邦学习作业详情成功 |
401 |
操作无权限 |
500 |
内部服务器错误 |