URI
URI格式：
POST https://{{Federal-Address}}/federated/v1/instance
参数说明，如
表1所示。
表1 参数说明参数
|
是否必选
|
类型
|
说明
|
|---|
name
|
Y
|
String
|
联邦实例名称
|
version
|
Y
|
String
|
联邦实例版本
|
type
|
Y
|
String
|
联邦类型
|
creator
|
Y
|
String
|
创建者
|
description
|
N
|
String
|
描述
|
baseAlgorithm
|
Y
|
BaseAlgorithm
|
算法基础信息
|
aggregateAlgorithm
|
Y
|
AggregateAlgorithm
|
汇聚算法配置
|
AggregateAlgorithm类型说明，如表2所示。
表2 AggregateAlgorithm类型说明参数
|
是否必选
|
类型
|
说明
|
|---|
type
|
Y
|
String
|
取值：AVG
|
superArgs
|
Y
|
Map<String，String>
|
模型超参。
目前支持的超参key如下所示：
- useBifurcation：取值为true或false，默认值为“false”。
- multipartCalc：取值为true或false，默认值为“false”。
- COMPRESS_FREEZE_PARAM_CLIENT：取值为true/false，默认值为“false”。
- COMPRESS_FREEZE_PARAM_SERVER：取值为true/false，默认值为“false”。
- COMPRESS_RANDOM_PARAM：取值为true或false，默认值为“false”。
- subModelLearningRate：客户端学习率
- subModelIterateTimes：客户端训练轮次
- modelUpdateCompressionRatio：模型更新压缩率，默认值为“1”。
- nodeNumPerIteration：最小汇聚节点数
- maxIterateSteps：最大汇聚轮次
- iterateSteps：汇聚轮次
- modelChangemodelChange：模型改变量阈值。如果小于阈值，则联邦学习部署服务停止。
- decayRate decay：算法rate。如果取值为“1”，说明不启动decay算法。
- decaySteps decay：算法触发条件
- generalModelTestInterval：多少轮汇聚评估一次
|
BaseAlgorithm类型说明，如表3所示。
表3 BaseAlgorithm类型说明参数
|
是否必选
|
类型
|
说明
|
|---|
remote
|
N
|
RemoteBaseAlgorithm
|
从训练平台获取的算法包信息，和local二选一
|
local
|
N
|
LocalBaseAlgorithm
|
从本地上传的算法包信息，和remote二选一
|
modelEvaluationIndex
|
Y
|
String[]
|
模型评估方式。
枚举值：
- accuracy
- precision
- recallRate
|
localRunEnv
|
Y
|
String
|
本地环境类型。
取值如下所示：
|
LocalBaseAlgorithm类型说明，如表4所示。
表4 LocalBaseAlgorithm类型说明参数
|
是否必选
|
类型
|
说明
|
|---|
packageId
|
N
|
String
|
上传包ID
|
RemoteBaseAlgorithm类型说明，如表5所示。
表5 RemoteBaseAlgorithm类型说明参数
|
是否必选
|
类型
|
说明
|
|---|
projectId
|
Y
|
String
|
项目ID
|
projectName
|
N
|
String
|
项目名称
|
modelId
|
Y
|
String
|
模型ID
|
