模型

训练模型

  • 接口描述

    对于已经预处理完成的数据集,提供各种机器学习算法进行训练,生成模型。

  • 请求(Request)

    • 请求语法:
    POST /v{version}/model HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: {utc-date-string}
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization:{bce-authorization-string}
    
    • 请求头域:无特殊Header参数

    • 请求参数:

参数名 参数类型 必要性 参数描述
version String 必选 API版本号,当前取值1
datasetId String 必选 用于训练的数据集ID
modelName String 必选 用户自定义的模型名称
algoName String 必须 用户选择的算法名称,可选算法参考算法说明
algoPara AlgoPara 必选 用户选择的算法参数,每个算法具体的参数参考各算法说明的模型训练
  • 响应(Response)

    • 响应头域:无特殊Header参数
    • 响应参数:
参数 参数类型 参数描述
modelId String 生成模型ID。如model-fdslkj454jd3
  • 示例

    • 请求示例
    POST /v1/model HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: 2015-03-24T13:02:00Z
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2015-03-24T13:04:26Z/1800/host;x-bce-date/b1ad7075b37616b846a356d1db86e73abba1aed51b4d7b0d95321f69f17250b1
    {
        "datasetId": "dataset-fdslkj454jd3",
        "modelName": "LR-Test-Model",
        "algoName":"lr",
        "algoPara": {
            "l1Weight":"0.1",
            "l2Weight":"0.1",
            "termination":"0.00001",
            "maxIter":"100"
        }
    }
    
    • 响应示例
    HTTP/1.1 200 OK
    x-bce-request-id:73c4e74c-3101-4a00-bf44-fe246959c05e
    Cache-Control: no-cache
    Server: BWS
    Date: Tue, 24 Mar 2015 13:02:01 GMT
    Content-Type: application/json;charset=UTF-8
    {
        "modelId" : "model-fdslkj454jd3",
    }
    

查询模型

  • 接口描述

    查询某个模型的详细信息

  • 请求(Request)

    • 请求语法:
    GET /v{version}/model/{modelId} HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: {utc-date-string}
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization:{bce-authorization-string}
    
    • 请求头域:无特殊Header参数

    • 请求参数:

参数名 参数类型 必要性 参数描述
version String 必选 API版本号,当前取值1
modelId String 必选 模型ID
  • 响应(Response)

    • 响应头域:无特殊Header参数

    • 响应参数:

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

    • 请求示例
    GET /v1/model/model-fdslkj454jd3 HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: 2015-03-24T13:02:00Z
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2015-03-24T13:04:26Z/1800/host;x-bce-date/b1ad7075b37616b846a356d1db86e73abba1aed51b4d7b0d95321f69f17250b1
    
    • 响应示例
    HTTP/1.1 200 OK
    x-bce-request-id:73c4e74c-3101-4a00-bf44-fe246959c05e
    Cache-Control: no-cache
    Server: BWS
    Date: Tue, 24 Mar 2015 13:02:01 GMT
    Content-Type: application/json;charset=UTF-8 
    {
        "modelId": "model-a0x532fdmt01",
        "modelName": "LR-Test-Model",
        "datasetId": "dataset-fdslkj454jd3",
        "algoName": "lr",
        "algoPara": {
            "l1Weight":"0.1",
            "l2Weight":"0.1",
            "termination":"0.00001",
            "maxIter":"100"
        },
        "status": {
            "value": 0,
            "message": "BML job completed successful",
            "time": "2015-07-09T15:00:38Z"
        },
        "history": [
        {
            "value" : 1,
            "message" : "BML job submit successful",
            "time" : "2015-07-09T14:53:53Z"
        },
        {
            "value" : 2,
            "message": "BML job startup",
            "time": "2015-07-09T14:55:13Z"
        },
        {
            "value": 2001,
            "message": "LR model train:start up",
            "time": "2015-07-09T14:55:15Z"
        },
        {
            "value": 2002,
            "message": "LR model train:loading configure data",
            "time": "2015-07-09T14:55:17Z"
        },
        ......
        {
            "value": 0,
            "message": "BML job completed successfull",
            "time": "2015-07-09T15:00:38Z"
        }           
        ],
            "createTime" : "2015-07-09T14:53:53Z",
            "finishTime" : "2015-07-09T15:00:38Z" 
    }
    

查询模型列表

  • 接口描述

    查询用户训练的模型列表

  • 请求(Request)

    • 请求语法:
    GET /v{version}/model?&marker={marker}&maxKeys={maxKeys} HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: {utc-date-string}
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization:{bce-authorization-string}
    
    • 请求头域:无特殊Header参数

    • 请求参数:

参数名 参数类型 必要性 参数描述
version String 必选 API版本号,当前取值1
marker String 可选 批量获取列表的查询的起始位置,是一个由系统生成的字符串
maxKeys Int 可选 每页包含的最大数量,最大数量不能超过1000。
大于1000的会被修正为1000。缺省值为1000
  • 响应(Response)

    • 响应头域:无特殊Header参数

    • 响应参数:

参数名 参数类型 参数描述
marker String 标记查询的起始位置
truncated Boolean true表示后面还有数据,false表示已经是最后一页
nextMarker String 获取下一页所需要传递的marker值。当truncated为false时,该域不出现
models List<Model> 返回的模型列表
  • 示例

    • 请求示例
    GET /v1/model?marker=9e0c8cf1-690c-444a-8727-04241f3beaa5&maxKeys=30 HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: 2015-03-24T13:02:00Z
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2015-03-24T13:04:26Z/1800/host;x-bce-date/b1ad7075b37616b846a356d1db86e73abba1aed51b4d7b0d95321f69f17250b1
    
    • 响应示例
    HTTP/1.1 200 OK
    x-bce-request-id:73c4e74c-3101-4a00-bf44-fe246959c05e
    Cache-Control: no-cache
    Server: BWS
    Date: Tue, 24 Mar 2015 13:02:01 GMT
    Content-Type: application/json;charset=UTF-8 
    {
        "models": [
        {
            "modelId": "model-a0x532fdmt01",
            "modelName": "LR-Test-Model",
            "datasetId": "dataset-fdslkj454jd3",
            "algoName": "lr",
            "status": {
                "value": 0,
                "message": "BML job completed successful",
                "time": "2015-07-09T15:00:38Z"
            },
            "createTime" : "2015-07-09T14:53:53Z",
            "finishTime" : "2015-07-09T15:00:38Z" 
        } ,
        {
            "modelId": "model-fskldjfdmt08",
            "modelName": "LR-Test-Model-beta",
            "datasetId": "dataset-fdslkj454jd3",
            "algoName": "lr",
            "status": {
                "value": 0,
                "message": "BML job completed successful",
                "time": "2015-07-09T15:00:38Z"
            },
            "createTime" : "2015-07-09T14:53:53Z",
            "finishTime" : "2015-07-09T15:00:38Z" 
        },
        ...... 
        ],
        "truncated": false,
        "marker": "9e0c8cf1-690c-444a-8727-04241f3beaa5"
    }
    

终止模型训练

  • 接口描述

    对于正在训练中的模型,进行终止操作。

  • 请求(Request)

    • 请求语法:
    PUT /v{version}/model/{modelId}?kill HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: {utc-date-string}
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization:{bce-authorization-string}
    
    • 请求头域:无特殊Header参数

    • 请求参数:

参数名 参数类型 必要性 参数描述
version String 必选 API版本号,当前取值1
modelId String 必选 要终止生成的模型ID。该模型必须为正在训练中的状态,即当前status的value字段大于0
  • 响应(Response)

    • 响应头域:无特殊Header参数
    • 响应参数:
参数 参数类型 参数描述
modelId String 模型ID
  • 示例

    • 请求示例
    PUT /v1/model/model-sght76awoi31?kill HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: 2015-03-24T13:02:00Z
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2015-03-24T13:04:26Z/1800/host;x-bce-date/b1ad7075b37616b846a356d1db86e73abba1aed51b4d7b0d95321f69f17250b1
    
    • 响应示例
    HTTP/1.1 200 OK
    x-bce-request-id:73c4e74c-3101-4a00-bf44-fe246959c05e
    Cache-Control: no-cache
    Server: BWS
    Date: Tue, 24 Mar 2015 13:02:01 GMT
    Content-Type: application/json;charset=UTF-8
    {
        "modelId" : "model-sght76awoi31"
    }
    

删除模型

  • 接口描述

    删除已经训练完成的模型,同时会删除该模型所有的评估结果。

  • 请求(Request)

    • 请求语法:
    DELETE /v{version}/model/{modelId} HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: {utc-date-string}
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization:{bce-authorization-string}
    
    • 请求头域:无特殊Header参数

    • 请求参数:

参数名 参数类型 必要性 参数描述
version String 必选 API版本号,当前取值1
modelId String 必选 要删除的模型ID. 该模型必须为训练完成的状态,即当前status的value字段等于或小于0
  • 响应(Response)

    • 响应头域:无特殊Header参数
    • 响应参数:
参数 参数类型 参数描述
modelId String 模型ID
  • 示例

    • 请求示例
    DELETE /v1/model/model-sght76awoi31 HTTP/1.1
    accept-encoding: gzip, deflate
    x-bce-date: 2015-03-24T13:02:00Z
    connection: keep-alive
    accept: */*
    host: bml.bj.baidubce.com
    content-type: application/json
    authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2015-03-24T13:04:26Z/1800/host;x-bce-date/b1ad7075b37616b846a356d1db86e73abba1aed51b4d7b0d95321f69f17250b1
    
    • 响应示例
    HTTP/1.1 200 OK
    x-bce-request-id:73c4e74c-3101-4a00-bf44-fe246959c05e
    Cache-Control: no-cache
    Server: BWS
    Date: Tue, 24 Mar 2015 13:02:01 GMT
    Content-Type: application/json;charset=UTF-8
    {
        "modelId" : "model-sght76awoi31"
    }