新建联邦学习作业
功能介绍
新建联邦学习作业
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/leagues/{league_id}/fl-jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,最大32位,由字母和数字组成 |
league_id |
是 |
String |
空间ID,最大32位,由字母和数字组成 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。由一个或多个字母数字+-=符号组成。 通过调用接口获取用户Token接口获取。 |
X-Language |
是 |
String |
根据自己偏好的语言来获取不同语言的返回内容,zh-cn或者en_us |
Content-Type |
是 |
String |
发送的实体的MIME类型 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
作业名称。名称不能以空白字符开头结尾、或者包含下列任何字符:\ / : * ? " < > |,长度要求在1~128之间。 |
description |
否 |
String |
作业描述,最大长度512 |
hfl_type |
否 |
String |
fl作业类型枚举。TRAIN(训练),EVALUATE(评估)。 |
hfl_platform_type |
否 |
String |
联邦学习运行平台枚举值。LOCAL(本地),MODEL_ARTS(modelarts) |
agent_id |
是 |
String |
作业发起可信计算节点id,最大32位,由字母和数字组成 |
algorithm_type |
否 |
String |
纵向联邦算法类型枚举值。XG_BOOST,LIGHT_BGM, LOGISTIC_REGRESSION(逻辑回归),NEURAL_NETWORK,FIBINET |
job_type |
是 |
String |
作业类型。HFL(横向联邦),VFL(纵向联邦)。 |
learning_task_type |
否 |
String |
纵向联邦作业类型,CLASSIFICATION(1),REGRESSION(2) |
job_instance_id |
否 |
String |
模型ID,最大32位,由字母和数字组成 |
train_label_agent |
否 |
String |
标签方可信计算节点,最大32位,由字母和数字组成 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
作业id |
请求示例
新建横向联邦学习作业
post https://x.x.x.x:12345/v1/{project_id}/leagues/{league_id}/fl-jobs { "name" : "test", "job_type" : "HFL", "hfl_type" : "TRAIN", "hfl_platform_type" : "LOCAL", "agent_id" : "ac50f5053ae94114ba325ac8a6470048" }
响应示例
状态码: 200
新建联邦学习作业成功
{ "job_id" : "c098faeb38384be8932539bb6fbc28d3" }
状态码
状态码 |
描述 |
---|---|
200 |
新建联邦学习作业成功 |
401 |
操作无权限 |
500 |
内部服务器错误 |