更新时间:2024-03-01 GMT+08:00
分享

保存纵向联邦作业

功能介绍

保存纵向联邦作业

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/leagues/{league_id}/fl-vertical-jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,最大32位,由字母和数字组成

league_id

String

联盟ID,最大32位,由字母和数字组成

job_id

String

作业id,最大32位,由字母和数字组成

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。由一个或多个字母数字+-=符号组成。 通过调用接口获取用户Token接口获取。

X-Language

String

根据自己偏好的语言来获取不同语言的返回内容,zh-cn或者en_us

Content-Type

String

发送的实体的MIME类型

表3 请求Body参数

参数

是否必选

参数类型

描述

description

String

作业描述,最大长度512

最小长度:0

最大长度:512

datasets

String

每个可信计算节点的数据集名

features

Array of DatasetFeatureEntity objects

数据集特征列

label

String

标签列,最大长度100

epoch

Integer

lr迭代数,最小值1

最小值:1

job_name

String

作业名称,最大长度128,名称不能以空白字符开头结尾、或者包含下列任何字符:\ / : * ? " < > |,长度要求在1~128之间。

最小长度:0

最大长度:128

algorithm_type

String

纵向联邦算法类型枚举,XG_BOOST,LIGHT_BGM,LOGISTIC_REGRESSION 逻辑回归,NEURAL_NETWORK 神经网络,FIBINET

枚举值:

  • XG_BOOST

  • LIGHT_BGM

  • LOGISTIC_REGRESSION

  • NEURAL_NETWORK

work_step

String

纵向联邦操作步骤枚举值。DATA_SELECTION.数据选择,SAMPLE_ALIGNMENT.样本对齐,FEATURE_SELECTION.特征选择,MODEL_TRAIN.模型训练,MODEL_EVALUATION.模型评估,MODEL_PREDICT.预测

枚举值:

  • 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

最小值:1

grad_epsilon

String

lr梯度收敛阈值,默认nul

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)

枚举值:

  • CLASSIFICATION

  • REGRESSION

predict_threshold

String

纵向联邦算法预测阈值

is_single_predict

Boolean

单方还是双方预测

表4 DatasetFeatureEntity

参数

是否必选

参数类型

描述

agent_id

String

数据集所属agent id

dataset_name

String

数据集名称

features

Array of strings

数据集特征集合

响应参数

请求示例

保存纵向联邦作业

put https://100.1.1.1:31000/v1/{project_id}/leagues/{league_id}/fl-vertical-jobs/{job_id}

{
  "datasets" : "018713527a1d49638eb27b305bc0cc8c.breast_hetero_mini_host.league_creator,0573513cac934b6aab79856c355ee7a2.ief_breast_hetero_mini_guest.league_creator",
  "work_step" : "MODEL_TRAIN",
  "job_name" : "ief_xg_fenlei_ief2cce",
  "host_agent_id" : "018713527a1d49638eb27b305bc0cc8c,0573513cac934b6aab79856c355ee7a2",
  "algorithm_type" : "XG_BOOST",
  "learning_task_type" : "CLASSIFICATION",
  "label_dataset" : "ief_breast_hetero_mini_guest",
  "label" : "y",
  "label_agent" : "0573513cac934b6aab79856c355ee7a2",
  "host_agent_name" : "agent_tics,agent_1656",
  "features" : [ {
    "agent_id" : "018713527a1d49638eb27b305bc0cc8c",
    "dataset_name" : "breast_hetero_mini_host",
    "features" : [ "x3", "x4", "x5" ]
  }, {
    "agent_id" : "0573513cac934b6aab79856c355ee7a2",
    "dataset_name" : "ief_breast_hetero_mini_guest",
    "features" : [ "x0", "x1", "x2" ]
  } ]
}

响应示例

状态码

状态码

描述

200

保存纵向联邦作业成功

401

操作无权限

500

内部服务器错误

分享:

    相关文档

    相关产品