附录

对象定义

Dataset

参数名 参数类型 参数描述
datasetId String 数据集编号。例如:dataset-c9xdfdfdmt02
datasetName String 用户自定义的数据集名称。
rawData String 数据集原始数据存储路径,例如:bos://bucketName/lda_datasource"
dataFormat String 输入的数据格式。包括SparseID,SparseIDWeight,Dense。
isClassification Bool 是分类数据集还是回归数据集,true为分类,false为回归。
status Status 数据集当前状态
history List 数据集历史状态
sampleNum Int 数据集样本数,Finished状态数据集的统计结果,未完成时为空
featureNum Int 数据集特征数,Finished状态数据集的统计结果,未完成时为空
labelNum Int 数据集label数,Finished状态数据集的统计结果,未完成时为空
createTime String 创建时间,符合日期时间格式约束
finishTime String 完成时间,符合日期时间格式约束,未完成时为空

Model

参数名 参数类型 参数描述
modelId String 模型ID
modelName String 用户自定义的模型名称
datasetId String 模型的训练数据集ID
algoName String 模型的算法名称, 详情见算法文档
algoInfo AlgoPara 训练算法的配置, 详情见各算法的模型训练
status Status 模型当前状态,
status的value大0为正在训练中,等于0为训练成功,小于0为训练失败
history List 模型历史状态
createTime String 创建时间,符合日期时间格式约束
finishTime String 完成时间,符合日期时间格式约束,未完成时为空

AlgoPara

AlgoPara包括算法algoName对应的所有参数的配置内容,每个算法的参数列表和解释详见算法文档

这里所有参数配置内容类型统一为String

参数 参数类型 参数描述
algoPara1 String 算法参数值
algoPara2 String 算法参数值
... String 算法参数值

ModelEvaluate

参数名 参数类型 参数描述
evaluateId String 模型评估ID
modelId String 被评估的模型ID
datasetId String 用来评估的数据集ID
evaluatePara AlgoPara 模型的评估参数,具体模型的评估参数参考对应算法的算法文档。
若该模型对应的算法没有特殊的评估参数,可以为空
status Status 当前评估状态,
status的value大0为正在进行评估,等于0为评估成功,小于0为评估失败
history List 评估历史状态
result ModelEvaluateResult 模型的评估结果,未评估成功时为空
createTime String 创建时间,符合日期时间格式约束
finishTime String 完成时间,符合日期时间格式约束,未完成时为空

ModelEvaluateResult

模型评估的评估结果,每个算法的评估结果包括的内容和解释详见算法文档

参数 参数类型 参数描述
evaluateData1 String 评估结果值
evaluateData2 String 评估结果值
... String 评估结果值

ModelBatchPredict

参数名 参数类型 参数描述
batchPredictId String 模型批量预测ID
modelId String 用来批量预测的模型ID
datasetId String 被批量预测的数据集ID
outPath String 预测结果在BOS上的存储路径
batchPredictPara AlgoPara 模型的批量预测参数,具体模型的批量预测参数参考对应算法的算法文档。
若该模型对应的算法没有特殊的批量预测参数,可以为空
status Status 当前批量预测状态, status的value大0为正在进行预测,等于0为预测成功,小于0为预测失败
history List 预测历史状态
createTime String 创建时间,符合日期时间格式约束
finishTime String 完成时间,符合日期时间格式约束,未完成时为空

OnlinePredictService

参数名 参数类型 参数描述
serviceId String 在线预测服务ID
serviceURL String 在线预测服务URL,用来请求服务进行预测的API地址
accessKey String 在线预测服务的AK,用来在进行预测时签名验证使用
secretAccessKey String 在线预测服务的SK,用来在进行预测时签名验证使用,不同于用户开放云AK/SK,专门对应具体的预测服务
instanceTotal Int 在线预测服务总实例数,每个在线预测服务都是负载均衡的分配到多个服务实例上来响应预测请求的
instanceSuccess Int 成功部署的在线预测服务实例数
instanceDeploying Int 部署中的在线预测服务实例数
instanceFailed Int 部署失败的在线预测服务实例数
status Status 当前在线预测服务状态, status的value大0为服务正在部署中,等于0为服务部署成功,小于0为服务部署失败;当所有实例都部署成功时,status["value"]=0;当有实例在部署中,没有实例部署失败时,status["value"]>0;当有实例部署失败时,status["value"]<0,status["message"]为部署失败的错误提示;只有status["value"]=0时,该预测服务的所有请求都能被正确响应,其他情况该预测服务的请求会有概率被分发到未成功部署的实例上而响应失败。
modelId String 该在线预测服务对应的部署模型。通常情况下所有服务实例都对应一个模型Id,但当预测服务被重载模型,在重新部署过程中会有短时间的各实例模型不一致的情况,此时返回为最新部署的模型Id。
createTime String 创建时间,符合日期时间格式约束
memCost Float 该在线预测服务消耗的内存,单位kb,所有服务实例的平均值
cpuCost Float 该在线预测服务消耗的CPU百分比,单位%, 所有服务实例的平均值
totalCallCount Int 该在线预测服务总共响应的预测请求数
last24hourCallCount Int 该在线预测服务过去24小时内响应的预测请求数

Status

参数 参数类型 参数描述
value Int 状态编码。
通用约束为:等于0为成功完成,大于0为正在运行,小于0为错误结束
message String 状态解释信息
time String 状态变更时间,符合日期时间格式约束

枚举定义

DataFormat

数据格式 举例 说明
SparseID No,label,feature1,feature2,.....featureN sample里出现feature对应的权重为1,
每行sample的feature个数可以不统一
SparseIDWeight No,label,feature1 weight1,feature2 weight2,.....featureN weightN sample里出现的feature对应的权重为对应的weight值,
每行sample的feature个数可以不统一,feature和weight之间空格分离
Dense No,label,weight1,weight2,weight3.....weightN sample的feature编号规定为1,2,...,N,
对应的权重为weight1,weight2,...weightN,
每行sample的feature个数统一为N,必须相等

日期与时间的限制

日期与时间的表示有多种方式。为统一起见,除非是约定俗成或者有相应规范的,凡是HTTP标准中规定的表示日期和时间字段用GMT,其他日期时间表示的地方一律采用UTC时间,遵循ISO 8601,并做以下约束:

  • 表示日期一律采用YYYY-MM-DD方式,例如2014-06-01表示2014年6月1日。
  • 表示时间一律采用hh:mm:ss方式,并在最后加一个大写字母Z表示UTC时间。例如23:00:10Z表示UTC时间23点0分10秒。
  • 凡涉及日期和时间合并表示时,在两者中间加大写字母T,例如2014-06-01T23:00:10Z表示UTC时间2014年6月1日23点0分10秒。