获取纵向联邦作业详情 - getFlVerticalJobContent
功能介绍
获取纵向联邦作业详情
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/leagues/{league_id}/fl-vertical-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类型。推荐用户默认使用application/json，有其他取值时会在具体接口中专门说明。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
description |
String |
作业描述，最大长度512 |
|
datasets |
String |
每个可信计算节点的数据集名 |
|
features |
Array of DatasetFeatureEntity objects |
数据集特征列 |
|
label |
String |
标签列，最大长度100 |
|
epoch |
Integer |
lr迭代数，最小值1 |
|
job_name |
String |
作业名称，最大长度128，名称不能以空白字符开头结尾、或者包含下列任何字符：\ / : * ? " < > |，长度要求在1~128之间。 |
|
algorithm_type |
String |
纵向联邦算法类型枚举，XG_BOOST，LIGHT_BGM，LOGISTIC_REGRESSION 逻辑回归，NEURAL_NETWORK 神经网络，FIBINET |
|
work_step |
String |
纵向联邦操作步骤枚举值。DATA_SELECTION.数据选择,SAMPLE_ALIGNMENT.样本对齐,FEATURE_SELECTION.特征选择,MODEL_TRAIN.模型训练,MODEL_EVALUATION.模型评估,MODEL_PREDICT.预测 |
|
learning_rate |
String |
纵向联邦算法学习率，最大长度16 |
|
label_dataset |
String |
标签数据集，最大长度100 |
|
label_agent |
String |
标签方可信计算节点，最大长度100 |
|
batch_size |
Integer |
lr批大小，最小值1 |
|
grad_epsilon |
String |
lr梯度收敛阈值，默认null |
|
tree_num |
Integer |
xgboost树数量，最大值2的31次方-1 |
|
tree_depth |
Integer |
xgboost树深度，最大值2的31次方-1 |
|
split_num |
Integer |
xgboost切分点数量，最大值2的31次方-1 |
|
current_agent_id |
String |
发起方agentid |
|
learning_task_type |
String |
纵向联邦作业类型 CLASSIFICATION(1), REGRESSION(2) |
|
predict_threshold |
String |
纵向联邦算法预测阈值 |
|
is_single_predict |
Boolean |
单方还是双方预测 |
请求示例
获取纵向联邦作业详情
get https://x.x.x.x:12345/v1/{project_id}/leagues/{league_id}/fl-vertical-jobs/{job_id}
响应示例
状态码：200
获取纵向联邦作业详情成功
{
"description": null,
"datasets": "edc8357011b0449ca985daabd531083c.host_f50_10w_20.space_creator,c2efd9850deb44e3a64b00e555ddb04f.guest_f1_10w_20.tics002",
"features": "features": [
{
"agent_id": "edc8357011b0449ca985daabd531083c",
"dataset_name": "host_f50_10w_20",
"features": [
"f0",
"f1",
"f2"
]
},
{
"agent_id": "c2efd9850deb44e3a64b00e555ddb04f",
"dataset_name": "guest_f1_10w_20",
"features": [
"f0"
]
}
]
"label": "label",
"epoch": null,
"job_name": "xg_20",
"algorithm_type": "XG_BOOST",
"work_step": "MODEL_TRAIN",
"learning_rate": "0.5",
"label_dataset": "guest_f1_10w_20",
"label_agent": "c2efd9850deb44e3a64b00e555ddb04f",
"batch_size": null,
"grad_epsilon": null,
"tree_num": null,
"tree_depth": null,
"split_num": null,
"current_agent_id": "edc8357011b0449ca985daabd531083c",
"learning_task_type": "CLASSIFICATION",
"predict_threshold": null,
"is_single_predict": null
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
获取纵向联邦作业详情成功 |
|
401 |
操作无权限 |
|
500 |
内部服务器错误 |
