模型開發與訓練是在實驗層級進行,其中實驗由MLInstance、訓練執行和計分執行組成。
您可以執行POST請求,同時在請求裝載中提供名稱和有效的MLInstance ID,以建立實驗。
與UI中的模型訓練不同,透過明確的API呼叫建立實驗不會自動建立並執行訓練執行。
API格式
POST /experiments
請求
curl -X POST \
https://platform.adobe.io/data/sensei/experiments \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'content-type: application/vnd.adobe.platform.sensei+json;profile=experiment.v1.json' \
-d '{
"name": "a name for this Experiment",
"mlInstanceId": "46986c8f-7739-4376-8509-0178bdf32cda"
}'
屬性 | 說明 |
---|---|
name |
實驗的所需名稱。 與此實驗相對應的訓練執行將繼承此值,以便在UI中顯示為訓練執行名稱。 |
mlInstanceId |
有效的MLInstance ID。 |
回應
成功的回應會傳回包含新建立之實驗詳細資料(包括其唯一識別碼)的負載(id
)。
{
"id": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"name": "A name for this Experiment",
"mlInstanceId": "46986c8f-7739-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"createdBy": {
"userId": "Jane_Doe@AdobeID"
},
"updated": "2019-01-01T00:00:00.000Z",
"createdByService": false
}
您可以執行POST請求並提供有效的實驗ID並指定執行任務,以建立訓練或計分執行。 只有在「實驗」有現有且成功的訓練執行時,才可建立計分執行。 成功建立培訓運行將初始化模型培訓過程,成功完成該過程將生成一個受培訓的模型。 產生已訓練的模型將取代任何先前現有的模型,使得實驗在任何指定時間只能使用單一已訓練的模型。
API格式
POST /experiments/{EXPERIMENT_ID}/runs
參數 | 說明 |
---|---|
{EXPERIMENT_ID} |
有效的實驗ID。 |
請求
curl -X POST \
https://platform.adobe.io/data/sensei/experiments/5cb25a2d-2cbd-4c99-a619-8ddae5250a7b/runs \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'content-type: application/vnd.adobe.platform.sensei+json;profile=experimentRun.v1.json' \
-d '{
"mode": "{TASK}"
}'
屬性 | 說明 |
---|---|
{TASK} |
指定運行的任務。 將此值設為訓練的train 、計分的score 或功能管道的featurePipeline 。 |
回應
成功的回應會傳回包含新建立之執行之詳細資料的裝載,包括繼承的預設訓練或計分參數,以及執行的唯一ID({RUN_ID}
)。
{
"id": "33408593-2871-4198-a812-6d1b7d939cda",
"mode": "{TASK}",
"experimentId": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"created": "2019-01-01T00:00:00.000Z",
"createdBy": {
"userId": "Jane_Doe@AdobeID"
},
"updated": "2019-01-01T00:00:00.000Z",
"createdBySchedule": false,
"tasks": [
{
"name": "{TASK}",
"parameters": [
{
"key": "parameter",
"value": "parameter value"
}
]
}
]
}
您可以執行單一GET請求並提供有效的MLInstance ID作為查詢參數,以擷取屬於特定MLInstance的實驗清單。 有關可用查詢的清單,請參閱資產檢索查詢參數的附錄部分。
API格式
GET /experiments
GET /experiments?property=mlInstanceId=={MLINSTANCE_ID}
參數 | 說明 |
---|---|
{MLINSTANCE_ID} |
提供有效的MLInstance ID,以擷取屬於該特定MLInstance的實驗清單。 |
請求
curl -X GET \
https://platform.adobe.io/data/sensei/experiments?property=mlInstanceId==46986c8f-7739-4376-8509-0178bdf32cda \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
回應
成功的回應會傳回共用相同MLInstance ID({MLINSTANCE_ID}
)的實驗清單。
{
"children": [
{
"id": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"name": "A name for this Experiment",
"mlInstanceId": "46986c8f-7739-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"updated": "2019-01-01T00:00:00.000Z",
"createdByService": false
},
{
"id": "6cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"name": "Training Run 1",
"mlInstanceId": "46986c8f-7839-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"updated": "2019-01-01T00:00:00.000Z",
"createdByService": false
},
{
"id": "7cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"name": "Training Run 2",
"mlInstanceId": "46986c8f-7939-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"updated": "2019-01-01T00:00:00.000Z",
"createdByService": false
}
],
"_page": {
"property": "deleted==false",
"count": 3
}
}
您可以執行GET請求,在請求路徑中包含所需實驗的ID,以擷取特定實驗的詳細資訊。
API格式
GET /experiments/{EXPERIMENT_ID}
參數 | 說明 |
---|---|
{EXPERIMENT_ID} |
有效的實驗ID。 |
請求
curl -X GET \
https://platform.adobe.io/data/sensei/experiments/5cb25a2d-2cbd-4c99-a619-8ddae5250a7b \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
回應
成功的回應會傳回包含所請求實驗詳細資料的裝載。
{
"id": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"name": "A name for this Experiment",
"mlInstanceId": "46986c8f-7739-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"createdBy": {
"userId": "Jane_Doe@AdobeID"
},
"updated": "2019-01-01T00:00:00.000Z",
"createdByService": false
}
您可以執行單一GET要求並提供有效的實驗ID,以擷取屬於特定實驗的訓練或計分執行清單。 若要協助篩選結果,您可以在請求路徑中指定查詢參數。 有關可用查詢參數的完整清單,請參閱資產檢索查詢參數的附錄部分。
組合多個查詢參數時,必須以&符號分隔。
API格式
GET /experiments/{EXPERIMENT_ID}/runs
GET /experiments/{EXPERIMENT_ID}/runs?{QUERY_PARAMETER}={VALUE}
GET /experiments/{EXPERIMENT_ID}/runs?{QUERY_PARAMETER_1}={VALUE_1}&{QUERY_PARAMETER_2}={VALUE_2}
參數 | 說明 |
---|---|
{EXPERIMENT_ID} |
有效的實驗ID。 |
{QUERY_PARAMETER} |
用於篩選結果的可用查詢參數之一。 |
{VALUE} |
前面查詢參數的值。 |
請求
下列請求包含查詢,並擷取屬於某些實驗的訓練執行清單。
curl -X GET \
https://platform.adobe.io/data/sensei/experiments/5cb25a2d-2cbd-4c99-a619-8ddae5250a7b/runs?property=mode==train \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
回應
成功的回應會傳回包含執行清單及其每個詳細資訊(包括其實驗執行ID)的裝載。{RUN_ID}
{
"children": [
{
"id": "33408593-2871-4198-a812-6d1b7d939cda",
"mode": "train",
"experimentId": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"created": "2019-01-01T00:00:00.000Z",
"createdBy": {
"userId": "Jane_Doe@AdobeID"
},
"createdBySchedule": false
}
],
"_page": {
"property": "mode==train,experimentId==5cb25a2d-2cbd-4c99-a619-8ddae5250a7b,deleted==false",
"totalCount": 1,
"count": 1
}
}
您可以透過PUT請求覆寫現有實驗的屬性,該請求在請求路徑中包含目標實驗的ID,並提供包含已更新屬性的JSON裝載,借此更新現有實驗。
為確保此PUT請求成功,建議您先執行GET請求,以擷取「依ID擷取實驗」(Emperity by ID)。 然後,修改並更新傳回的JSON物件,並套用已修改的JSON物件的完整內容作為PUT要求的裝載。
下列範例API呼叫會在最初具有這些屬性時更新實驗的名稱:
{
"name": "A name for this Experiment",
"mlInstanceId": "46986c8f-7739-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"createdBy": {
"userId": "Jane_Doe@AdobeID"
},
"createdByService": false
}
API格式
PUT /experiments/{EXPERIMENT_ID}
參數 | 說明 |
---|---|
{EXPERIMENT_ID} |
有效的實驗ID。 |
請求
curl -X PUT \
https://platform.adobe.io/data/sensei/experiments/5cb25a2d-2cbd-4c99-a619-8ddae5250a7b \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'content-type: application/vnd.adobe.platform.sensei+json;profile=experiments.v1.json' \
-d '{
"name": "An upated name",
"mlInstanceId": "46986c8f-7739-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"createdBy": {
"userId": "Jane_Doe@AdobeID"
},
"createdByService": false
}'
回應
成功的回應會傳回包含實驗更新詳細資料的負載。
{
"id": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"name": "An updated name",
"mlInstanceId": "46986c8f-7739-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"createdBy": {
"userId": "Jane_Doe@AdobeID"
},
"updated": "2019-01-02T00:00:00.000Z",
"createdByService": false
}
您可以執行DELETE請求,將目標實驗的ID包含在請求路徑中,以刪除單一實驗。
API格式
DELETE /experiments/{EXPERIMENT_ID}
參數 | 說明 |
---|---|
{EXPERIMENT_ID} |
有效的實驗ID。 |
請求
curl -X DELETE \
https://platform.adobe.io/data/sensei/experiments/5cb25a2d-2cbd-4c99-a619-8ddae5250a7b \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
回應
{
"title": "Success",
"status": 200,
"detail": "Experiment successfully deleted"
}
您可以執行DELETE請求,將MLInstance ID作為查詢參數,刪除屬於特定MLInstance的所有實驗。
API格式
DELETE /experiments?mlInstanceId={MLINSTANCE_ID}
參數 | 說明 |
---|---|
{MLINSTANCE_ID} |
有效的MLInstance ID。 |
請求
curl -X DELETE \
https://platform.adobe.io/data/sensei/experiments?mlInstanceId=46986c8f-7739-4376-8509-0178bdf32cda \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
回應
{
"title": "Success",
"status": 200,
"detail": "Experiments successfully deleted"
}