diff --git a/custom-words.txt b/custom-words.txt index cb9ffdbf97ba..e70feaf46b1d 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -2315,6 +2315,7 @@ Vcore Vcores VCPU vcsa +Vectorizer versionid Vertica Vfyc diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Job/AutoMLJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Job/AutoMLJob/createOrUpdate.json new file mode 100644 index 000000000000..bf7771f23009 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Job/AutoMLJob/createOrUpdate.json @@ -0,0 +1,252 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2022-02-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "jobType": "AutoML", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": null + } + } + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "taskDetails": { + "taskType": "ImageClassification", + "limitSettings": { + "maxTrials": 2 + }, + "targetColumnName": "string", + "trainingData": { + "jobInputType": "mltable", + "uri": "string" + }, + "modelSettings": { + "validationCropSize": 2 + }, + "searchSpace": [ + { + "validationCropSize": "choice(2, 360)" + } + ] + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Scheduled", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "jobType": "AutoML", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": null + } + } + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "taskDetails": { + "taskType": "ImageClassification", + "limitSettings": { + "maxTrials": 2 + }, + "targetColumnName": "string", + "trainingData": { + "jobInputType": "mltable", + "uri": "string" + }, + "modelSettings": { + "validationCropSize": 2 + }, + "searchSpace": [ + { + "validationCropSize": "choice(2, 360)" + } + ] + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Scheduled", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "jobType": "AutoML", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": null + } + } + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "taskDetails": { + "taskType": "ImageClassification", + "limitSettings": { + "maxTrials": 2 + }, + "targetColumnName": "string", + "trainingData": { + "jobInputType": "mltable", + "uri": "string" + }, + "modelSettings": { + "validationCropSize": 2 + }, + "searchSpace": [ + { + "validationCropSize": "choice(2, 360)" + } + ] + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Job/AutoMLJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Job/AutoMLJob/get.json new file mode 100644 index 000000000000..a058b7b4970e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Job/AutoMLJob/get.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2022-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Scheduled", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "jobType": "AutoML", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": null + } + } + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "taskDetails": { + "taskType": "ImageClassification", + "limitSettings": { + "maxTrials": 2 + }, + "targetColumnName": "string", + "trainingData": { + "jobInputType": "mltable", + "uri": "string" + }, + "modelSettings": { + "validationCropSize": 2 + }, + "searchSpace": [ + { + "validationCropSize": "choice(2, 360)" + } + ] + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Job/AutoMLJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Job/AutoMLJob/list.json new file mode 100644 index 000000000000..41c1c3ea5ba9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Job/AutoMLJob/list.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2022-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Scheduled", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "jobType": "AutoML", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": null + } + } + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "taskDetails": { + "taskType": "ImageClassification", + "limitSettings": { + "maxTrials": 2 + }, + "targetColumnName": "string", + "trainingData": { + "jobInputType": "mltable", + "uri": "string" + }, + "modelSettings": { + "validationCropSize": 2 + }, + "searchSpace": [ + { + "validationCropSize": "choice(2, 360)" + } + ] + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/createOrUpdate.json new file mode 100644 index 000000000000..3c4147087d36 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/createOrUpdate.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2021-03-01-preview", + "id": "testLabelingJob", + "body": { + "properties": { + "jobType": "Labeling", + "description": "string", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "labelCategories": { + "myCategory1": { + "displayName": "myCategory1Title", + "multiSelectEnabled": true, + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + }, + "myCategory2": { + "displayName": "myCategory2Title", + "multiSelectEnabled": true, + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + } + }, + "jobInstructions": { + "uri": "link/to/instructions" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute", + "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute" + }, + "labelingJobMediaProperties": { + "mediaType": "Image" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/labelingJobs/testLabelingJob", + "name": "testLabelingJob", + "type": "Microsoft.MachineLearningServices/workspaces/labelingJobs", + "properties": { + "jobType": "Labeling", + "description": "string", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "labelCategories": { + "myCategory1": { + "displayName": "myCategory1Title", + "multiSelectEnabled": true, + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + }, + "myCategory2": { + "displayName": "myCategory2Title", + "multiSelectEnabled": true, + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + } + }, + "jobInstructions": { + "uri": "link/to/instructions" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute", + "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute" + }, + "labelingJobMediaProperties": { + "mediaType": "Image" + }, + "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "status": "NotStarted", + "progressMetrics": { + "totalDatapointCount": 0, + "completedDatapointCount": 0, + "skippedDatapointCount": 0, + "incrementalDataLastRefreshDateTime": "2020-12-08T01:23:37.234Z" + }, + "statusMessages": [ + { + "level": "Error", + "code": "string", + "message": "string", + "createdDateTime": "2020-12-08T01:23:37.234Z" + } + ], + "createdDateTime": "2020-12-08T01:23:37.234Z" + }, + "systemData": { + "createdAt": "2020-12-08T01:23:37.235Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-08T01:23:37.235Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/labelingJobs/testLabelingJob", + "name": "testLabelingJob", + "type": "Microsoft.MachineLearningServices/workspaces/labelingJobs", + "properties": { + "jobType": "Labeling", + "description": "string", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "labelCategories": { + "myCategory1": { + "displayName": "myCategory1Title", + "multiSelectEnabled": true, + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + }, + "myCategory2": { + "displayName": "myCategory2Title", + "multiSelectEnabled": true, + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + } + }, + "jobInstructions": { + "uri": "link/to/instructions" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute", + "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute" + }, + "labelingJobMediaProperties": { + "mediaType": "Image" + }, + "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "status": "NotStarted", + "progressMetrics": { + "totalDatapointCount": 0, + "completedDatapointCount": 0, + "skippedDatapointCount": 0, + "incrementalDataLastRefreshDateTime": "2020-12-08T01:23:37.234Z" + }, + "statusMessages": [ + { + "level": "Error", + "code": "string", + "message": "string", + "createdDateTime": "2020-12-08T01:23:37.234Z" + } + ], + "createdDateTime": "2020-12-08T01:23:37.234Z" + }, + "systemData": { + "createdAt": "2020-12-08T01:23:37.235Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-08T01:23:37.235Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/delete.json new file mode 100644 index 000000000000..1ba8bb4c1baf --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2021-03-01-preview", + "id": "testLabelingJob" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/exportLabels.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/exportLabels.json new file mode 100644 index 000000000000..d66b0e3edf6e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/exportLabels.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2021-03-01-preview", + "id": "testLabelingJob", + "body": { + "format": "Dataset" + } + }, + "responses": { + "200": { + "body": { + "format": "Dataset", + "labelingJobId": "string", + "exportedRowCount": 0, + "startDateTime": "2021-02-08T23:34:40.730Z", + "endDateTime": "2021-02-08T23:34:40.730Z" + } + }, + "202": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/get.json new file mode 100644 index 000000000000..6a14474d19a9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/get.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2021-03-01-preview", + "id": "testLabelingJob", + "includeJobInstructions": true, + "includeLabelCategories": true + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/labelingJobs/testLabelingJob", + "name": "testLabelingJob", + "type": "Microsoft.MachineLearningServices/workspaces/labelingJobs", + "properties": { + "jobType": "Labeling", + "description": "string", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "labelCategories": { + "myCategory1": { + "displayName": "myCategory1Title", + "multiSelectEnabled": true, + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + }, + "myCategory2": { + "displayName": "myCategory2Title", + "multiSelectEnabled": true, + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + } + }, + "jobInstructions": { + "uri": "link/to/instructions" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute", + "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute" + }, + "labelingJobMediaProperties": { + "mediaType": "Image" + }, + "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "status": "NotStarted", + "progressMetrics": { + "totalDatapointCount": 0, + "completedDatapointCount": 0, + "skippedDatapointCount": 0, + "incrementalDataLastRefreshDateTime": "2020-12-08T01:23:37.234Z" + }, + "statusMessages": [ + { + "level": "Error", + "code": "string", + "message": "string", + "createdDateTime": "2020-12-08T01:23:37.234Z" + } + ], + "createdDateTime": "2020-12-08T01:23:37.234Z" + }, + "systemData": { + "createdAt": "2020-12-08T01:23:37.235Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-08T01:23:37.235Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/list.json new file mode 100644 index 000000000000..a31fc6cf816f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/list.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2021-03-01-preview", + "$skipToken": "skiptoken", + "count": "10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/labelingJobs/testLabelingJob", + "name": "testLabelingJob", + "type": "Microsoft.MachineLearningServices/workspaces/labelingJobs", + "properties": { + "jobType": "Labeling", + "description": "string", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "labelCategories": { + "myCategory1": { + "displayName": "myCategory1Title", + "multiSelectEnabled": true, + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + }, + "myCategory2": { + "displayName": "myCategory2Title", + "multiSelectEnabled": true, + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + } + }, + "jobInstructions": { + "uri": "link/to/instructions" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute", + "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute" + }, + "labelingJobMediaProperties": { + "mediaType": "Image" + }, + "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "status": "NotStarted", + "progressMetrics": { + "totalDatapointCount": 0, + "completedDatapointCount": 0, + "skippedDatapointCount": 0, + "incrementalDataLastRefreshDateTime": "2020-12-08T01:23:37.234Z" + }, + "statusMessages": [ + { + "level": "Error", + "code": "string", + "message": "string", + "createdDateTime": "2020-12-08T01:23:37.234Z" + } + ], + "createdDateTime": "2020-12-08T01:23:37.234Z" + }, + "systemData": { + "createdAt": "2020-12-08T01:23:37.235Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-08T01:23:37.235Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "nextlink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/pause.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/pause.json new file mode 100644 index 000000000000..604eb10453eb --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/pause.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2021-03-01-preview", + "id": "testLabelingJob" + }, + "responses": { + "200": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/resume.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/resume.json new file mode 100644 index 000000000000..2d9060120bdf --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/LabelingJob/resume.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2021-03-01-preview", + "id": "testLabelingJob" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Schedule/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Schedule/createOrUpdate.json new file mode 100644 index 000000000000..d60e6473abc2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Schedule/createOrUpdate.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2022-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "9965593e-526f-4b89-bb36-761138cf2794": null + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "d77a9a9a-4bb5-4c0c-8a77-459be8b82b9f": null + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "13ea51e0-ff28-49c3-a85d-9b5199eb14e5": null + } + }, + "provisioningState": "Failed" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Schedule/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Schedule/delete.json new file mode 100644 index 000000000000..e47dbc447bc5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Schedule/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2022-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Schedule/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Schedule/get.json new file mode 100644 index 000000000000..11835b068068 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Schedule/get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2022-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "a108545b-def1-4c86-8e53-dbcb1de3a8bc": null + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Schedule/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Schedule/list.json new file mode 100644 index 000000000000..a6a1c208bbcf --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/examples/Schedule/list.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2022-06-01-preview", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "00cd1396-a094-4d48-8d86-14c43a55a6af": null + } + }, + "provisioningState": "Deleting" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json index 611306f25621..ffb34281c516 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json @@ -3305,6 +3305,18 @@ } ] } + }, + { + "in": "query", + "name": "scheduled", + "description": "Indicator whether the job is scheduled job.", + "type": "boolean" + }, + { + "in": "query", + "name": "scheduleId", + "description": "The scheduled id for listing the job triggered from", + "type": "string" } ], "responses": { @@ -3325,6 +3337,9 @@ "List Command Job.": { "$ref": "./examples/Job/CommandJob/list.json" }, + "List AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/list.json" + }, "List Sweep Job.": { "$ref": "./examples/Job/SweepJob/list.json" }, @@ -3458,6 +3473,9 @@ "Get Command Job.": { "$ref": "./examples/Job/CommandJob/get.json" }, + "Get AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/get.json" + }, "Get Sweep Job.": { "$ref": "./examples/Job/SweepJob/get.json" }, @@ -3533,6 +3551,9 @@ "CreateOrUpdate Command Job.": { "$ref": "./examples/Job/CommandJob/createOrUpdate.json" }, + "CreateOrUpdate AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/createOrUpdate.json" + }, "CreateOrUpdate Sweep Job.": { "$ref": "./examples/Job/SweepJob/createOrUpdate.json" }, @@ -3611,13 +3632,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs": { "get": { "tags": [ - "ModelContainer" + "LabelingJob" ], - "summary": "List model containers.", - "operationId": "ModelContainers_List", + "summary": "Lists labeling jobs in the workspace.", + "operationId": "LabelingJobs_List", "produces": [ "application/json" ], @@ -3640,36 +3661,9 @@ { "in": "query", "name": "count", - "description": "Maximum number of results to return.", + "description": "Number of labeling jobs to return.", "type": "integer", "format": "int32" - }, - { - "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } } ], "responses": { @@ -3682,13 +3676,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + "$ref": "#/definitions/LabelingJobResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Model Container.": { - "$ref": "./examples/ModelContainer/list.json" + "List Labeling Job.": { + "$ref": "./examples/LabelingJob/list.json" } }, "x-ms-pageable": { @@ -3696,13 +3690,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}": { "delete": { "tags": [ - "ModelContainer" + "LabelingJob" ], - "summary": "Delete container.", - "operationId": "ModelContainers_Delete", + "summary": "Delete a labeling job.", + "operationId": "LabelingJobs_Delete", "produces": [ "application/json" ], @@ -3718,8 +3712,8 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the LabelingJob.", "required": true, "type": "string" }, @@ -3742,17 +3736,17 @@ } }, "x-ms-examples": { - "Delete Model Container.": { - "$ref": "./examples/ModelContainer/delete.json" + "Delete Labeling Job.": { + "$ref": "./examples/LabelingJob/delete.json" } } }, "get": { "tags": [ - "ModelContainer" + "LabelingJob" ], - "summary": "Get container.", - "operationId": "ModelContainers_Get", + "summary": "Gets a labeling job by name/id.", + "operationId": "LabelingJobs_Get", "produces": [ "application/json" ], @@ -3768,13 +3762,27 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the LabelingJob.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "includeJobInstructions", + "description": "Boolean value to indicate whether to include JobInstructions in response.", + "type": "boolean", + "default": false + }, + { + "in": "query", + "name": "includeLabelCategories", + "description": "Boolean value to indicate Whether to include LabelCategories in response.", + "type": "boolean", + "default": false } ], "responses": { @@ -3787,22 +3795,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/LabelingJobResource" } } }, "x-ms-examples": { - "Get Model Container.": { - "$ref": "./examples/ModelContainer/get.json" + "Get Labeling Job.": { + "$ref": "./examples/LabelingJob/get.json" } } }, "put": { "tags": [ - "ModelContainer" + "LabelingJob" ], - "summary": "Create or update container.", - "operationId": "ModelContainers_CreateOrUpdate", + "summary": "Creates or updates a labeling job (asynchronous).", + "operationId": "LabelingJobs_CreateOrUpdate", "consumes": [ "application/json" ], @@ -3821,8 +3829,8 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the LabelingJob.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -3833,10 +3841,10 @@ { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "LabelingJob definition object.", "required": true, "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/LabelingJobResource" } } ], @@ -3847,33 +3855,48 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "200": { - "description": "Success", + "201": { + "description": "Created", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/LabelingJobResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } } }, - "201": { - "description": "Created", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/LabelingJobResource" } } }, "x-ms-examples": { - "CreateOrUpdate Model Container.": { - "$ref": "./examples/ModelContainer/createOrUpdate.json" + "CreateOrUpdate Labeling Job.": { + "$ref": "./examples/LabelingJob/createOrUpdate.json" } - } + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/exportLabels": { + "post": { "tags": [ - "ModelVersion" + "LabelingJob" + ], + "summary": "Export labels from a labeling job (asynchronous).", + "operationId": "LabelingJobs_ExportLabels", + "consumes": [ + "application/json" ], - "summary": "List model versions.", - "operationId": "ModelVersions_List", "produces": [ "application/json" ], @@ -3889,8 +3912,8 @@ }, { "in": "path", - "name": "name", - "description": "Model name. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the LabelingJob.", "required": true, "type": "string" }, @@ -3898,83 +3921,12 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, - { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" - }, - { - "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", - "type": "integer", - "format": "int32" - }, - { - "in": "query", - "name": "version", - "description": "Model version.", - "type": "string" - }, - { - "in": "query", - "name": "description", - "description": "Model description.", - "type": "string" - }, - { - "in": "query", - "name": "offset", - "description": "Number of initial results to skip.", - "type": "integer", - "format": "int32" - }, - { - "in": "query", - "name": "tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" - }, - { - "in": "query", - "name": "properties", - "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", - "type": "string" - }, - { - "in": "query", - "name": "feed", - "description": "Name of the feed.", - "type": "string" - }, - { - "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] + "in": "body", + "name": "body", + "description": "The export summary.", + "required": true, + "schema": { + "$ref": "#/definitions/ExportSummary" } } ], @@ -3988,27 +3940,44 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + "$ref": "#/definitions/ExportSummary" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } } }, "x-ms-examples": { - "List Model Version.": { - "$ref": "./examples/ModelVersion/list.json" + "ExportLabels Labeling Job.": { + "$ref": "./examples/LabelingJob/exportLabels.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/pause": { + "post": { "tags": [ - "ModelVersion" + "LabelingJob" ], - "summary": "Delete version.", - "operationId": "ModelVersions_Delete", + "summary": "Pause a labeling job.", + "operationId": "LabelingJobs_Pause", "produces": [ "application/json" ], @@ -4024,15 +3993,8 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the LabelingJob.", "required": true, "type": "string" }, @@ -4049,23 +4011,22 @@ }, "200": { "description": "Success" - }, - "204": { - "description": "No Content" } }, "x-ms-examples": { - "Delete Model Version.": { - "$ref": "./examples/ModelVersion/delete.json" + "Pause Labeling Job.": { + "$ref": "./examples/LabelingJob/pause.json" } } - }, - "get": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/resume": { + "post": { "tags": [ - "ModelVersion" + "LabelingJob" ], - "summary": "Get version.", - "operationId": "ModelVersions_Get", + "summary": "Resume a labeling job (asynchronous).", + "operationId": "LabelingJobs_Resume", "produces": [ "application/json" ], @@ -4081,90 +4042,13 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ModelVersionResource" - } - } - }, - "x-ms-examples": { - "Get Model Version.": { - "$ref": "./examples/ModelVersion/get.json" - } - } - }, - "put": { - "tags": [ - "ModelVersion" - ], - "summary": "Create or update version.", - "operationId": "ModelVersions_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "name": "id", + "description": "The name and identifier for the LabelingJob.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Version entity to create or update.", - "required": true, - "schema": { - "$ref": "#/definitions/ModelVersionResource" - } } ], "responses": { @@ -4175,32 +4059,43 @@ } }, "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ModelVersionResource" - } + "description": "Success" }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ModelVersionResource" + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } } }, "x-ms-examples": { - "CreateOrUpdate Model Version.": { - "$ref": "./examples/ModelVersion/createOrUpdate.json" + "Resume Labeling Job.": { + "$ref": "./examples/LabelingJob/resume.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models": { "get": { "tags": [ - "OnlineEndpoint" + "ModelContainer" ], - "summary": "List Online Endpoints.", - "operationId": "OnlineEndpoints_List", + "summary": "List model containers.", + "operationId": "ModelContainers_List", "produces": [ "application/json" ], @@ -4218,62 +4113,40 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "name", - "description": "Name of the endpoint.", - "type": "string" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { "in": "query", "name": "count", - "description": "Number of endpoints to be retrieved in a page of results.", + "description": "Maximum number of results to return.", "type": "integer", "format": "int32" }, { "in": "query", - "name": "computeType", - "description": "EndpointComputeType to be filtered by.", - "type": "string", - "enum": [ - "Managed", - "Kubernetes", - "AzureMLCompute" - ], - "x-ms-enum": { - "name": "EndpointComputeType", - "modelAsString": true - } - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, - { - "in": "query", - "name": "tags", - "description": "A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .", - "type": "string" - }, - { - "in": "query", - "name": "properties", - "description": "A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .", - "type": "string" - }, - { - "in": "query", - "name": "orderBy", - "description": "The option to order the response.", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", "type": "string", + "default": "ActiveOnly", "enum": [ - "CreatedAtDesc", - "CreatedAtAsc", - "UpdatedAtDesc", - "UpdatedAtAsc" + "ActiveOnly", + "ArchivedOnly", + "All" ], "x-ms-enum": { - "name": "OrderString", - "modelAsString": true + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] } } ], @@ -4287,13 +4160,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResourceArmPaginatedResult" + "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Online Endpoint.": { - "$ref": "./examples/OnlineEndpoint/list.json" + "List Model Container.": { + "$ref": "./examples/ModelContainer/list.json" } }, "x-ms-pageable": { @@ -4301,13 +4174,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}": { "delete": { "tags": [ - "OnlineEndpoint" + "ModelContainer" ], - "summary": "Delete Online Endpoint (asynchronous).", - "operationId": "OnlineEndpoints_Delete", + "summary": "Delete container.", + "operationId": "ModelContainers_Delete", "produces": [ "application/json" ], @@ -4323,8 +4196,8 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -4339,47 +4212,25 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "204": { - "description": "No Content" - }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, "200": { "description": "Success" + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Delete Online Endpoint.": { - "$ref": "./examples/OnlineEndpoint/delete.json" + "Delete Model Container.": { + "$ref": "./examples/ModelContainer/delete.json" } - }, - "x-ms-long-running-operation": true + } }, "get": { "tags": [ - "OnlineEndpoint" + "ModelContainer" ], - "summary": "Get Online Endpoint.", - "operationId": "OnlineEndpoints_Get", + "summary": "Get container.", + "operationId": "ModelContainers_Get", "produces": [ "application/json" ], @@ -4395,8 +4246,8 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -4414,22 +4265,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" + "$ref": "#/definitions/ModelContainerResource" } } }, "x-ms-examples": { - "Get Online Endpoint.": { - "$ref": "./examples/OnlineEndpoint/get.json" + "Get Model Container.": { + "$ref": "./examples/ModelContainer/get.json" } } }, - "patch": { + "put": { "tags": [ - "OnlineEndpoint" + "ModelContainer" ], - "summary": "Update Online Endpoint (asynchronous).", - "operationId": "OnlineEndpoints_Update", + "summary": "Create or update container.", + "operationId": "ModelContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -4448,92 +4299,8 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", - "required": true, - "type": "string" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Online Endpoint entity to apply during operation.", - "required": true, - "schema": { - "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" - } - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" - } - }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - } - }, - "x-ms-examples": { - "Update Online Endpoint.": { - "$ref": "./examples/OnlineEndpoint/update.json" - } - }, - "x-ms-long-running-operation": true - }, - "put": { - "tags": [ - "OnlineEndpoint" - ], - "summary": "Create or update Online Endpoint (asynchronous).", - "operationId": "OnlineEndpoints_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -4544,10 +4311,10 @@ { "in": "body", "name": "body", - "description": "Online Endpoint entity to apply during operation.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" + "$ref": "#/definitions/ModelContainerResource" } } ], @@ -4561,42 +4328,30 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" + "$ref": "#/definitions/ModelContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" - }, - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", - "type": "string" - } + "$ref": "#/definitions/ModelContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate Online Endpoint.": { - "$ref": "./examples/OnlineEndpoint/createOrUpdate.json" + "CreateOrUpdate Model Container.": { + "$ref": "./examples/ModelContainer/createOrUpdate.json" } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions": { "get": { "tags": [ - "OnlineDeployment" + "ModelVersion" ], - "summary": "List Inference Endpoint Deployments.", - "operationId": "OnlineDeployments_List", + "summary": "List model versions.", + "operationId": "ModelVersions_List", "produces": [ "application/json" ], @@ -4612,14 +4367,17 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference endpoint name.", + "name": "name", + "description": "Model name. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, { "in": "query", "name": "$orderBy", @@ -4629,12 +4387,73 @@ { "in": "query", "name": "$top", - "description": "Top of list.", + "description": "Maximum number of records to return.", "type": "integer", "format": "int32" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "query", + "name": "version", + "description": "Model version.", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "Model description.", + "type": "string" + }, + { + "in": "query", + "name": "offset", + "description": "Number of initial results to skip.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" + }, + { + "in": "query", + "name": "feed", + "description": "Name of the feed.", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } } ], "responses": { @@ -4647,13 +4466,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResourceArmPaginatedResult" + "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Online Deployments.": { - "$ref": "./examples/OnlineDeployment/list.json" + "List Model Version.": { + "$ref": "./examples/ModelVersion/list.json" } }, "x-ms-pageable": { @@ -4661,13 +4480,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}": { "delete": { "tags": [ - "OnlineDeployment" + "ModelVersion" ], - "summary": "Delete Inference Endpoint Deployment (asynchronous).", - "operationId": "OnlineDeployments_Delete", + "summary": "Delete version.", + "operationId": "ModelVersions_Delete", "produces": [ "application/json" ], @@ -4683,15 +4502,15 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "in": "path", - "name": "deploymentName", - "description": "Inference Endpoint Deployment name.", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -4711,42 +4530,20 @@ }, "204": { "description": "No Content" - }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } } }, "x-ms-examples": { - "Delete Online Deployment.": { - "$ref": "./examples/OnlineDeployment/delete.json" + "Delete Model Version.": { + "$ref": "./examples/ModelVersion/delete.json" } - }, - "x-ms-long-running-operation": true + } }, "get": { "tags": [ - "OnlineDeployment" + "ModelVersion" ], - "summary": "Get Inference Deployment Deployment.", - "operationId": "OnlineDeployments_Get", + "summary": "Get version.", + "operationId": "ModelVersions_Get", "produces": [ "application/json" ], @@ -4762,16 +4559,16 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "in": "path", - "name": "deploymentName", - "description": "Inference Endpoint Deployment name.", - "required": true, + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, "type": "string" }, { @@ -4788,25 +4585,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" + "$ref": "#/definitions/ModelVersionResource" } } }, "x-ms-examples": { - "Get Managed Online Deployment.": { - "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/get.json" - }, - "Get Kubernetes Online Deployment.": { - "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/get.json" + "Get Model Version.": { + "$ref": "./examples/ModelVersion/get.json" } } }, - "patch": { + "put": { "tags": [ - "OnlineDeployment" + "ModelVersion" ], - "summary": "Update Online Deployment (asynchronous).", - "operationId": "OnlineDeployments_Update", + "summary": "Create or update version.", + "operationId": "ModelVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -4825,19 +4619,18 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", - "name": "deploymentName", - "description": "Inference Endpoint Deployment name.", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -4845,10 +4638,10 @@ { "in": "body", "name": "body", - "description": "Online Endpoint entity to apply during operation.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/PartialMinimalTrackedResourceWithSku" + "$ref": "#/definitions/ModelVersionResource" } } ], @@ -4862,50 +4655,30 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" + "$ref": "#/definitions/ModelVersionResource" } }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelVersionResource" } } }, "x-ms-examples": { - "Update Managed Online Deployment.": { - "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/update.json" - }, - "Update Kubernetes Online Deployment.": { - "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/update.json" + "CreateOrUpdate Model Version.": { + "$ref": "./examples/ModelVersion/createOrUpdate.json" } - }, - "x-ms-long-running-operation": true - }, - "put": { + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints": { + "get": { "tags": [ - "OnlineDeployment" - ], - "summary": "Create or update Inference Endpoint Deployment (asynchronous).", - "operationId": "OnlineDeployments_CreateOrUpdate", - "consumes": [ - "application/json" + "OnlineEndpoint" ], + "summary": "List Online Endpoints.", + "operationId": "OnlineEndpoints_List", "produces": [ "application/json" ], @@ -4920,31 +4693,65 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "path", - "name": "endpointName", - "description": "Inference endpoint name.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "path", - "name": "deploymentName", - "description": "Inference Endpoint Deployment name.", - "required": true, + "in": "query", + "name": "name", + "description": "Name of the endpoint.", + "type": "string" + }, + { + "in": "query", + "name": "count", + "description": "Number of endpoints to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "computeType", + "description": "EndpointComputeType to be filtered by.", "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "enum": [ + "Managed", + "Kubernetes", + "AzureMLCompute" + ], + "x-ms-enum": { + "name": "EndpointComputeType", + "modelAsString": true + } }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { - "in": "body", - "name": "body", - "description": "Inference Endpoint entity to apply during operation.", - "required": true, - "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" + "in": "query", + "name": "tags", + "description": "A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "The option to order the response.", + "type": "string", + "enum": [ + "CreatedAtDesc", + "CreatedAtAsc", + "UpdatedAtDesc", + "UpdatedAtAsc" + ], + "x-ms-enum": { + "name": "OrderString", + "modelAsString": true } } ], @@ -4958,48 +4765,27 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" - }, - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", - "type": "string" - } + "$ref": "#/definitions/OnlineEndpointTrackedResourceArmPaginatedResult" } } }, "x-ms-examples": { - "CreateOrUpdate Managed Online Deployment.": { - "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json" - }, - "CreateOrUpdate Kubernetes Online Deployment.": { - "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json" + "List Online Endpoint.": { + "$ref": "./examples/OnlineEndpoint/list.json" } }, - "x-ms-long-running-operation": true + "x-ms-pageable": { + "nextLinkName": "nextLink" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/getLogs": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}": { + "delete": { "tags": [ - "OnlineDeployment" - ], - "summary": "Polls an Endpoint operation.", - "operationId": "OnlineDeployments_GetLogs", - "consumes": [ - "application/json" + "OnlineEndpoint" ], + "summary": "Delete Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_Delete", "produces": [ "application/json" ], @@ -5016,28 +4802,12 @@ { "in": "path", "name": "endpointName", - "description": "Inference endpoint name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "deploymentName", - "description": "The name and identifier for the endpoint.", + "description": "Online Endpoint name.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "The request containing parameters for retrieving logs.", - "required": true, - "schema": { - "$ref": "#/definitions/DeploymentLogsRequest" - } } ], "responses": { @@ -5047,27 +4817,47 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeploymentLogs" + "204": { + "description": "No Content" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } + }, + "200": { + "description": "Success" } }, "x-ms-examples": { - "Get Online Deployment Logs.": { - "$ref": "./examples/OnlineDeployment/getLogs.json" + "Delete Online Endpoint.": { + "$ref": "./examples/OnlineEndpoint/delete.json" } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/skus": { + }, + "x-ms-long-running-operation": true + }, "get": { "tags": [ - "OnlineDeployment" + "OnlineEndpoint" ], - "summary": "List Inference Endpoint Deployment Skus.", - "operationId": "OnlineDeployments_ListSkus", + "summary": "Get Online Endpoint.", + "operationId": "OnlineEndpoints_Get", "produces": [ "application/json" ], @@ -5084,29 +4874,12 @@ { "in": "path", "name": "endpointName", - "description": "Inference endpoint name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "deploymentName", - "description": "Inference Endpoint Deployment name.", + "description": "Online Endpoint name.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "query", - "name": "count", - "description": "Number of Skus to be retrieved in a page of results.", - "type": "integer", - "format": "int32" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { @@ -5119,30 +4892,25 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/SkuResourceArmPaginatedResult" + "$ref": "#/definitions/OnlineEndpointTrackedResource" } } }, "x-ms-examples": { - "List Managed Online Deployment Skus.": { - "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json" - }, - "List Kubernetes Online Deployment Skus.": { - "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json" + "Get Online Endpoint.": { + "$ref": "./examples/OnlineEndpoint/get.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/listKeys": { - "post": { + }, + "patch": { "tags": [ "OnlineEndpoint" ], - "summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.", - "operationId": "OnlineEndpoints_ListKeys", + "summary": "Update Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_Update", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -5165,6 +4933,15 @@ }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" + } } ], "responses": { @@ -5177,24 +4954,44 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EndpointAuthKeys" + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } } }, "x-ms-examples": { - "ListKeys Online Endpoint.": { - "$ref": "./examples/OnlineEndpoint/listKeys.json" + "Update Online Endpoint.": { + "$ref": "./examples/OnlineEndpoint/update.json" } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/regenerateKeys": { - "post": { + }, + "x-ms-long-running-operation": true + }, + "put": { "tags": [ "OnlineEndpoint" ], - "summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).", - "operationId": "OnlineEndpoints_RegenerateKeys", + "summary": "Create or update Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_CreateOrUpdate", "consumes": [ "application/json" ], @@ -5216,7 +5013,8 @@ "name": "endpointName", "description": "Online Endpoint name.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -5224,10 +5022,10 @@ { "in": "body", "name": "body", - "description": "RegenerateKeys request .", + "description": "Online Endpoint entity to apply during operation.", "required": true, "schema": { - "$ref": "#/definitions/RegenerateEndpointKeysRequest" + "$ref": "#/definitions/OnlineEndpointTrackedResource" } } ], @@ -5239,43 +5037,44 @@ } }, "200": { - "description": "Success" + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } }, - "202": { - "description": "Accepted", + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + }, "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" } } } }, "x-ms-examples": { - "RegenerateKeys Online Endpoint.": { - "$ref": "./examples/OnlineEndpoint/regenerateKeys.json" + "CreateOrUpdate Online Endpoint.": { + "$ref": "./examples/OnlineEndpoint/createOrUpdate.json" } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/token": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments": { + "get": { "tags": [ - "OnlineEndpoint" + "OnlineDeployment" ], - "summary": "Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication.", - "operationId": "OnlineEndpoints_GetToken", + "summary": "List Inference Endpoint Deployments.", + "operationId": "OnlineDeployments_List", "produces": [ "application/json" ], @@ -5292,12 +5091,28 @@ { "in": "path", "name": "endpointName", - "description": "Online Endpoint name.", + "description": "Inference endpoint name.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top of list.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { @@ -5310,123 +5125,3645 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EndpointAuthToken" + "$ref": "#/definitions/OnlineDeploymentTrackedResourceArmPaginatedResult" } } }, "x-ms-examples": { - "GetToken Online Endpoint.": { - "$ref": "./examples/OnlineEndpoint/getToken.json" + "List Online Deployments.": { + "$ref": "./examples/OnlineDeployment/list.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } - } - }, - "definitions": { - "AccountKeyDatastoreCredentials": { - "description": "Account key datastore credentials configuration.", - "required": [ - "secrets" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatastoreCredentials" - } - ], - "properties": { - "secrets": { - "description": "[Required] Storage account secrets.", - "$ref": "#/definitions/AccountKeyDatastoreSecrets", - "x-ms-mutability": [ - "create", - "update" - ], - "x-ms-secret": true - } - }, - "x-ms-discriminator-value": "AccountKey", - "additionalProperties": false - }, - "AccountKeyDatastoreSecrets": { - "description": "Datastore account key secrets.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatastoreSecrets" - } - ], - "properties": { - "key": { - "description": "Storage account key.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-discriminator-value": "AccountKey", - "additionalProperties": false - }, - "AmlToken": { - "description": "AML Token identity configuration.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/IdentityConfiguration" - } - ], - "x-ms-discriminator-value": "AMLToken", - "additionalProperties": false }, - "AssetBase": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ResourceBase" - } - ], - "properties": { - "isAnonymous": { - "description": "If the name version are system generated (anonymous registration).", - "default": false, - "type": "boolean", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "isArchived": { - "description": "Is the asset archived?", - "default": false, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}": { + "delete": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Delete Inference Endpoint Deployment (asynchronous).", + "operationId": "OnlineDeployments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Delete Online Deployment.": { + "$ref": "./examples/OnlineDeployment/delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Get Inference Deployment Deployment.", + "operationId": "OnlineDeployments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + } + }, + "x-ms-examples": { + "Get Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/get.json" + }, + "Get Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/get.json" + } + } + }, + "patch": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Update Online Deployment (asynchronous).", + "operationId": "OnlineDeployments_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithSku" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Update Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/update.json" + }, + "Update Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Create or update Inference Endpoint Deployment (asynchronous).", + "operationId": "OnlineDeployments_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Inference Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json" + }, + "CreateOrUpdate Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/getLogs": { + "post": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Polls an Endpoint operation.", + "operationId": "OnlineDeployments_GetLogs", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The name and identifier for the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The request containing parameters for retrieving logs.", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentLogsRequest" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentLogs" + } + } + }, + "x-ms-examples": { + "Get Online Deployment Logs.": { + "$ref": "./examples/OnlineDeployment/getLogs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/skus": { + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "List Inference Endpoint Deployment Skus.", + "operationId": "OnlineDeployments_ListSkus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "count", + "description": "Number of Skus to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SkuResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Managed Online Deployment Skus.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json" + }, + "List Kubernetes Online Deployment Skus.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/listKeys": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.", + "operationId": "OnlineEndpoints_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } + } + }, + "x-ms-examples": { + "ListKeys Online Endpoint.": { + "$ref": "./examples/OnlineEndpoint/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/regenerateKeys": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).", + "operationId": "OnlineEndpoints_RegenerateKeys", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "RegenerateKeys request .", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateEndpointKeysRequest" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "RegenerateKeys Online Endpoint.": { + "$ref": "./examples/OnlineEndpoint/regenerateKeys.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/token": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication.", + "operationId": "OnlineEndpoints_GetToken", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthToken" + } + } + }, + "x-ms-examples": { + "GetToken Online Endpoint.": { + "$ref": "./examples/OnlineEndpoint/getToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules": { + "get": { + "tags": [ + "Schedule" + ], + "summary": "List schedules in specified workspace.", + "operationId": "Schedules_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Schedules.": { + "$ref": "./examples/Schedule/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}": { + "delete": { + "tags": [ + "Schedule" + ], + "summary": "Delete schedule.", + "operationId": "Schedules_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Schedule.": { + "$ref": "./examples/Schedule/delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Schedule" + ], + "summary": "Get schedule.", + "operationId": "Schedules_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + } + }, + "x-ms-examples": { + "Get Schedule.": { + "$ref": "./examples/Schedule/get.json" + } + } + }, + "put": { + "tags": [ + "Schedule" + ], + "summary": "Create or update schedule.", + "operationId": "Schedules_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Schedule definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ScheduleResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Schedule.": { + "$ref": "./examples/Schedule/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AccountKeyDatastoreCredentials": { + "description": "Account key datastore credentials configuration.", + "required": [ + "secrets" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "secrets": { + "description": "[Required] Storage account secrets.", + "$ref": "#/definitions/AccountKeyDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + }, + "x-ms-discriminator-value": "AccountKey", + "additionalProperties": false + }, + "AccountKeyDatastoreSecrets": { + "description": "Datastore account key secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "key": { + "description": "Storage account key.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "AccountKey", + "additionalProperties": false + }, + "AmlToken": { + "description": "AML Token identity configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IdentityConfiguration" + } + ], + "x-ms-discriminator-value": "AMLToken", + "additionalProperties": false + }, + "AssetBase": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "isAnonymous": { + "description": "If the name version are system generated (anonymous registration).", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "isArchived": { + "description": "Is the asset archived?", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "additionalProperties": false + }, + "AssetContainer": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "isArchived": { + "description": "Is the asset archived?", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "latestVersion": { + "description": "The latest version inside this container.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "nextVersion": { + "description": "The next auto incremental version", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AssetJobInput": { + "description": "Asset input type.", + "required": [ + "uri" + ], + "type": "object", + "properties": { + "mode": { + "description": "Input Asset Delivery Mode.", + "default": "ReadOnlyMount", + "$ref": "#/definitions/InputDeliveryMode", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "uri": { + "description": "[Required] Input Asset URI.", + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "additionalProperties": false + }, + "AssetJobOutput": { + "description": "Asset output type.", + "type": "object", + "properties": { + "mode": { + "description": "Output Asset Delivery Mode.", + "default": "ReadWriteMount", + "$ref": "#/definitions/OutputDeliveryMode", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "uri": { + "description": "Output Asset URI.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AssetReferenceBase": { + "description": "Base definition for asset references.", + "required": [ + "referenceType" + ], + "type": "object", + "properties": { + "referenceType": { + "description": "[Required] Specifies the type of asset reference.", + "$ref": "#/definitions/ReferenceType" + } + }, + "discriminator": "referenceType" + }, + "AutoForecastHorizon": { + "description": "Forecast horizon determined automatically by system.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ForecastHorizon" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutoMLJob": { + "description": "AutoMLJob class.\r\nUse this class for executing AutoML tasks like Classification/Regression etc.\r\nSee TaskType enum for all the tasks supported.", + "required": [ + "taskDetails" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "environmentId": { + "description": "The ARM resource ID of the Environment specification for the job.\r\nThis is optional value to provide, if not provided, AutoML will default this to Production AutoML curated environment version when running the job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "taskDetails": { + "description": "[Required] This represents scenario which can be one of Tables/NLP/Image", + "$ref": "#/definitions/AutoMLVertical" + } + }, + "x-ms-discriminator-value": "AutoML", + "additionalProperties": false + }, + "AutoMLVertical": { + "description": "AutoML vertical class.\r\nBase class for AutoML verticals - TableVertical/ImageVertical/NLPVertical", + "required": [ + "taskType", + "trainingData" + ], + "type": "object", + "properties": { + "logVerbosity": { + "description": "Log verbosity for the job.", + "default": "Info", + "$ref": "#/definitions/LogVerbosity" + }, + "targetColumnName": { + "description": "Target column name: This is prediction values column.\r\nAlso known as label column name in context of classification tasks.", + "type": "string", + "x-nullable": true + }, + "taskType": { + "description": "[Required] Task type for AutoMLJob.", + "$ref": "#/definitions/TaskType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "trainingData": { + "description": "[Required] Training data input.", + "$ref": "#/definitions/MLTableJobInput" + } + }, + "discriminator": "taskType" + }, + "AutoNCrossValidations": { + "description": "N-Cross validations determined automatically.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NCrossValidations" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutoSeasonality": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Seasonality" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutoTargetLags": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetLags" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutoTargetRollingWindowSize": { + "description": "Target lags rolling window determined automatically.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetRollingWindowSize" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AzureBlobDatastore": { + "description": "Azure Blob datastore configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "accountName": { + "description": "Storage account name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "containerName": { + "description": "Storage account container name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "endpoint": { + "description": "Azure cloud endpoint for the storage account.", + "type": "string", + "example": "core.windows.net", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "protocol": { + "description": "Protocol used to communicate with the storage account.", + "type": "string", + "example": "https", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "AzureBlob", + "additionalProperties": false + }, + "AzureDataLakeGen1Datastore": { + "description": "Azure Data Lake Gen1 datastore configuration.", + "required": [ + "storeName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "storeName": { + "description": "[Required] Azure Data Lake store name.", + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "AzureDataLakeGen1", + "additionalProperties": false + }, + "AzureDataLakeGen2Datastore": { + "description": "Azure Data Lake Gen2 datastore configuration.", + "required": [ + "accountName", + "filesystem" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "accountName": { + "description": "[Required] Storage account name.", + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "endpoint": { + "description": "Azure cloud endpoint for the storage account.", + "type": "string", + "example": "core.windows.net", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "filesystem": { + "description": "[Required] The name of the Data Lake Gen2 filesystem.", + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "protocol": { + "description": "Protocol used to communicate with the storage account.", + "type": "string", + "example": "https", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "AzureDataLakeGen2", + "additionalProperties": false + }, + "AzureDatastore": { + "description": "Base definition for Azure datastore contents configuration.", + "type": "object", + "properties": { + "resourceGroup": { + "description": "Azure Resource Group name", + "type": "string", + "x-nullable": true + }, + "subscriptionId": { + "description": "Azure Subscription Id", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AzureFileDatastore": { + "description": "Azure File datastore configuration.", + "required": [ + "accountName", + "fileShareName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "accountName": { + "description": "[Required] Storage account name.", + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "endpoint": { + "description": "Azure cloud endpoint for the storage account.", + "type": "string", + "example": "core.windows.net", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "fileShareName": { + "description": "[Required] The name of the Azure file share that the datastore points to.", + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "protocol": { + "description": "Protocol used to communicate with the storage account.", + "type": "string", + "example": "https", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "AzureFile", + "additionalProperties": false + }, + "BanditPolicy": { + "description": "Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EarlyTerminationPolicy" + } + ], + "properties": { + "slackAmount": { + "format": "float", + "description": "Absolute distance allowed from the best performing run.", + "default": 0, + "type": "number" + }, + "slackFactor": { + "format": "float", + "description": "Ratio of the allowed distance from the best performing run.", + "default": 0, + "type": "number" + } + }, + "x-ms-discriminator-value": "Bandit", + "additionalProperties": false + }, + "BatchDeployment": { + "description": "Batch inference settings per deployment.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointDeploymentPropertiesBase" + } + ], + "properties": { + "compute": { + "description": "Compute target for batch inference operation.", + "type": "string", + "x-nullable": true + }, + "errorThreshold": { + "format": "int32", + "description": "Error threshold, if the error count for the entire input goes above this value,\r\nthe batch inference will be aborted. Range is [-1, int.MaxValue].\r\nFor FileDataset, this value is the count of file failures.\r\nFor TabularDataset, this value is the count of record failures.\r\nIf set to -1 (the lower bound), all failures during batch inference will be ignored.", + "default": -1, + "type": "integer" + }, + "loggingLevel": { + "description": "Logging level for batch inference operation.", + "default": "Info", + "$ref": "#/definitions/BatchLoggingLevel" + }, + "maxConcurrencyPerInstance": { + "format": "int32", + "description": "Indicates maximum number of parallelism per instance.", + "default": 1, + "type": "integer" + }, + "miniBatchSize": { + "format": "int64", + "description": "Size of the mini-batch passed to each batch invocation.\r\nFor FileDataset, this is the number of files per mini-batch.\r\nFor TabularDataset, this is the size of the records in bytes, per mini-batch.", + "default": 10, + "type": "integer" + }, + "model": { + "description": "Reference to the model asset for the endpoint deployment.", + "$ref": "#/definitions/AssetReferenceBase", + "x-nullable": true + }, + "outputAction": { + "description": "Indicates how the output will be organized.", + "default": "AppendRow", + "$ref": "#/definitions/BatchOutputAction" + }, + "outputFileName": { + "description": "Customized output file name for append_row output action.", + "default": "predictions.csv", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state for the endpoint deployment.", + "$ref": "#/definitions/DeploymentProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "resources": { + "description": "Indicates compute configuration for the job.\r\nIf not provided, will default to the defaults defined in ResourceConfiguration.", + "$ref": "#/definitions/DeploymentResourceConfiguration", + "x-nullable": true + }, + "retrySettings": { + "description": "Retry Settings for the batch inference operation.\r\nIf not provided, will default to the defaults defined in BatchRetrySettings.", + "$ref": "#/definitions/BatchRetrySettings", + "x-nullable": true + } + }, + "x-ms-client-name": "BatchDeploymentProperties", + "additionalProperties": false + }, + "BatchDeploymentTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/BatchDeployment" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "BatchDeployment", + "additionalProperties": false + }, + "BatchDeploymentTrackedResourceArmPaginatedResult": { + "description": "A paginated list of BatchDeployment entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of BatchDeployment objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type BatchDeployment.", + "type": "array", + "items": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } + } + }, + "additionalProperties": false + }, + "BatchEndpoint": { + "description": "Batch endpoint configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointPropertiesBase" + } + ], + "properties": { + "defaults": { + "description": "Default values for Batch Endpoint", + "$ref": "#/definitions/BatchEndpointDefaults", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the endpoint.", + "$ref": "#/definitions/EndpointProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "BatchEndpointProperties", + "additionalProperties": false + }, + "BatchEndpointDefaults": { + "description": "Batch endpoint default values", + "type": "object", + "properties": { + "deploymentName": { + "description": "Name of the deployment that will be default for the endpoint.\r\nThis deployment will end up getting 100% traffic when the endpoint scoring URL is invoked.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "BatchEndpointTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/BatchEndpoint" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "BatchEndpoint", + "additionalProperties": false + }, + "BatchEndpointTrackedResourceArmPaginatedResult": { + "description": "A paginated list of BatchEndpoint entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of BatchEndpoint objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type BatchEndpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + } + }, + "additionalProperties": false + }, + "BatchLoggingLevel": { + "description": "Log verbosity for batch inferencing.\r\nIncreasing verbosity order for logging is : Warning, Info and Debug.\r\nThe default value is Info.", + "enum": [ + "Info", + "Warning", + "Debug" + ], + "type": "string", + "x-ms-enum": { + "name": "BatchLoggingLevel", + "modelAsString": true, + "values": [ + { + "value": "Info" + }, + { + "value": "Warning" + }, + { + "value": "Debug" + } + ] + }, + "additionalProperties": false + }, + "BatchOutputAction": { + "description": "Enum to determine how batch inferencing will handle output", + "enum": [ + "SummaryOnly", + "AppendRow" + ], + "type": "string", + "x-ms-enum": { + "name": "BatchOutputAction", + "modelAsString": true, + "values": [ + { + "value": "SummaryOnly" + }, + { + "value": "AppendRow" + } + ] + }, + "additionalProperties": false + }, + "BatchRetrySettings": { + "description": "Retry settings for a batch inference operation.", + "type": "object", + "properties": { + "maxRetries": { + "format": "int32", + "description": "Maximum retry count for a mini-batch", + "default": 3, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "Invocation timeout for a mini-batch, in ISO 8601 format.", + "default": "PT30S", + "type": "string" + } + }, + "additionalProperties": false + }, + "BayesianSamplingAlgorithm": { + "description": "Defines a Sampling Algorithm that generates values based on previous values", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SamplingAlgorithm" + } + ], + "x-ms-discriminator-value": "Bayesian", + "additionalProperties": false + }, + "BlockedTransformers": { + "description": "Enum for all classification models supported by AutoML.", + "enum": [ + "TextTargetEncoder", + "OneHotEncoder", + "CatTargetEncoder", + "TfIdf", + "WoETargetEncoder", + "LabelEncoder", + "WordEmbedding", + "NaiveBayes", + "CountVectorizer", + "HashOneHotEncoder" + ], + "type": "string", + "x-ms-enum": { + "name": "BlockedTransformers", + "modelAsString": true, + "values": [ + { + "value": "TextTargetEncoder", + "description": "Target encoding for text data." + }, + { + "value": "OneHotEncoder", + "description": "Ohe hot encoding creates a binary feature transformation." + }, + { + "value": "CatTargetEncoder", + "description": "Target encoding for categorical data." + }, + { + "value": "TfIdf", + "description": "Tf-Idf stands for, term-frequency times inverse document-frequency. This is a common term weighting scheme for identifying information from documents." + }, + { + "value": "WoETargetEncoder", + "description": "Weight of Evidence encoding is a technique used to encode categorical variables. It uses the natural log of the P(1)/P(0) to create weights." + }, + { + "value": "LabelEncoder", + "description": "Label encoder converts labels/categorical variables in a numerical form." + }, + { + "value": "WordEmbedding", + "description": "Word embedding helps represents words or phrases as a vector, or a series of numbers." + }, + { + "value": "NaiveBayes", + "description": "Naive Bayes is a classified that is used for classification of discrete features that are categorically distributed." + }, + { + "value": "CountVectorizer", + "description": "Count Vectorizer converts a collection of text documents to a matrix of token counts." + }, + { + "value": "HashOneHotEncoder", + "description": "Hashing One Hot Encoder can turn categorical variables into a limited number of new features. This is often used for high-cardinality categorical features." + } + ] + }, + "additionalProperties": false + }, + "BuildContext": { + "description": "Configuration settings for Docker build context", + "required": [ + "contextUri" + ], + "type": "object", + "properties": { + "contextUri": { + "description": "[Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs.\r\n", + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "example": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dockerfilePath": { + "description": "Path to the Dockerfile in the build context.\r\n", + "default": "Dockerfile", + "type": "string", + "example": "prod/Dockerfile", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "CertificateDatastoreCredentials": { + "description": "Certificate datastore credentials configuration.", + "required": [ + "clientId", + "secrets", + "tenantId", + "thumbprint" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "authorityUrl": { + "description": "Authority URL used for authentication.", + "type": "string", + "x-nullable": true + }, + "clientId": { + "format": "uuid", + "description": "[Required] Service principal client ID.", + "type": "string" + }, + "resourceUrl": { + "description": "Resource the service principal has access to.", + "type": "string", + "x-nullable": true + }, + "secrets": { + "description": "[Required] Service principal secrets.", + "$ref": "#/definitions/CertificateDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "tenantId": { + "format": "uuid", + "description": "[Required] ID of the tenant to which the service principal belongs.", + "type": "string" + }, + "thumbprint": { + "description": "[Required] Thumbprint of the certificate used for authentication.", + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "Certificate", + "additionalProperties": false + }, + "CertificateDatastoreSecrets": { + "description": "Datastore certificate secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "certificate": { + "description": "Service principal certificate.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Certificate", + "additionalProperties": false + }, + "Classification": { + "description": "Classification task in AutoML Table vertical.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TableVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "positiveLabel": { + "description": "Positive label for binary metrics calculation.", + "type": "string", + "x-nullable": true + }, + "primaryMetric": { + "description": "Primary metric for the task.", + "default": "AUCWeighted", + "$ref": "#/definitions/ClassificationPrimaryMetrics" + }, + "trainingSettings": { + "description": "Inputs for training phase for an AutoML Job.", + "$ref": "#/definitions/ClassificationTrainingSettings", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Classification", + "additionalProperties": false + }, + "ClassificationModels": { + "description": "Enum for all classification models supported by AutoML.", + "enum": [ + "LogisticRegression", + "SGD", + "MultinomialNaiveBayes", + "BernoulliNaiveBayes", + "SVM", + "LinearSVM", + "KNN", + "DecisionTree", + "RandomForest", + "ExtremeRandomTrees", + "LightGBM", + "GradientBoosting", + "XGBoostClassifier" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationModels", + "modelAsString": true, + "values": [ + { + "value": "LogisticRegression", + "description": "Logistic regression is a fundamental classification technique.\nIt belongs to the group of linear classifiers and is somewhat similar to polynomial and linear regression.\nLogistic regression is fast and relatively uncomplicated, and it's convenient for you to interpret the results.\nAlthough it's essentially a method for binary classification, it can also be applied to multiclass problems." + }, + { + "value": "SGD", + "description": "SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications\nto find the model parameters that correspond to the best fit between predicted and actual outputs." + }, + { + "value": "MultinomialNaiveBayes", + "description": "The multinomial Naive Bayes classifier is suitable for classification with discrete features (e.g., word counts for text classification).\nThe multinomial distribution normally requires integer feature counts. However, in practice, fractional counts such as tf-idf may also work." + }, + { + "value": "BernoulliNaiveBayes", + "description": "Naive Bayes classifier for multivariate Bernoulli models." + }, + { + "value": "SVM", + "description": "A support vector machine (SVM) is a supervised machine learning model that uses classification algorithms for two-group classification problems.\nAfter giving an SVM model sets of labeled training data for each category, they're able to categorize new text." + }, + { + "value": "LinearSVM", + "description": "A support vector machine (SVM) is a supervised machine learning model that uses classification algorithms for two-group classification problems.\nAfter giving an SVM model sets of labeled training data for each category, they're able to categorize new text.\nLinear SVM performs best when input data is linear, i.e., data can be easily classified by drawing the straight line between classified values on a plotted graph." + }, + { + "value": "KNN", + "description": "K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints\nwhich further means that the new data point will be assigned a value based on how closely it matches the points in the training set." + }, + { + "value": "DecisionTree", + "description": "Decision Trees are a non-parametric supervised learning method used for both classification and regression tasks.\nThe goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from the data features." + }, + { + "value": "RandomForest", + "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the “bagging” method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." + }, + { + "value": "ExtremeRandomTrees", + "description": "Extreme Trees is an ensemble machine learning algorithm that combines the predictions from many decision trees. It is related to the widely used random forest algorithm." + }, + { + "value": "LightGBM", + "description": "LightGBM is a gradient boosting framework that uses tree based learning algorithms." + }, + { + "value": "GradientBoosting", + "description": "The technique of transiting week learners into a strong learner is called Boosting. The gradient boosting algorithm process works on this theory of execution." + }, + { + "value": "XGBoostClassifier", + "description": "XGBoost: Extreme Gradient Boosting Algorithm. This algorithm is used for structured data where target column values can be divided into distinct class values." + } + ] + }, + "additionalProperties": false + }, + "ClassificationMultilabelPrimaryMetrics": { + "description": "Primary metrics for classification multilabel tasks.", + "enum": [ + "AUCWeighted", + "Accuracy", + "NormMacroRecall", + "AveragePrecisionScoreWeighted", + "PrecisionScoreWeighted", + "IOU" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationMultilabelPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "AUCWeighted", + "description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class." + }, + { + "value": "Accuracy", + "description": "Accuracy is the ratio of predictions that exactly match the true class labels." + }, + { + "value": "NormMacroRecall", + "description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1." + }, + { + "value": "AveragePrecisionScoreWeighted", + "description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class." + }, + { + "value": "PrecisionScoreWeighted", + "description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class." + }, + { + "value": "IOU", + "description": "Intersection Over Union. Intersection of predictions divided by union of predictions." + } + ] + }, + "additionalProperties": false + }, + "ClassificationPrimaryMetrics": { + "description": "Primary metrics for classification tasks.", + "enum": [ + "AUCWeighted", + "Accuracy", + "NormMacroRecall", + "AveragePrecisionScoreWeighted", + "PrecisionScoreWeighted" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "AUCWeighted", + "description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class." + }, + { + "value": "Accuracy", + "description": "Accuracy is the ratio of predictions that exactly match the true class labels." + }, + { + "value": "NormMacroRecall", + "description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1." + }, + { + "value": "AveragePrecisionScoreWeighted", + "description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class." + }, + { + "value": "PrecisionScoreWeighted", + "description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class." + } + ] + }, + "additionalProperties": false + }, + "ClassificationTrainingSettings": { + "description": "Classification Training related configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrainingSettings" + } + ], + "properties": { + "allowedTrainingAlgorithms": { + "description": "Allowed models for classification task.", + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationModels" + }, + "x-nullable": true + }, + "blockedTrainingAlgorithms": { + "description": "Blocked models for classification task.", + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationModels" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "CocoExportSummary": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSummary" + } + ], + "properties": { + "containerName": { + "description": "The container name to which the labels will be exported.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "snapshotPath": { + "description": "The output path where the labels will be exported.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Coco", + "additionalProperties": false + }, + "CodeConfiguration": { + "description": "Configuration for a scoring code asset.", + "required": [ + "scoringScript" + ], + "type": "object", + "properties": { + "codeId": { + "description": "ARM resource ID of the code asset.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "scoringScript": { + "description": "[Required] The script to execute on startup. eg. \"score.py\"", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "CodeContainer": { + "description": "Container for code asset versions.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "x-ms-client-name": "CodeContainerProperties", + "additionalProperties": false + }, + "CodeContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/CodeContainer" + } + }, + "x-ms-client-name": "CodeContainer", + "additionalProperties": false + }, + "CodeContainerResourceArmPaginatedResult": { + "description": "A paginated list of CodeContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of CodeContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type CodeContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/CodeContainerResource" + } + } + }, + "additionalProperties": false + }, + "CodeVersion": { + "description": "Code asset version details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "codeUri": { + "description": "Uri where code is located", + "type": "string", + "example": "https://blobStorage/folderName", + "x-nullable": true + } + }, + "x-ms-client-name": "CodeVersionProperties", + "additionalProperties": false + }, + "CodeVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/CodeVersion" + } + }, + "x-ms-client-name": "CodeVersion", + "additionalProperties": false + }, + "CodeVersionResourceArmPaginatedResult": { + "description": "A paginated list of CodeVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of CodeVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type CodeVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/CodeVersionResource" + } + } + }, + "additionalProperties": false + }, + "ColumnTransformer": { + "description": "Column transformer parameters.", + "type": "object", + "properties": { + "fields": { + "description": "Fields to apply transformer logic on.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "parameters": { + "description": "Different properties to be passed to transformer.\r\nInput expected is dictionary of key,value pairs in JSON format.", + "type": "object", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "CommandJob": { + "description": "Command job definition.", + "required": [ + "command", + "environmentId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "codeId": { + "description": "ARM resource ID of the code asset.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "command": { + "description": "[Required] The command to execute on startup of the job. eg. \"python train.py\"", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "distribution": { + "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", + "$ref": "#/definitions/DistributionConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentId": { + "description": "[Required] The ARM resource ID of the Environment specification for the job.", + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inputs": { + "description": "Mapping of input data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "limits": { + "description": "Command Job limit.", + "$ref": "#/definitions/CommandJobLimits", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "parameters": { + "description": "Input parameters.", + "type": "object", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Command", + "additionalProperties": false + }, + "CommandJobLimits": { + "description": "Command Job limit class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobLimits" + } + ], + "x-ms-discriminator-value": "Command", + "additionalProperties": false + }, + "ComponentContainer": { + "description": "Component container definition.\r\n", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "x-ms-client-name": "ComponentContainerProperties", + "additionalProperties": false + }, + "ComponentContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ComponentContainer" + } + }, + "x-ms-client-name": "ComponentContainer", + "additionalProperties": false + }, + "ComponentContainerResourceArmPaginatedResult": { + "description": "A paginated list of ComponentContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ComponentContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ComponentContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/ComponentContainerResource" + } + } + }, + "additionalProperties": false + }, + "ComponentVersion": { + "description": "Definition of a component version: defines resources that span component types.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "componentSpec": { + "description": "Defines Component definition details.\r\n", + "type": "object", + "example": { + "name": "Hello_Python_World", + "display_name": "Hello_Python_World", + "version": 1, + "type": "command", + "code": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/mycode/versions/1", + "environment": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/AzureML-Tutorial/versions/1", + "command": "python hello.py" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-client-name": "ComponentVersionProperties", + "additionalProperties": false + }, + "ComponentVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ComponentVersion" + } + }, + "x-ms-client-name": "ComponentVersion", + "additionalProperties": false + }, + "ComponentVersionResourceArmPaginatedResult": { + "description": "A paginated list of ComponentVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ComponentVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ComponentVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/ComponentVersionResource" + } + } + }, + "additionalProperties": false + }, + "ContainerResourceRequirements": { + "description": "Resource requirements for each container instance within an online deployment.", + "type": "object", + "properties": { + "containerResourceLimits": { + "description": "Container resource limit info:", + "$ref": "#/definitions/ContainerResourceSettings", + "x-nullable": true + }, + "containerResourceRequests": { + "description": "Container resource request info:", + "$ref": "#/definitions/ContainerResourceSettings", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ContainerResourceSettings": { + "type": "object", + "properties": { + "cpu": { + "description": "Number of vCPUs request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "1", + "x-nullable": true + }, + "gpu": { + "description": "Number of Nvidia GPU cards request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "1", + "x-nullable": true + }, + "memory": { + "description": "Memory size request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "2Gi", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ContainerType": { + "enum": [ + "StorageInitializer", + "InferenceServer" + ], + "type": "string", + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": true, + "values": [ + { + "value": "StorageInitializer" + }, + { + "value": "InferenceServer" + } + ] + }, + "additionalProperties": false + }, + "CredentialsType": { + "description": "Enum to determine the datastore credentials type.", + "enum": [ + "AccountKey", + "Certificate", + "None", + "Sas", + "ServicePrincipal", + "KerberosKeytab", + "KerberosPassword" + ], + "type": "string", + "x-ms-enum": { + "name": "CredentialsType", + "modelAsString": true, + "values": [ + { + "value": "AccountKey" + }, + { + "value": "Certificate" + }, + { + "value": "None" + }, + { + "value": "Sas" + }, + { + "value": "ServicePrincipal" + }, + { + "value": "KerberosKeytab" + }, + { + "value": "KerberosPassword" + } + ] + }, + "additionalProperties": false + }, + "CronTrigger": { + "required": [ + "expression" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerBase" + } + ], + "properties": { + "expression": { + "description": "[Required] Specifies cron expression of schedule.\r\nThe expression should follow NCronTab format.", + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "Cron", + "additionalProperties": false + }, + "CsvExportSummary": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSummary" + } + ], + "properties": { + "containerName": { + "description": "The container name to which the labels will be exported.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "snapshotPath": { + "description": "The output path where the labels will be exported.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "CSV", + "additionalProperties": false + }, + "CustomForecastHorizon": { + "description": "The desired maximum forecast horizon in units of time-series frequency.", + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ForecastHorizon" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] Forecast horizon value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomModelJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "custom_model", + "additionalProperties": false + }, + "CustomModelJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "custom_model", + "additionalProperties": false + }, + "CustomNCrossValidations": { + "description": "N-Cross validations are specified by user.", + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NCrossValidations" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] N-Cross validations value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomSeasonality": { + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Seasonality" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] Seasonality value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomTargetLags": { + "required": [ + "values" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetLags" + } + ], + "properties": { + "values": { + "description": "[Required] Set target lags values.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomTargetRollingWindowSize": { + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetRollingWindowSize" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] TargetRollingWindowSize value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "DataContainer": { + "description": "Container for data asset versions.", + "required": [ + "dataType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "dataType": { + "description": "[Required] Specifies the type of data.", + "$ref": "#/definitions/DataType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-client-name": "DataContainerProperties", + "additionalProperties": false + }, + "DataContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/DataContainer" + } + }, + "x-ms-client-name": "DataContainer", + "additionalProperties": false + }, + "DataContainerResourceArmPaginatedResult": { + "description": "A paginated list of DataContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of DataContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type DataContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/DataContainerResource" + } + } + }, + "additionalProperties": false + }, + "DataPathAssetReference": { + "description": "Reference to an asset via its path in a datastore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetReferenceBase" + } + ], + "properties": { + "datastoreId": { + "description": "ARM resource ID of the datastore where the asset is located.", + "type": "string", + "x-nullable": true + }, + "path": { + "description": "The path of the file/directory in the datastore.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "DataPath", + "additionalProperties": false + }, + "DatasetExportSummary": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSummary" + } + ], + "properties": { + "labeledAssetName": { + "description": "The unique name of the labeled data asset.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Dataset", + "additionalProperties": false + }, + "Datastore": { + "description": "Base definition for datastore contents configuration.", + "required": [ + "credentials", + "datastoreType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "credentials": { + "description": "[Required] Account credentials.", + "$ref": "#/definitions/DatastoreCredentials" + }, + "datastoreType": { + "description": "[Required] Storage type backing the datastore.", + "$ref": "#/definitions/DatastoreType" + }, + "isDefault": { + "description": "Readonly property to indicate if datastore is the workspace default datastore", "type": "boolean", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "discriminator": "datastoreType", + "x-ms-client-name": "DatastoreProperties" + }, + "DatastoreCredentials": { + "description": "Base definition for datastore credentials.", + "required": [ + "credentialsType" + ], + "type": "object", + "properties": { + "credentialsType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/CredentialsType" + } + }, + "discriminator": "credentialsType" + }, + "DatastoreResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Datastore" + } + }, + "x-ms-client-name": "Datastore", + "additionalProperties": false + }, + "DatastoreResourceArmPaginatedResult": { + "description": "A paginated list of Datastore entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Datastore objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Datastore.", + "type": "array", + "items": { + "$ref": "#/definitions/DatastoreResource" + } + } + }, + "additionalProperties": false + }, + "DatastoreSecrets": { + "description": "Base definition for datastore secrets.", + "required": [ + "secretsType" + ], + "type": "object", + "properties": { + "secretsType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/SecretsType" + } + }, + "discriminator": "secretsType" + }, + "DatastoreType": { + "description": "Enum to determine the datastore contents type.", + "enum": [ + "AzureBlob", + "AzureDataLakeGen1", + "AzureDataLakeGen2", + "AzureFile", + "Hdfs" + ], + "type": "string", + "x-ms-enum": { + "name": "DatastoreType", + "modelAsString": true, + "values": [ + { + "value": "AzureBlob" + }, + { + "value": "AzureDataLakeGen1" + }, + { + "value": "AzureDataLakeGen2" + }, + { + "value": "AzureFile" + }, + { + "value": "Hdfs" + } + ] + }, + "additionalProperties": false + }, + "DataType": { + "description": "Enum to determine the type of data.", + "enum": [ + "uri_file", + "uri_folder", + "mltable" + ], + "type": "string", + "x-ms-enum": { + "name": "DataType", + "modelAsString": true, + "values": [ + { + "value": "uri_file" + }, + { + "value": "uri_folder" + }, + { + "value": "mltable" + } + ] + }, + "additionalProperties": false + }, + "DataVersionBase": { + "description": "Data version base definition", + "required": [ + "dataType", + "dataUri" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "dataType": { + "description": "[Required] Specifies the type of data.", + "$ref": "#/definitions/DataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dataUri": { + "description": "[Required] Uri of the data. Usage/meaning depends on Microsoft.MachineLearning.ManagementFrontEnd.Contracts.V20220601Preview.Assets.DataVersionBase.DataType", + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "dataType", + "x-ms-client-name": "DataVersionBaseProperties" + }, + "DataVersionBaseResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/DataVersionBase" + } + }, + "x-ms-client-name": "DataVersionBase", + "additionalProperties": false + }, + "DataVersionBaseResourceArmPaginatedResult": { + "description": "A paginated list of DataVersionBase entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of DataVersionBase objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type DataVersionBase.", + "type": "array", + "items": { + "$ref": "#/definitions/DataVersionBaseResource" + } + } + }, + "additionalProperties": false + }, + "DefaultScaleSettings": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OnlineScaleSettings" + } + ], + "x-ms-discriminator-value": "Default", + "additionalProperties": false + }, + "DeploymentLogs": { + "type": "object", + "properties": { + "content": { + "description": "The retrieved online deployment logs.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "DeploymentLogsRequest": { + "type": "object", + "properties": { + "containerType": { + "description": "The type of container to retrieve logs from.", + "default": "InferenceServer", + "$ref": "#/definitions/ContainerType" + }, + "tail": { + "format": "int32", + "description": "The maximum number of lines to tail.", + "type": "integer", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "DeploymentProvisioningState": { + "description": "Possible values for DeploymentProvisioningState.", + "enum": [ + "Creating", + "Deleting", + "Scaling", + "Updating", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "DeploymentProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Creating" + }, + { + "value": "Deleting" + }, + { + "value": "Scaling" + }, + { + "value": "Updating" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + } + ] + }, + "additionalProperties": false + }, + "DistributionConfiguration": { + "description": "Base definition for job distribution configuration.", + "required": [ + "distributionType" + ], + "type": "object", + "properties": { + "distributionType": { + "description": "[Required] Specifies the type of distribution framework.", + "$ref": "#/definitions/DistributionType", "x-ms-mutability": [ "create", - "read", - "update" + "read" ] } }, + "discriminator": "distributionType" + }, + "DistributionType": { + "description": "Enum to determine the job distribution type.", + "enum": [ + "PyTorch", + "TensorFlow", + "Mpi" + ], + "type": "string", + "x-ms-enum": { + "name": "DistributionType", + "modelAsString": true, + "values": [ + { + "value": "PyTorch" + }, + { + "value": "TensorFlow" + }, + { + "value": "Mpi" + } + ] + }, "additionalProperties": false }, - "AssetContainer": { + "EarlyTerminationPolicy": { + "description": "Early termination policies enable canceling poor-performing runs before they complete", + "required": [ + "policyType" + ], "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ResourceBase" + "properties": { + "delayEvaluation": { + "format": "int32", + "description": "Number of intervals by which to delay the first evaluation.", + "default": 0, + "type": "integer" + }, + "evaluationInterval": { + "format": "int32", + "description": "Interval (number of runs) between policy evaluations.", + "default": 0, + "type": "integer" + }, + "policyType": { + "description": "[Required] Name of policy configuration", + "$ref": "#/definitions/EarlyTerminationPolicyType" + } + }, + "discriminator": "policyType" + }, + "EarlyTerminationPolicyType": { + "enum": [ + "Bandit", + "MedianStopping", + "TruncationSelection" + ], + "type": "string", + "x-ms-enum": { + "name": "EarlyTerminationPolicyType", + "modelAsString": true, + "values": [ + { + "value": "Bandit" + }, + { + "value": "MedianStopping" + }, + { + "value": "TruncationSelection" + } + ] + }, + "additionalProperties": false + }, + "EgressPublicNetworkAccessType": { + "description": "Enum to determine whether PublicNetworkAccess is Enabled or Disabled for egress of a deployment.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EgressPublicNetworkAccessType", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "EndpointAuthKeys": { + "description": "Keys for endpoint authentication.", + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary key.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "secondaryKey": { + "description": "The secondary key.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointAuthMode": { + "description": "Enum to determine endpoint authentication mode.", + "enum": [ + "AMLToken", + "Key", + "AADToken" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointAuthMode", + "modelAsString": true, + "values": [ + { + "value": "AMLToken" + }, + { + "value": "Key" + }, + { + "value": "AADToken" + } + ] + }, + "additionalProperties": false + }, + "EndpointAuthToken": { + "description": "Service Token", + "type": "object", + "properties": { + "accessToken": { + "description": "Access token for endpoint authentication.", + "type": "string", + "x-nullable": true + }, + "expiryTimeUtc": { + "format": "int64", + "description": "Access token expiry time (UTC).", + "default": 0, + "type": "integer" + }, + "refreshAfterTimeUtc": { + "format": "int64", + "description": "Refresh access token after time (UTC).", + "default": 0, + "type": "integer" + }, + "tokenType": { + "description": "Access token type.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointComputeType": { + "description": "Enum to determine endpoint compute type.", + "enum": [ + "Managed", + "Kubernetes", + "AzureMLCompute" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointComputeType", + "modelAsString": true, + "values": [ + { + "value": "Managed" + }, + { + "value": "Kubernetes" + }, + { + "value": "AzureMLCompute" + } + ] + }, + "additionalProperties": false + }, + "EndpointDeploymentPropertiesBase": { + "description": "Base definition for endpoint deployment.", + "type": "object", + "properties": { + "codeConfiguration": { + "description": "Code configuration for the endpoint deployment.", + "$ref": "#/definitions/CodeConfiguration", + "x-nullable": true + }, + "description": { + "description": "Description of the endpoint deployment.", + "type": "string", + "x-nullable": true + }, + "environmentId": { + "description": "ARM resource ID of the environment specification for the endpoint deployment.", + "type": "string", + "x-nullable": true + }, + "environmentVariables": { + "description": "Environment variables configuration for the deployment.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true } + }, + "additionalProperties": false + }, + "EndpointPropertiesBase": { + "description": "Inference Endpoint base definition", + "required": [ + "authMode" ], + "type": "object", "properties": { - "isArchived": { - "description": "Is the asset archived?", - "default": false, - "type": "boolean", + "authMode": { + "description": "[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.", + "$ref": "#/definitions/EndpointAuthMode" + }, + "description": { + "description": "Description of the inference endpoint.", + "type": "string", + "x-nullable": true + }, + "keys": { + "description": "EndpointAuthKeys to set initially on an Endpoint.\r\nThis property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.", + "$ref": "#/definitions/EndpointAuthKeys", "x-ms-mutability": [ - "create", - "read", - "update" - ] + "create" + ], + "x-ms-secret": true, + "x-nullable": true }, - "latestVersion": { - "description": "The latest version inside this container.", + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "scoringUri": { + "format": "uri", + "description": "Endpoint URI.", "type": "string", "readOnly": true, "x-ms-mutability": [ @@ -5434,8 +8771,9 @@ ], "x-nullable": true }, - "nextVersion": { - "description": "The next auto incremental version", + "swaggerUri": { + "format": "uri", + "description": "Endpoint Swagger URI.", "type": "string", "readOnly": true, "x-ms-mutability": [ @@ -5446,851 +8784,1817 @@ }, "additionalProperties": false }, - "AssetJobInput": { - "description": "Asset input type.", + "EndpointProvisioningState": { + "description": "State of endpoint provisioning.", + "enum": [ + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Updating", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Creating" + }, + { + "value": "Deleting" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Updating" + }, + { + "value": "Canceled" + } + ] + }, + "additionalProperties": false + }, + "EndpointScheduleAction": { "required": [ - "uri" + "actionType", + "endpointInvocationDefinition" ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleActionBase" + } + ], "properties": { - "mode": { - "description": "Input Asset Delivery Mode.", - "default": "ReadOnlyMount", - "$ref": "#/definitions/InputDeliveryMode", + "endpointInvocationDefinition": { + "description": "[Required] Defines Schedule action definition details.\r\n", + "type": "object", + "example": { + "endpoint": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/batchEndpoints/hello-pipeline", + "inputs": { + "create_time": "${{creation_context.trigger_time}}" + } + }, "x-ms-mutability": [ "create", - "read" + "read", + "update" ] - }, - "uri": { - "description": "[Required] Input Asset URI.", - "pattern": "[a-zA-Z0-9_]", - "type": "string" } }, + "x-ms-discriminator-value": "InvokeBatchEndpoint", "additionalProperties": false }, - "AssetJobOutput": { - "description": "Asset output type.", + "EnvironmentContainer": { + "description": "Container for environment specification versions.", "type": "object", - "properties": { - "mode": { - "description": "Output Asset Delivery Mode.", - "default": "ReadWriteMount", - "$ref": "#/definitions/OutputDeliveryMode", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "uri": { - "description": "Output Asset URI.", - "type": "string", - "x-nullable": true + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" } - }, + ], + "x-ms-client-name": "EnvironmentContainerProperties", "additionalProperties": false }, - "AssetReferenceBase": { - "description": "Base definition for asset references.", + "EnvironmentContainerResource": { + "description": "Azure Resource Manager resource envelope.", "required": [ - "referenceType" + "properties" ], "type": "object", - "properties": { - "referenceType": { - "description": "[Required] Specifies the type of asset reference.", - "$ref": "#/definitions/ReferenceType" - } - }, - "discriminator": "referenceType" - }, - "AzureBlobDatastore": { - "description": "Azure Blob datastore configuration.", - "type": "object", "allOf": [ { - "$ref": "#/definitions/Datastore" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" } ], "properties": { - "accountName": { - "description": "Storage account name.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "containerName": { - "description": "Storage account container name.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "endpoint": { - "description": "Azure cloud endpoint for the storage account.", - "type": "string", - "example": "core.windows.net", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "protocol": { - "description": "Protocol used to communicate with the storage account.", - "type": "string", - "example": "https", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "serviceDataAccessAuthIdentity": { - "description": "Indicates which identity to use to authenticate service data access to customer's storage.", - "default": "None", - "$ref": "#/definitions/ServiceDataAccessAuthIdentity", - "x-ms-mutability": [ - "create", - "read" - ] + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/EnvironmentContainer" } }, - "x-ms-discriminator-value": "AzureBlob", + "x-ms-client-name": "EnvironmentContainer", "additionalProperties": false }, - "AzureDataLakeGen1Datastore": { - "description": "Azure Data Lake Gen1 datastore configuration.", - "required": [ - "storeName" - ], + "EnvironmentContainerResourceArmPaginatedResult": { + "description": "A paginated list of EnvironmentContainer entities.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Datastore" - } - ], "properties": { - "serviceDataAccessAuthIdentity": { - "description": "Indicates which identity to use to authenticate service data access to customer's storage.", - "default": "None", - "$ref": "#/definitions/ServiceDataAccessAuthIdentity", - "x-ms-mutability": [ - "create", - "read" - ] + "nextLink": { + "description": "The link to the next page of EnvironmentContainer objects. If null, there are no additional pages.", + "type": "string" }, - "storeName": { - "description": "[Required] Azure Data Lake store name.", - "pattern": "[a-zA-Z0-9_]", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] + "value": { + "description": "An array of objects of type EnvironmentContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentContainerResource" + } } }, - "x-ms-discriminator-value": "AzureDataLakeGen1", "additionalProperties": false }, - "AzureDataLakeGen2Datastore": { - "description": "Azure Data Lake Gen2 datastore configuration.", - "required": [ - "accountName", - "filesystem" - ], + "EnvironmentType": { + "description": "Environment type is either user created or curated by Azure ML service", + "enum": [ + "Curated", + "UserCreated" + ], + "type": "string", + "x-ms-enum": { + "name": "EnvironmentType", + "modelAsString": true, + "values": [ + { + "value": "Curated" + }, + { + "value": "UserCreated" + } + ] + }, + "additionalProperties": false + }, + "EnvironmentVersion": { + "description": "Environment version details.", "type": "object", "allOf": [ { - "$ref": "#/definitions/Datastore" + "$ref": "#/definitions/AssetBase" } ], "properties": { - "accountName": { - "description": "[Required] Storage account name.", - "pattern": "[a-zA-Z0-9_]", - "type": "string", + "build": { + "description": "Configuration settings for Docker build context.", + "$ref": "#/definitions/BuildContext", "x-ms-mutability": [ "create", "read" ] }, - "endpoint": { - "description": "Azure cloud endpoint for the storage account.", + "condaFile": { + "description": "Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.\r\n", "type": "string", - "example": "core.windows.net", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] }, - "filesystem": { - "description": "[Required] The name of the Data Lake Gen2 filesystem.", - "pattern": "[a-zA-Z0-9_]", + "environmentType": { + "description": "Environment type is either user managed or curated by the Azure ML service\r\n", + "$ref": "#/definitions/EnvironmentType", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "image": { + "description": "Name of the image that will be used for the environment.\r\n", "type": "string", + "example": "docker.io/tensorflow/serving:latest", "x-ms-mutability": [ "create", "read" ] }, - "protocol": { - "description": "Protocol used to communicate with the storage account.", - "type": "string", - "example": "https", + "inferenceConfig": { + "description": "Defines configuration specific to inference.", + "$ref": "#/definitions/InferenceContainerProperties", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] }, - "serviceDataAccessAuthIdentity": { - "description": "Indicates which identity to use to authenticate service data access to customer's storage.", - "default": "None", - "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "osType": { + "description": "The OS type of the environment.", + "default": "Linux", + "$ref": "#/definitions/OperatingSystemType", "x-ms-mutability": [ "create", "read" ] } }, - "x-ms-discriminator-value": "AzureDataLakeGen2", + "x-ms-client-name": "EnvironmentVersionProperties", "additionalProperties": false }, - "AzureFileDatastore": { - "description": "Azure File datastore configuration.", + "EnvironmentVersionResource": { + "description": "Azure Resource Manager resource envelope.", "required": [ - "accountName", - "fileShareName" + "properties" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/Datastore" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" } ], "properties": { - "accountName": { - "description": "[Required] Storage account name.", - "pattern": "[a-zA-Z0-9_]", + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/EnvironmentVersion" + } + }, + "x-ms-client-name": "EnvironmentVersion", + "additionalProperties": false + }, + "EnvironmentVersionResourceArmPaginatedResult": { + "description": "A paginated list of EnvironmentVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of EnvironmentVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type EnvironmentVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + } + }, + "additionalProperties": false + }, + "ExportFormatType": { + "description": "The format of exported labels.", + "enum": [ + "Dataset", + "Coco", + "CSV" + ], + "type": "string", + "x-ms-enum": { + "name": "ExportFormatType", + "modelAsString": true, + "values": [ + { + "value": "Dataset" + }, + { + "value": "Coco" + }, + { + "value": "CSV" + } + ] + }, + "additionalProperties": false + }, + "ExportSummary": { + "required": [ + "format" + ], + "type": "object", + "properties": { + "endDateTime": { + "format": "date-time", + "description": "The time when the export was completed.", "type": "string", + "readOnly": true, "x-ms-mutability": [ - "create", "read" - ] + ], + "x-nullable": true }, - "endpoint": { - "description": "Azure cloud endpoint for the storage account.", - "type": "string", - "example": "core.windows.net", + "exportedRowCount": { + "format": "int64", + "description": "The total number of labeled datapoints exported.", + "type": "integer", + "readOnly": true, "x-ms-mutability": [ - "create", "read" ], "x-nullable": true }, - "fileShareName": { - "description": "[Required] The name of the Azure file share that the datastore points to.", - "pattern": "[a-zA-Z0-9_]", - "type": "string", + "format": { + "description": "[Required] The format of exported labels, also as the discriminator.", + "$ref": "#/definitions/ExportFormatType", "x-ms-mutability": [ "create", "read" ] }, - "protocol": { - "description": "Protocol used to communicate with the storage account.", + "labelingJobId": { + "description": "Name and identifier of the job containing exported labels.", "type": "string", - "example": "https", + "readOnly": true, "x-ms-mutability": [ - "create", "read" ], "x-nullable": true }, - "serviceDataAccessAuthIdentity": { - "description": "Indicates which identity to use to authenticate service data access to customer's storage.", - "default": "None", - "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "startDateTime": { + "format": "date-time", + "description": "The time when the export was requested.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "discriminator": "format" + }, + "FeatureLags": { + "description": "Flag for generating lags for the numeric features.", + "enum": [ + "None", + "Auto" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureLags", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No feature lags generated." + }, + { + "value": "Auto", + "description": "System auto-generates feature lags." + } + ] + }, + "additionalProperties": false + }, + "FeaturizationMode": { + "description": "Featurization mode - determines data featurization mode.", + "enum": [ + "Auto", + "Custom", + "Off" + ], + "type": "string", + "x-ms-enum": { + "name": "FeaturizationMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Auto mode, system performs featurization without any custom featurization inputs." + }, + { + "value": "Custom", + "description": "Custom featurization." + }, + { + "value": "Off", + "description": "Featurization off. 'Forecasting' task cannot use this value." + } + ] + }, + "additionalProperties": false + }, + "FeaturizationSettings": { + "description": "Featurization Configuration.", + "type": "object", + "properties": { + "datasetLanguage": { + "description": "Dataset language, useful for the text data.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "FlavorData": { + "type": "object", + "properties": { + "data": { + "description": "Model flavor-specific data.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ForecastHorizon": { + "description": "The desired maximum forecast horizon in units of time-series frequency.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] Set forecast horizon value selection mode.", + "$ref": "#/definitions/ForecastHorizonMode", "x-ms-mutability": [ "create", "read" ] } }, - "x-ms-discriminator-value": "AzureFile", + "discriminator": "mode" + }, + "ForecastHorizonMode": { + "description": "Enum to determine forecast horizon selection mode.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ForecastHorizonMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Forecast horizon to be determined automatically." + }, + { + "value": "Custom", + "description": "Use the custom forecast horizon." + } + ] + }, + "additionalProperties": false + }, + "Forecasting": { + "description": "Forecasting task in AutoML Table vertical.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TableVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "forecastingSettings": { + "description": "Forecasting task specific inputs.", + "$ref": "#/definitions/ForecastingSettings", + "x-nullable": true + }, + "primaryMetric": { + "description": "Primary metric for forecasting task.", + "default": "NormalizedRootMeanSquaredError", + "$ref": "#/definitions/ForecastingPrimaryMetrics" + }, + "trainingSettings": { + "description": "Inputs for training phase for an AutoML Job.", + "$ref": "#/definitions/ForecastingTrainingSettings", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Forecasting", + "additionalProperties": false + }, + "ForecastingModels": { + "description": "Enum for all forecasting models supported by AutoML.", + "enum": [ + "AutoArima", + "Prophet", + "Naive", + "SeasonalNaive", + "Average", + "SeasonalAverage", + "ExponentialSmoothing", + "Arimax", + "TCNForecaster", + "ElasticNet", + "GradientBoosting", + "DecisionTree", + "KNN", + "LassoLars", + "SGD", + "RandomForest", + "ExtremeRandomTrees", + "LightGBM", + "XGBoostRegressor" + ], + "type": "string", + "x-ms-enum": { + "name": "ForecastingModels", + "modelAsString": true, + "values": [ + { + "value": "AutoArima", + "description": "Auto-Autoregressive Integrated Moving Average (ARIMA) model uses time-series data and statistical analysis to interpret the data and make future predictions.\nThis model aims to explain data by using time series data on its past values and uses linear regression to make predictions." + }, + { + "value": "Prophet", + "description": "Prophet is a procedure for forecasting time series data based on an additive model where non-linear trends are fit with yearly, weekly, and daily seasonality, plus holiday effects.\nIt works best with time series that have strong seasonal effects and several seasons of historical data. Prophet is robust to missing data and shifts in the trend, and typically handles outliers well." + }, + { + "value": "Naive", + "description": "The Naive forecasting model makes predictions by carrying forward the latest target value for each time-series in the training data." + }, + { + "value": "SeasonalNaive", + "description": "The Seasonal Naive forecasting model makes predictions by carrying forward the latest season of target values for each time-series in the training data." + }, + { + "value": "Average", + "description": "The Average forecasting model makes predictions by carrying forward the average of the target values for each time-series in the training data." + }, + { + "value": "SeasonalAverage", + "description": "The Seasonal Average forecasting model makes predictions by carrying forward the average value of the latest season of data for each time-series in the training data." + }, + { + "value": "ExponentialSmoothing", + "description": "Exponential smoothing is a time series forecasting method for univariate data that can be extended to support data with a systematic trend or seasonal component." + }, + { + "value": "Arimax", + "description": "An Autoregressive Integrated Moving Average with Explanatory Variable (ARIMAX) model can be viewed as a multiple regression model with one or more autoregressive (AR) terms and/or one or more moving average (MA) terms.\nThis method is suitable for forecasting when data is stationary/non stationary, and multivariate with any type of data pattern, i.e., level/trend /seasonality/cyclicity." + }, + { + "value": "TCNForecaster", + "description": "TCNForecaster: Temporal Convolutional Networks Forecaster. //TODO: Ask forecasting team for brief intro." + }, + { + "value": "ElasticNet", + "description": "Elastic net is a popular type of regularized linear regression that combines two popular penalties, specifically the L1 and L2 penalty functions." + }, + { + "value": "GradientBoosting", + "description": "The technique of transiting week learners into a strong learner is called Boosting. The gradient boosting algorithm process works on this theory of execution." + }, + { + "value": "DecisionTree", + "description": "Decision Trees are a non-parametric supervised learning method used for both classification and regression tasks.\nThe goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from the data features." + }, + { + "value": "KNN", + "description": "K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints\nwhich further means that the new data point will be assigned a value based on how closely it matches the points in the training set." + }, + { + "value": "LassoLars", + "description": "Lasso model fit with Least Angle Regression a.k.a. Lars. It is a Linear Model trained with an L1 prior as regularizer." + }, + { + "value": "SGD", + "description": "SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications\nto find the model parameters that correspond to the best fit between predicted and actual outputs.\nIt's an inexact but powerful technique." + }, + { + "value": "RandomForest", + "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the “bagging” method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." + }, + { + "value": "ExtremeRandomTrees", + "description": "Extreme Trees is an ensemble machine learning algorithm that combines the predictions from many decision trees. It is related to the widely used random forest algorithm." + }, + { + "value": "LightGBM", + "description": "LightGBM is a gradient boosting framework that uses tree based learning algorithms." + }, + { + "value": "XGBoostRegressor", + "description": "XGBoostRegressor: Extreme Gradient Boosting Regressor is a supervised machine learning model using ensemble of base learners." + } + ] + }, "additionalProperties": false }, - "BanditPolicy": { - "description": "Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/EarlyTerminationPolicy" - } + "ForecastingPrimaryMetrics": { + "description": "Primary metrics for Forecasting task.", + "enum": [ + "SpearmanCorrelation", + "NormalizedRootMeanSquaredError", + "R2Score", + "NormalizedMeanAbsoluteError" ], - "properties": { - "slackAmount": { - "format": "float", - "description": "Absolute distance allowed from the best performing run.", - "default": 0, - "type": "number" - }, - "slackFactor": { - "format": "float", - "description": "Ratio of the allowed distance from the best performing run.", - "default": 0, - "type": "number" - } + "type": "string", + "x-ms-enum": { + "name": "ForecastingPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "SpearmanCorrelation", + "description": "The Spearman's rank coefficient of correlation is a non-parametric measure of rank correlation." + }, + { + "value": "NormalizedRootMeanSquaredError", + "description": "The Normalized Root Mean Squared Error (NRMSE) the RMSE facilitates the comparison between models with different scales." + }, + { + "value": "R2Score", + "description": "The R2 score is one of the performance evaluation measures for forecasting-based machine learning models." + }, + { + "value": "NormalizedMeanAbsoluteError", + "description": "The Normalized Mean Absolute Error (NMAE) is a validation metric to compare the Mean Absolute Error (MAE) of (time) series with different scales." + } + ] }, - "x-ms-discriminator-value": "Bandit", "additionalProperties": false }, - "BatchDeployment": { - "description": "Batch inference settings per deployment.", + "ForecastingSettings": { + "description": "Forecasting specific parameters.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/EndpointDeploymentPropertiesBase" - } - ], "properties": { - "compute": { - "description": "Compute target for batch inference operation.", + "countryOrRegionForHolidays": { + "description": "Country or region for holidays for forecasting tasks.\r\nThese should be ISO 3166 two-letter country/region codes, for example 'US' or 'GB'.", "type": "string", "x-nullable": true }, - "errorThreshold": { + "cvStepSize": { "format": "int32", - "description": "Error threshold, if the error count for the entire input goes above this value,\r\nthe batch inference will be aborted. Range is [-1, int.MaxValue].\r\nFor FileDataset, this value is the count of file failures.\r\nFor TabularDataset, this value is the count of record failures.\r\nIf set to -1 (the lower bound), all failures during batch inference will be ignored.", - "default": -1, - "type": "integer" + "description": "Number of periods between the origin time of one CV fold and the next fold. For\r\nexample, if `CVStepSize` = 3 for daily data, the origin time for each fold will be\r\nthree days apart.", + "type": "integer", + "x-nullable": true }, - "loggingLevel": { - "description": "Logging level for batch inference operation.", - "default": "Info", - "$ref": "#/definitions/BatchLoggingLevel" + "featureLags": { + "description": "Flag for generating lags for the numeric features with 'auto' or null.", + "default": "None", + "$ref": "#/definitions/FeatureLags" }, - "maxConcurrencyPerInstance": { - "format": "int32", - "description": "Indicates maximum number of parallelism per instance.", - "default": 1, - "type": "integer" + "forecastHorizon": { + "description": "The desired maximum forecast horizon in units of time-series frequency.", + "$ref": "#/definitions/ForecastHorizon", + "x-nullable": true }, - "miniBatchSize": { - "format": "int64", - "description": "Size of the mini-batch passed to each batch invocation.\r\nFor FileDataset, this is the number of files per mini-batch.\r\nFor TabularDataset, this is the size of the records in bytes, per mini-batch.", - "default": 10, - "type": "integer" + "frequency": { + "description": "When forecasting, this parameter represents the period with which the forecast is desired, for example daily, weekly, yearly, etc. The forecast frequency is dataset frequency by default.", + "type": "string", + "x-nullable": true }, - "model": { - "description": "Reference to the model asset for the endpoint deployment.", - "$ref": "#/definitions/AssetReferenceBase", + "seasonality": { + "description": "Set time series seasonality as an integer multiple of the series frequency.\r\nIf seasonality is set to 'auto', it will be inferred.", + "$ref": "#/definitions/Seasonality", "x-nullable": true }, - "outputAction": { - "description": "Indicates how the output will be organized.", - "default": "AppendRow", - "$ref": "#/definitions/BatchOutputAction" + "shortSeriesHandlingConfig": { + "description": "The parameter defining how if AutoML should handle short time series.", + "default": "Auto", + "$ref": "#/definitions/ShortSeriesHandlingConfiguration" }, - "outputFileName": { - "description": "Customized output file name for append_row output action.", - "default": "predictions.csv", - "type": "string" + "targetAggregateFunction": { + "description": "The function to be used to aggregate the time series target column to conform to a user specified frequency.\r\nIf the TargetAggregateFunction is set i.e. not 'None', but the freq parameter is not set, the error is raised. The possible target aggregation functions are: \"sum\", \"max\", \"min\" and \"mean\".", + "default": "None", + "$ref": "#/definitions/TargetAggregationFunction" }, - "provisioningState": { - "description": "Provisioning state for the endpoint deployment.", - "$ref": "#/definitions/DeploymentProvisioningState", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "targetLags": { + "description": "The number of past periods to lag from the target column.", + "$ref": "#/definitions/TargetLags", + "x-nullable": true }, - "resources": { - "description": "Indicates compute configuration for the job.\r\nIf not provided, will default to the defaults defined in ResourceConfiguration.", - "$ref": "#/definitions/ResourceConfiguration", + "targetRollingWindowSize": { + "description": "The number of past periods used to create a rolling window average of the target column.", + "$ref": "#/definitions/TargetRollingWindowSize", "x-nullable": true }, - "retrySettings": { - "description": "Retry Settings for the batch inference operation.\r\nIf not provided, will default to the defaults defined in BatchRetrySettings.", - "$ref": "#/definitions/BatchRetrySettings", + "timeColumnName": { + "description": "The name of the time column. This parameter is required when forecasting to specify the datetime column in the input data used for building the time series and inferring its frequency.", + "type": "string", + "x-nullable": true + }, + "timeSeriesIdColumnNames": { + "description": "The names of columns used to group a timeseries. It can be used to create multiple series.\r\nIf grain is not defined, the data set is assumed to be one time-series. This parameter is used with task type forecasting.", + "type": "array", + "items": { + "type": "string" + }, "x-nullable": true + }, + "useStl": { + "description": "Configure STL Decomposition of the time-series target column.", + "default": "None", + "$ref": "#/definitions/UseStl" } }, - "x-ms-client-name": "BatchDeploymentProperties", "additionalProperties": false }, - "BatchDeploymentTrackedResource": { - "required": [ - "location", - "properties" - ], + "ForecastingTrainingSettings": { + "description": "Forecasting Training related configuration.", "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "#/definitions/TrainingSettings" } ], "properties": { - "identity": { - "description": "Managed service identity (system assigned and/or user assigned identities)", - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "kind": { - "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", - "type": "string" - }, - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/BatchDeployment" + "allowedTrainingAlgorithms": { + "description": "Allowed models for forecasting task.", + "type": "array", + "items": { + "$ref": "#/definitions/ForecastingModels" + }, + "x-nullable": true }, - "sku": { - "description": "Sku details required for ARM contract for Autoscaling.", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + "blockedTrainingAlgorithms": { + "description": "Blocked models for forecasting task.", + "type": "array", + "items": { + "$ref": "#/definitions/ForecastingModels" + }, + "x-nullable": true } }, - "x-ms-client-name": "BatchDeployment", "additionalProperties": false }, - "BatchDeploymentTrackedResourceArmPaginatedResult": { - "description": "A paginated list of BatchDeployment entities.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link to the next page of BatchDeployment objects. If null, there are no additional pages.", - "type": "string" - }, - "value": { - "description": "An array of objects of type BatchDeployment.", - "type": "array", - "items": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" + "Goal": { + "description": "Defines supported metric goals for hyperparameter tuning", + "enum": [ + "Minimize", + "Maximize" + ], + "type": "string", + "x-ms-enum": { + "name": "Goal", + "modelAsString": true, + "values": [ + { + "value": "Minimize" + }, + { + "value": "Maximize" } - } + ] }, "additionalProperties": false }, - "BatchEndpoint": { - "description": "Batch endpoint configuration.", + "GridSamplingAlgorithm": { + "description": "Defines a Sampling Algorithm that exhaustively generates every value combination in the space", "type": "object", "allOf": [ { - "$ref": "#/definitions/EndpointPropertiesBase" + "$ref": "#/definitions/SamplingAlgorithm" + } + ], + "x-ms-discriminator-value": "Grid", + "additionalProperties": false + }, + "HdfsDatastore": { + "required": [ + "nameNodeAddress" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Datastore" } ], "properties": { - "defaults": { - "description": "Default values for Batch Endpoint", - "$ref": "#/definitions/BatchEndpointDefaults", + "hdfsServerCertificate": { + "description": "The TLS cert of the HDFS server. Needs to be a base64 encoded string. Required if \"Https\" protocol is selected.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], "x-nullable": true }, - "provisioningState": { - "description": "Provisioning state for the endpoint.", - "$ref": "#/definitions/EndpointProvisioningState", - "readOnly": true, + "nameNodeAddress": { + "description": "[Required] IP Address or DNS HostName.", + "pattern": "[a-zA-Z0-9_]", + "type": "string", "x-ms-mutability": [ + "create", "read" ] - } - }, - "x-ms-client-name": "BatchEndpointProperties", - "additionalProperties": false - }, - "BatchEndpointDefaults": { - "description": "Batch endpoint default values", - "type": "object", - "properties": { - "deploymentName": { - "description": "Name of the deployment that will be default for the endpoint.\r\nThis deployment will end up getting 100% traffic when the endpoint scoring URL is invoked.", + }, + "protocol": { + "description": "Protocol used to communicate with the storage account (Https/Http).", + "default": "http", "type": "string", - "x-nullable": true + "example": "https", + "x-ms-mutability": [ + "create", + "read" + ] } }, + "x-ms-discriminator-value": "Hdfs", "additionalProperties": false }, - "BatchEndpointTrackedResource": { + "IdAssetReference": { + "description": "Reference to an asset via its ARM resource ID.", "required": [ - "location", - "properties" + "assetId" ], "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "#/definitions/AssetReferenceBase" } ], "properties": { - "identity": { - "description": "Managed service identity (system assigned and/or user assigned identities)", - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "kind": { - "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "assetId": { + "description": "[Required] ARM resource ID of the asset.", + "pattern": "[a-zA-Z0-9_]", "type": "string" - }, - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/BatchEndpoint" - }, - "sku": { - "description": "Sku details required for ARM contract for Autoscaling.", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" } }, - "x-ms-client-name": "BatchEndpoint", + "x-ms-discriminator-value": "Id", "additionalProperties": false }, - "BatchEndpointTrackedResourceArmPaginatedResult": { - "description": "A paginated list of BatchEndpoint entities.", + "IdentityConfiguration": { + "description": "Base definition for identity configuration.", + "required": [ + "identityType" + ], "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of BatchEndpoint objects. If null, there are no additional pages.", - "type": "string" - }, - "value": { - "description": "An array of objects of type BatchEndpoint.", - "type": "array", - "items": { - "$ref": "#/definitions/BatchEndpointTrackedResource" - } + "identityType": { + "description": "[Required] Specifies the type of identity framework.", + "$ref": "#/definitions/IdentityConfigurationType", + "x-ms-mutability": [ + "create", + "read" + ] } }, - "additionalProperties": false + "discriminator": "identityType" }, - "BatchLoggingLevel": { - "description": "Log verbosity for batch inferencing.\r\nIncreasing verbosity order for logging is : Warning, Info and Debug.\r\nThe default value is Info.", + "IdentityConfigurationType": { + "description": "Enum to determine identity framework.", "enum": [ - "Info", - "Warning", - "Debug" + "Managed", + "AMLToken", + "UserIdentity" ], "type": "string", "x-ms-enum": { - "name": "BatchLoggingLevel", + "name": "IdentityConfigurationType", "modelAsString": true, "values": [ { - "value": "Info" + "value": "Managed" }, { - "value": "Warning" + "value": "AMLToken" }, { - "value": "Debug" + "value": "UserIdentity" } ] }, "additionalProperties": false }, - "BatchOutputAction": { - "description": "Enum to determine how batch inferencing will handle output", + "ImageAnnotationType": { + "description": "Annotation type of image data.", "enum": [ - "SummaryOnly", - "AppendRow" + "Classification", + "BoundingBox", + "InstanceSegmentation" ], "type": "string", "x-ms-enum": { - "name": "BatchOutputAction", + "name": "ImageAnnotationType", "modelAsString": true, "values": [ { - "value": "SummaryOnly" + "value": "Classification" }, { - "value": "AppendRow" + "value": "BoundingBox" + }, + { + "value": "InstanceSegmentation" } ] }, "additionalProperties": false }, - "BatchRetrySettings": { - "description": "Retry settings for a batch inference operation.", + "ImageClassification": { + "description": "Image Classification. Multi-class image classification is used when an image is classified with only a single label\r\nfrom a set of classes - e.g. each image is classified as either an image of a 'cat' or a 'dog' or a 'duck'.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageClassificationBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "Accuracy", + "$ref": "#/definitions/ClassificationPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageClassification", + "additionalProperties": false + }, + "ImageClassificationBase": { "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageVertical" + } + ], "properties": { - "maxRetries": { + "modelSettings": { + "description": "Settings used for training the model.", + "$ref": "#/definitions/ImageModelSettingsClassification", + "x-nullable": true + }, + "searchSpace": { + "description": "Search space for sampling different combinations of models and their hyperparameters.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageModelDistributionSettingsClassification" + }, + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "ImageClassificationMultilabel": { + "description": "Image Classification Multilabel. Multi-label image classification is used when an image could have one or more labels\r\nfrom a set of labels - e.g. an image could be labeled with both 'cat' and 'dog'.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageClassificationBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "IOU", + "$ref": "#/definitions/ClassificationMultilabelPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageClassificationMultilabel", + "additionalProperties": false + }, + "ImageInstanceSegmentation": { + "description": "Image Instance Segmentation. Instance segmentation is used to identify objects in an image at the pixel level,\r\ndrawing a polygon around each object in the image.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageObjectDetectionBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "MeanAveragePrecision", + "$ref": "#/definitions/InstanceSegmentationPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageInstanceSegmentation", + "additionalProperties": false + }, + "ImageLimitSettings": { + "description": "Limit settings for the AutoML job.", + "type": "object", + "properties": { + "maxConcurrentTrials": { "format": "int32", - "description": "Maximum retry count for a mini-batch", - "default": 3, + "description": "Maximum number of concurrent AutoML iterations.", + "default": 1, + "type": "integer" + }, + "maxTrials": { + "format": "int32", + "description": "Maximum number of AutoML iterations.", + "default": 1, "type": "integer" }, "timeout": { "format": "duration", - "description": "Invocation timeout for a mini-batch, in ISO 8601 format.", - "default": "PT30S", + "description": "AutoML job timeout.", + "default": "P7D", "type": "string" } }, "additionalProperties": false }, - "BayesianSamplingAlgorithm": { - "description": "Defines a Sampling Algorithm that generates values based on previous values", + "ImageModelDistributionSettings": { + "description": "Distribution expressions to sweep over values of model settings.\r\n\r\nSome examples are:\r\n\r\nModelName = \"choice('seresnext', 'resnest50')\";\r\nLearningRate = \"uniform(0.001, 0.01)\";\r\nLayersToFreeze = \"choice(0, 2)\";\r\n\r\nAll distributions can be specified as distribution_name(min, max) or choice(val1, val2, ..., valn)\r\nwhere distribution name can be: uniform, quniform, loguniform, etc\r\nFor more details on how to compose distribution expressions please check the documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "object", + "properties": { + "amsGradient": { + "description": "Enable AMSGrad when optimizer is 'adam' or 'adamw'.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "augmentations": { + "description": "Settings for using Augmentations.", + "type": "string", + "example": "choice('hflip;mosaic;random_crop', 'mosaic')", + "x-nullable": true + }, + "beta1": { + "description": "Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + }, + "beta2": { + "description": "Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + }, + "distributed": { + "description": "Whether to use distributer training.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "earlyStopping": { + "description": "Enable early stopping logic during training.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "earlyStoppingDelay": { + "description": "Minimum number of epochs or validation evaluations to wait before primary metric improvement\r\nis tracked for early stopping. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "earlyStoppingPatience": { + "description": "Minimum number of epochs or validation evaluations with no primary metric improvement before\r\nthe run is stopped. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "enableOnnxNormalization": { + "description": "Enable normalization when exporting ONNX model.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "evaluationFrequency": { + "description": "Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "gradientAccumulationStep": { + "description": "Gradient accumulation means running a configured number of \"GradAccumulationStep\" steps without\r\nupdating the model weights while accumulating the gradients of those steps, and then using\r\nthe accumulated gradients to compute the weight updates. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "layersToFreeze": { + "description": "Number of layers to freeze for the model. Must be a positive integer.\r\nFor instance, passing 2 as value for 'seresnext' means\r\nfreezing layer0 and layer1. For a full list of models supported and details on layer freeze, please\r\nsee: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "string", + "example": "choice(1, 2)", + "x-nullable": true + }, + "learningRate": { + "description": "Initial learning rate. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0.0005, 0.005)", + "x-nullable": true + }, + "learningRateScheduler": { + "description": "Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.", + "type": "string", + "example": "choice('warmup_cosine', 'step')", + "x-nullable": true + }, + "modelName": { + "description": "Name of the model to use for training.\r\nFor more information on the available models please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "string", + "example": "choice('seresnext', 'resnest50')", + "x-nullable": true + }, + "momentum": { + "description": "Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].", + "type": "string", + "example": "quniform(0, 1)", + "x-nullable": true + }, + "nesterov": { + "description": "Enable nesterov when optimizer is 'sgd'.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "numberOfEpochs": { + "description": "Number of training epochs. Must be a positive integer.", + "type": "string", + "example": "choice(15, 30)", + "x-nullable": true + }, + "numberOfWorkers": { + "description": "Number of data loader workers. Must be a non-negative integer.", + "type": "string", + "example": "uniform(8, 16)", + "x-nullable": true + }, + "optimizer": { + "description": "Type of optimizer. Must be either 'sgd', 'adam', or 'adamw'.", + "type": "string", + "example": "choice('sgd', 'adam', 'adamw')", + "x-nullable": true + }, + "randomSeed": { + "description": "Random seed to be used when using deterministic training.", + "type": "string", + "example": "loguniform(0, 1)", + "x-nullable": true + }, + "stepLRGamma": { + "description": "Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].", + "type": "string", + "example": "choice(0.1, 0.2, 0.25)", + "x-nullable": true + }, + "stepLRStepSize": { + "description": "Value of step size when learning rate scheduler is 'step'. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "trainingBatchSize": { + "description": "Training batch size. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "validationBatchSize": { + "description": "Validation batch size. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "warmupCosineLRCycles": { + "description": "Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + }, + "warmupCosineLRWarmupEpochs": { + "description": "Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "weightDecay": { + "description": "Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImageModelDistributionSettingsClassification": { + "description": "Distribution expressions to sweep over values of model settings.\r\n\r\nSome examples are:\r\n\r\nModelName = \"choice('seresnext', 'resnest50')\";\r\nLearningRate = \"uniform(0.001, 0.01)\";\r\nLayersToFreeze = \"choice(0, 2)\";\r\n\r\nFor more details on how to compose distribution expressions please check the documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageModelDistributionSettings" + } + ], + "properties": { + "trainingCropSize": { + "description": "Image crop size that is input to the neural network for the training dataset. Must be a positive integer.", + "type": "string", + "example": "choice(224, 360)", + "x-nullable": true + }, + "validationCropSize": { + "description": "Image crop size that is input to the neural network for the validation dataset. Must be a positive integer.", + "type": "string", + "example": "choice(224, 360)", + "x-nullable": true + }, + "validationResizeSize": { + "description": "Image size to which to resize before cropping for validation dataset. Must be a positive integer.", + "type": "string", + "example": "choice(128, 256)", + "x-nullable": true + }, + "weightedLoss": { + "description": "Weighted loss. The accepted values are 0 for no weighted loss.\r\n1 for weighted loss with sqrt.(class_weights). 2 for weighted loss with class_weights. Must be 0 or 1 or 2.", + "type": "string", + "example": "choice(0, 1, 2)", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImageModelDistributionSettingsObjectDetection": { + "description": "Distribution expressions to sweep over values of model settings.\r\n\r\nSome examples are:\r\n\r\nModelName = \"choice('seresnext', 'resnest50')\";\r\nLearningRate = \"uniform(0.001, 0.01)\";\r\nLayersToFreeze = \"choice(0, 2)\";\r\n\r\nFor more details on how to compose distribution expressions please check the documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", "type": "object", "allOf": [ { - "$ref": "#/definitions/SamplingAlgorithm" + "$ref": "#/definitions/ImageModelDistributionSettings" } ], - "x-ms-discriminator-value": "Bayesian", - "additionalProperties": false - }, - "BuildContext": { - "description": "Configuration settings for Docker build context", - "required": [ - "contextUri" - ], - "type": "object", "properties": { - "contextUri": { - "description": "[Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs.\r\n", - "pattern": "[a-zA-Z0-9_]", + "boxDetectionsPerImage": { + "description": "Maximum number of detections per image, for all classes. Must be a positive integer.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", "type": "string", - "example": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", - "x-ms-mutability": [ - "create", - "read" - ] + "example": "choice(50, 100)", + "x-nullable": true }, - "dockerfilePath": { - "description": "Path to the Dockerfile in the build context.\r\n", - "default": "Dockerfile", + "boxScoreThreshold": { + "description": "During inference, only return proposals with a classification score greater than\r\nBoxScoreThreshold. Must be a float in the range[0, 1].", "type": "string", - "example": "prod/Dockerfile", - "x-ms-mutability": [ - "create", - "read" - ] + "example": "uniform(0.1, 0.2)", + "x-nullable": true + }, + "imageSize": { + "description": "Image size for train and validation. Must be a positive integer.\r\nNote: The training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(224, 640)", + "x-nullable": true + }, + "maxSize": { + "description": "Maximum size of the image to be rescaled before feeding it to the backbone.\r\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(640, 1333)", + "x-nullable": true + }, + "minSize": { + "description": "Minimum size of the image to be rescaled before feeding it to the backbone.\r\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(300, 600)", + "x-nullable": true + }, + "modelSize": { + "description": "Model size. Must be 'small', 'medium', 'large', or 'xlarge'.\r\nNote: training run may get into CUDA OOM if the model size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice('small', 'medium', 'large', 'xlarge')", + "x-nullable": true + }, + "multiScale": { + "description": "Enable multi-scale image by varying image size by +/- 50%.\r\nNote: training run may get into CUDA OOM if no sufficient GPU memory.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "nmsIouThreshold": { + "description": "IOU threshold used during inference in NMS post processing. Must be float in the range [0, 1].", + "type": "string", + "example": "uniform(0.1, 0.2)", + "x-nullable": true + }, + "tileGridSize": { + "description": "The grid size to use for tiling each image. Note: TileGridSize must not be\r\nNone to enable small object detection logic. A string containing two integers in mxn format.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice('3x2', '2x2')", + "x-nullable": true + }, + "tileOverlapRatio": { + "description": "Overlap ratio between adjacent tiles in each dimension. Must be float in the range [0, 1).\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "uniform(0.1, 0.2)", + "x-nullable": true + }, + "tilePredictionsNmsThreshold": { + "description": "The IOU threshold to use to perform NMS while merging predictions from tiles and image.\r\nUsed in validation/ inference. Must be float in the range [0, 1].\r\nNote: This settings is not supported for the 'yolov5' algorithm.\r\nNMS: Non-maximum suppression", + "type": "string", + "example": "uniform(0.2, 0.3)", + "x-nullable": true + }, + "validationIouThreshold": { + "description": "IOU threshold to use when computing validation metric. Must be float in the range [0, 1].", + "type": "string", + "example": "uniform(0.2, 0.3)", + "x-nullable": true + }, + "validationMetricType": { + "description": "Metric computation method to use for validation metrics. Must be 'none', 'coco', 'voc', or 'coco_voc'.", + "type": "string", + "example": "choice('none', 'coco', 'voc', 'coco_voc')", + "x-nullable": true } }, "additionalProperties": false }, - "CertificateDatastoreCredentials": { - "description": "Certificate datastore credentials configuration.", - "required": [ - "clientId", - "secrets", - "tenantId", - "thumbprint" - ], + "ImageModelSettings": { + "description": "Settings used for training the model.\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatastoreCredentials" - } - ], "properties": { - "authorityUrl": { - "description": "Authority URL used for authentication.", + "advancedSettings": { + "description": "Settings for advanced scenarios.", "type": "string", + "example": "key1:val1;key2;key3:val3;key4", "x-nullable": true }, - "clientId": { - "format": "uuid", - "description": "[Required] Service principal client ID.", - "type": "string" + "amsGradient": { + "description": "Enable AMSGrad when optimizer is 'adam' or 'adamw'.", + "type": "boolean", + "x-nullable": true }, - "resourceUrl": { - "description": "Resource the service principal has access to.", + "augmentations": { + "description": "Settings for using Augmentations.", "type": "string", + "example": "hflip;mosaic;random_crop", "x-nullable": true }, - "secrets": { - "description": "[Required] Service principal secrets.", - "$ref": "#/definitions/CertificateDatastoreSecrets", - "x-ms-mutability": [ - "create", - "update" - ], - "x-ms-secret": true + "beta1": { + "format": "float", + "description": "Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true }, - "tenantId": { - "format": "uuid", - "description": "[Required] ID of the tenant to which the service principal belongs.", - "type": "string" + "beta2": { + "format": "float", + "description": "Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true }, - "thumbprint": { - "description": "[Required] Thumbprint of the certificate used for authentication.", - "pattern": "[a-zA-Z0-9_]", - "type": "string" + "checkpointFrequency": { + "format": "int32", + "description": "Frequency to store model checkpoints. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "checkpointModel": { + "description": "The pretrained checkpoint model for incremental training.", + "$ref": "#/definitions/MLFlowModelJobInput", + "x-nullable": true + }, + "checkpointRunId": { + "description": "The id of a previous run that has a pretrained checkpoint for incremental training.", + "type": "string", + "x-nullable": true + }, + "distributed": { + "description": "Whether to use distributed training.", + "type": "boolean", + "x-nullable": true + }, + "earlyStopping": { + "description": "Enable early stopping logic during training.", + "type": "boolean", + "x-nullable": true + }, + "earlyStoppingDelay": { + "format": "int32", + "description": "Minimum number of epochs or validation evaluations to wait before primary metric improvement\r\nis tracked for early stopping. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "earlyStoppingPatience": { + "format": "int32", + "description": "Minimum number of epochs or validation evaluations with no primary metric improvement before\r\nthe run is stopped. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "enableOnnxNormalization": { + "description": "Enable normalization when exporting ONNX model.", + "type": "boolean", + "x-nullable": true + }, + "evaluationFrequency": { + "format": "int32", + "description": "Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "gradientAccumulationStep": { + "format": "int32", + "description": "Gradient accumulation means running a configured number of \"GradAccumulationStep\" steps without\r\nupdating the model weights while accumulating the gradients of those steps, and then using\r\nthe accumulated gradients to compute the weight updates. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "layersToFreeze": { + "format": "int32", + "description": "Number of layers to freeze for the model. Must be a positive integer.\r\nFor instance, passing 2 as value for 'seresnext' means\r\nfreezing layer0 and layer1. For a full list of models supported and details on layer freeze, please\r\nsee: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "integer", + "x-nullable": true + }, + "learningRate": { + "format": "float", + "description": "Initial learning rate. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "learningRateScheduler": { + "description": "Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.", + "default": "None", + "$ref": "#/definitions/LearningRateScheduler" + }, + "modelName": { + "description": "Name of the model to use for training.\r\nFor more information on the available models please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "string", + "x-nullable": true + }, + "momentum": { + "format": "float", + "description": "Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "nesterov": { + "description": "Enable nesterov when optimizer is 'sgd'.", + "type": "boolean", + "x-nullable": true + }, + "numberOfEpochs": { + "format": "int32", + "description": "Number of training epochs. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "numberOfWorkers": { + "format": "int32", + "description": "Number of data loader workers. Must be a non-negative integer.", + "type": "integer", + "x-nullable": true + }, + "optimizer": { + "description": "Type of optimizer.", + "default": "None", + "$ref": "#/definitions/StochasticOptimizer" + }, + "randomSeed": { + "format": "int32", + "description": "Random seed to be used when using deterministic training.", + "type": "integer", + "x-nullable": true + }, + "stepLRGamma": { + "format": "float", + "description": "Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "stepLRStepSize": { + "format": "int32", + "description": "Value of step size when learning rate scheduler is 'step'. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "trainingBatchSize": { + "format": "int32", + "description": "Training batch size. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "validationBatchSize": { + "format": "int32", + "description": "Validation batch size. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "warmupCosineLRCycles": { + "format": "float", + "description": "Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "warmupCosineLRWarmupEpochs": { + "format": "int32", + "description": "Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "weightDecay": { + "format": "float", + "description": "Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].", + "type": "number", + "x-nullable": true } }, - "x-ms-discriminator-value": "Certificate", "additionalProperties": false }, - "CertificateDatastoreSecrets": { - "description": "Datastore certificate secrets.", + "ImageModelSettingsClassification": { + "description": "Settings used for training the model.\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", "type": "object", "allOf": [ { - "$ref": "#/definitions/DatastoreSecrets" + "$ref": "#/definitions/ImageModelSettings" } ], "properties": { - "certificate": { - "description": "Service principal certificate.", - "type": "string", + "trainingCropSize": { + "format": "int32", + "description": "Image crop size that is input to the neural network for the training dataset. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "validationCropSize": { + "format": "int32", + "description": "Image crop size that is input to the neural network for the validation dataset. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "validationResizeSize": { + "format": "int32", + "description": "Image size to which to resize before cropping for validation dataset. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "weightedLoss": { + "format": "int32", + "description": "Weighted loss. The accepted values are 0 for no weighted loss.\r\n1 for weighted loss with sqrt.(class_weights). 2 for weighted loss with class_weights. Must be 0 or 1 or 2.", + "type": "integer", "x-nullable": true } }, - "x-ms-discriminator-value": "Certificate", "additionalProperties": false }, - "CodeConfiguration": { - "description": "Configuration for a scoring code asset.", - "required": [ - "scoringScript" - ], + "ImageModelSettingsObjectDetection": { + "description": "Settings used for training the model.\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageModelSettings" + } + ], "properties": { - "codeId": { - "description": "ARM resource ID of the code asset.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], + "boxDetectionsPerImage": { + "format": "int32", + "description": "Maximum number of detections per image, for all classes. Must be a positive integer.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "integer", + "x-nullable": true + }, + "boxScoreThreshold": { + "format": "float", + "description": "During inference, only return proposals with a classification score greater than\r\nBoxScoreThreshold. Must be a float in the range[0, 1].", + "type": "number", + "x-nullable": true + }, + "imageSize": { + "format": "int32", + "description": "Image size for train and validation. Must be a positive integer.\r\nNote: The training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "integer", + "x-nullable": true + }, + "maxSize": { + "format": "int32", + "description": "Maximum size of the image to be rescaled before feeding it to the backbone.\r\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "integer", + "x-nullable": true + }, + "minSize": { + "format": "int32", + "description": "Minimum size of the image to be rescaled before feeding it to the backbone.\r\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "integer", + "x-nullable": true + }, + "modelSize": { + "description": "Model size. Must be 'small', 'medium', 'large', or 'xlarge'.\r\nNote: training run may get into CUDA OOM if the model size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "default": "None", + "$ref": "#/definitions/ModelSize" + }, + "multiScale": { + "description": "Enable multi-scale image by varying image size by +/- 50%.\r\nNote: training run may get into CUDA OOM if no sufficient GPU memory.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "boolean", + "x-nullable": true + }, + "nmsIouThreshold": { + "format": "float", + "description": "IOU threshold used during inference in NMS post processing. Must be a float in the range [0, 1].", + "type": "number", "x-nullable": true }, - "scoringScript": { - "description": "[Required] The script to execute on startup. eg. \"score.py\"", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", + "tileGridSize": { + "description": "The grid size to use for tiling each image. Note: TileGridSize must not be\r\nNone to enable small object detection logic. A string containing two integers in mxn format.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] + "example": "3x2", + "x-nullable": true + }, + "tileOverlapRatio": { + "format": "float", + "description": "Overlap ratio between adjacent tiles in each dimension. Must be float in the range [0, 1).\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "number", + "x-nullable": true + }, + "tilePredictionsNmsThreshold": { + "format": "float", + "description": "The IOU threshold to use to perform NMS while merging predictions from tiles and image.\r\nUsed in validation/ inference. Must be float in the range [0, 1].\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "number", + "x-nullable": true + }, + "validationIouThreshold": { + "format": "float", + "description": "IOU threshold to use when computing validation metric. Must be float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "validationMetricType": { + "description": "Metric computation method to use for validation metrics.", + "default": "None", + "$ref": "#/definitions/ValidationMetricType" } }, "additionalProperties": false }, - "CodeContainer": { - "description": "Container for code asset versions.", + "ImageObjectDetection": { + "description": "Image Object Detection. Object detection is used to identify objects in an image and locate each object with a\r\nbounding box e.g. locate all dogs and cats in an image and draw a bounding box around each.", "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetContainer" + "$ref": "#/definitions/ImageObjectDetectionBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" } ], - "x-ms-client-name": "CodeContainerProperties", + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "MeanAveragePrecision", + "$ref": "#/definitions/ObjectDetectionPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageObjectDetection", "additionalProperties": false }, - "CodeContainerResource": { - "description": "Azure Resource Manager resource envelope.", - "required": [ - "properties" - ], + "ImageObjectDetectionBase": { "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + "$ref": "#/definitions/ImageVertical" } ], "properties": { - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/CodeContainer" + "modelSettings": { + "description": "Settings used for training the model.", + "$ref": "#/definitions/ImageModelSettingsObjectDetection", + "x-nullable": true + }, + "searchSpace": { + "description": "Search space for sampling different combinations of models and their hyperparameters.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageModelDistributionSettingsObjectDetection" + }, + "x-nullable": true, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "CodeContainer", "additionalProperties": false }, - "CodeContainerResourceArmPaginatedResult": { - "description": "A paginated list of CodeContainer entities.", + "ImageSweepLimitSettings": { + "description": "Limit settings for model sweeping and hyperparameter sweeping.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of CodeContainer objects. If null, there are no additional pages.", - "type": "string" + "maxConcurrentTrials": { + "format": "int32", + "description": "Maximum number of concurrent iterations for the underlying Sweep job.", + "type": "integer", + "x-nullable": true }, - "value": { - "description": "An array of objects of type CodeContainer.", - "type": "array", - "items": { - "$ref": "#/definitions/CodeContainerResource" - } + "maxTrials": { + "format": "int32", + "description": "Maximum number of iterations for the underlying Sweep job.", + "type": "integer", + "x-nullable": true } }, "additionalProperties": false }, - "CodeVersion": { - "description": "Code asset version details.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AssetBase" - } + "ImageSweepSettings": { + "description": "Model sweeping and hyperparameter sweeping related settings.", + "required": [ + "limits", + "samplingAlgorithm" ], + "type": "object", "properties": { - "codeUri": { - "description": "Uri where code is located", - "type": "string", - "example": "https://blobStorage/folderName", + "earlyTermination": { + "description": "Type of early termination policy.", + "$ref": "#/definitions/EarlyTerminationPolicy", "x-nullable": true + }, + "limits": { + "description": "[Required] Limit settings for model sweeping and hyperparameter sweeping.", + "$ref": "#/definitions/ImageSweepLimitSettings" + }, + "samplingAlgorithm": { + "description": "[Required] Type of the hyperparameter sampling algorithms.", + "$ref": "#/definitions/SamplingAlgorithmType" } }, - "x-ms-client-name": "CodeVersionProperties", "additionalProperties": false }, - "CodeVersionResource": { - "description": "Azure Resource Manager resource envelope.", + "ImageVertical": { + "description": "Abstract class for AutoML tasks that train image (computer vision) models -\r\nsuch as Image Classification / Image Classification Multilabel / Image Object Detection / Image Instance Segmentation.", "required": [ - "properties" + "limitSettings" ], "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } - ], "properties": { - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/CodeVersion" + "limitSettings": { + "description": "[Required] Limit settings for the AutoML job.", + "$ref": "#/definitions/ImageLimitSettings" + }, + "sweepSettings": { + "description": "Model sweeping and hyperparameter sweeping related settings.", + "$ref": "#/definitions/ImageSweepSettings", + "x-nullable": true + }, + "validationData": { + "description": "Validation data inputs.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + }, + "validationDataSize": { + "format": "double", + "description": "The fraction of training dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", + "type": "number", + "x-nullable": true } }, - "x-ms-client-name": "CodeVersion", "additionalProperties": false }, - "CodeVersionResourceArmPaginatedResult": { - "description": "A paginated list of CodeVersion entities.", + "InferenceContainerProperties": { "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of CodeVersion objects. If null, there are no additional pages.", - "type": "string" + "livenessRoute": { + "description": "The route to check the liveness of the inference server container.", + "$ref": "#/definitions/Route" }, - "value": { - "description": "An array of objects of type CodeVersion.", - "type": "array", - "items": { - "$ref": "#/definitions/CodeVersionResource" - } + "readinessRoute": { + "description": "The route to check the readiness of the inference server container.", + "$ref": "#/definitions/Route" + }, + "scoringRoute": { + "description": "The port to send the scoring requests to, within the inference server container.", + "$ref": "#/definitions/Route" } }, "additionalProperties": false }, - "CommandJob": { - "description": "Command job definition.", + "InputDeliveryMode": { + "description": "Enum to determine the input data delivery mode.", + "enum": [ + "ReadOnlyMount", + "ReadWriteMount", + "Download", + "Direct", + "EvalMount", + "EvalDownload" + ], + "type": "string", + "x-ms-enum": { + "name": "InputDeliveryMode", + "modelAsString": true, + "values": [ + { + "value": "ReadOnlyMount" + }, + { + "value": "ReadWriteMount" + }, + { + "value": "Download" + }, + { + "value": "Direct" + }, + { + "value": "EvalMount" + }, + { + "value": "EvalDownload" + } + ] + }, + "additionalProperties": false + }, + "InstanceSegmentationPrimaryMetrics": { + "description": "Primary metrics for InstanceSegmentation tasks.", + "enum": [ + "MeanAveragePrecision" + ], + "type": "string", + "x-ms-enum": { + "name": "InstanceSegmentationPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "MeanAveragePrecision", + "description": "Mean Average Precision (MAP) is the average of AP (Average Precision).\nAP is calculated for each class and averaged to get the MAP." + } + ] + }, + "additionalProperties": false + }, + "JobBase": { + "description": "Base definition for a job.", "required": [ - "command", - "environmentId" + "jobType" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/JobBase" + "$ref": "#/definitions/ResourceBase" } ], "properties": { - "codeId": { - "description": "ARM resource ID of the code asset.", + "componentId": { + "description": "ARM resource ID of the component resource.", "type": "string", "x-ms-mutability": [ "create", @@ -6298,129 +10602,82 @@ ], "x-nullable": true }, - "command": { - "description": "[Required] The command to execute on startup of the job. eg. \"python train.py\"", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", + "computeId": { + "description": "ARM resource ID of the compute resource.", "type": "string", "x-ms-mutability": [ "create", "read" - ] + ], + "x-nullable": true }, - "distribution": { - "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", - "$ref": "#/definitions/DistributionConfiguration", + "displayName": { + "description": "Display name of job.", + "type": "string", "x-ms-mutability": [ "create", "read" ], "x-nullable": true }, - "environmentId": { - "description": "[Required] The ARM resource ID of the Environment specification for the job.", - "pattern": "[a-zA-Z0-9_]", + "experimentName": { + "description": "The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment.", + "default": "Default", "type": "string", "x-ms-mutability": [ "create", "read" ] }, - "environmentVariables": { - "description": "Environment variables included in the job.", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true - }, + "identity": { + "description": "Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null.\r\nDefaults to AmlToken if null.", + "$ref": "#/definitions/IdentityConfiguration", "x-ms-mutability": [ "create", "read" ], "x-nullable": true }, - "inputs": { - "description": "Mapping of input data bindings used in the job.", - "type": "object", - "additionalProperties": { - "description": "Command job definition.", - "$ref": "#/definitions/JobInput", - "x-nullable": true - }, + "isArchived": { + "description": "Is the asset archived?", + "default": false, + "type": "boolean", "x-ms-mutability": [ "create", - "read" - ], - "x-nullable": true + "read", + "update" + ] }, - "limits": { - "description": "Command Job limit.", - "$ref": "#/definitions/CommandJobLimits", + "jobType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobType", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] }, - "outputs": { - "description": "Mapping of output data bindings used in the job.", + "services": { + "description": "List of JobEndpoints.\r\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.", "type": "object", "additionalProperties": { - "description": "Job output definition container information on where to find job output/logs.", - "$ref": "#/definitions/JobOutput", + "$ref": "#/definitions/JobService", "x-nullable": true }, - "x-ms-mutability": [ - "create", - "read" - ], "x-nullable": true }, - "parameters": { - "description": "Input parameters.", - "type": "object", + "status": { + "description": "Status of the job.", + "$ref": "#/definitions/JobStatus", "readOnly": true, "x-ms-mutability": [ "read" - ], - "x-nullable": true - }, - "resources": { - "description": "Compute Resource configuration for the job.", - "default": "{}", - "$ref": "#/definitions/ResourceConfiguration", - "x-ms-mutability": [ - "create", - "read" ] } }, - "x-ms-discriminator-value": "Command", - "additionalProperties": false - }, - "CommandJobLimits": { - "description": "Command Job limit class.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/JobLimits" - } - ], - "x-ms-discriminator-value": "Command", - "additionalProperties": false - }, - "ComponentContainer": { - "description": "Component container definition.\r\n", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AssetContainer" - } - ], - "x-ms-client-name": "ComponentContainerProperties", - "additionalProperties": false + "discriminator": "jobType", + "x-ms-client-name": "JobBaseProperties" }, - "ComponentContainerResource": { + "JobBaseResource": { "description": "Azure Resource Manager resource envelope.", "required": [ "properties" @@ -6434,492 +10691,913 @@ "properties": { "properties": { "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/ComponentContainer" + "$ref": "#/definitions/JobBase" } }, - "x-ms-client-name": "ComponentContainer", + "x-ms-client-name": "JobBase", "additionalProperties": false }, - "ComponentContainerResourceArmPaginatedResult": { - "description": "A paginated list of ComponentContainer entities.", + "JobBaseResourceArmPaginatedResult": { + "description": "A paginated list of JobBase entities.", "type": "object", "properties": { "nextLink": { - "description": "The link to the next page of ComponentContainer objects. If null, there are no additional pages.", + "description": "The link to the next page of JobBase objects. If null, there are no additional pages.", "type": "string" }, "value": { - "description": "An array of objects of type ComponentContainer.", + "description": "An array of objects of type JobBase.", "type": "array", "items": { - "$ref": "#/definitions/ComponentContainerResource" + "$ref": "#/definitions/JobBaseResource" + } + } + }, + "additionalProperties": false + }, + "JobInput": { + "description": "Command job definition.", + "required": [ + "jobInputType" + ], + "type": "object", + "properties": { + "description": { + "description": "Description for the input.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jobInputType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobInputType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "jobInputType" + }, + "JobInputType": { + "description": "Enum to determine the Job Input Type.", + "enum": [ + "literal", + "uri_file", + "uri_folder", + "mltable", + "custom_model", + "mlflow_model", + "triton_model" + ], + "type": "string", + "x-ms-enum": { + "name": "JobInputType", + "modelAsString": true, + "values": [ + { + "value": "literal" + }, + { + "value": "uri_file" + }, + { + "value": "uri_folder" + }, + { + "value": "mltable" + }, + { + "value": "custom_model" + }, + { + "value": "mlflow_model" + }, + { + "value": "triton_model" + } + ] + }, + "additionalProperties": false + }, + "JobLimits": { + "required": [ + "jobLimitsType" + ], + "type": "object", + "properties": { + "jobLimitsType": { + "description": "[Required] JobLimit type.", + "$ref": "#/definitions/JobLimitsType" + }, + "timeout": { + "format": "duration", + "description": "The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.", + "type": "string", + "x-nullable": true + } + }, + "discriminator": "jobLimitsType" + }, + "JobLimitsType": { + "enum": [ + "Command", + "Sweep" + ], + "type": "string", + "x-ms-enum": { + "name": "JobLimitsType", + "modelAsString": true, + "values": [ + { + "value": "Command" + }, + { + "value": "Sweep" + } + ] + }, + "additionalProperties": false + }, + "JobOutput": { + "description": "Job output definition container information on where to find job output/logs.", + "required": [ + "jobOutputType" + ], + "type": "object", + "properties": { + "description": { + "description": "Description for the output.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jobOutputType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobOutputType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "jobOutputType" + }, + "JobOutputType": { + "description": "Enum to determine the Job Output Type.", + "enum": [ + "uri_file", + "uri_folder", + "mltable", + "custom_model", + "mlflow_model", + "triton_model" + ], + "type": "string", + "x-ms-enum": { + "name": "JobOutputType", + "modelAsString": true, + "values": [ + { + "value": "uri_file" + }, + { + "value": "uri_folder" + }, + { + "value": "mltable" + }, + { + "value": "custom_model" + }, + { + "value": "mlflow_model" + }, + { + "value": "triton_model" + } + ] + }, + "additionalProperties": false + }, + "JobProvisioningState": { + "description": "Enum to determine the job provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress" + ], + "type": "string", + "x-ms-enum": { + "name": "JobProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + }, + { + "value": "InProgress" } + ] + }, + "additionalProperties": false + }, + "DeploymentResourceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceConfiguration" } - }, + ], "additionalProperties": false }, - "ComponentVersion": { - "description": "Definition of a component version: defines resources that span component types.", + "JobResourceConfiguration": { "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetBase" + "$ref": "#/definitions/ResourceConfiguration" } ], "properties": { - "componentSpec": { - "description": "Defines Component definition details.\r\n", - "type": "object", - "example": { - "name": "Hello_Python_World", - "display_name": "Hello_Python_World", - "version": 1, - "type": "command", - "code": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/mycode/versions/1", - "environment": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/AzureML-Tutorial/versions/1", - "command": "python hello.py" - }, + "dockerArgs": { + "description": "Extra arguments to pass to the Docker run command. This would override any parameters that have already been set by the system, or in this section. This parameter is only supported for Azure ML compute types.", + "type": "string", "x-ms-mutability": [ "create", "read" ], "x-nullable": true + }, + "shmSize": { + "description": "Size of the docker container's shared memory block. This should be in the format of (number)(unit) where number as to be greater than 0 and the unit can be one of b(bytes), k(kilobytes), m(megabytes), or g(gigabytes).", + "default": "2g", + "pattern": "\\d+[bBkKmMgG]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] } }, - "x-ms-client-name": "ComponentVersionProperties", "additionalProperties": false }, - "ComponentVersionResource": { - "description": "Azure Resource Manager resource envelope.", + "JobScheduleAction": { "required": [ - "properties" + "actionType", + "jobDefinition" ], "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + "$ref": "#/definitions/ScheduleActionBase" } ], "properties": { - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/ComponentVersion" - } - }, - "x-ms-client-name": "ComponentVersion", - "additionalProperties": false - }, - "ComponentVersionResourceArmPaginatedResult": { - "description": "A paginated list of ComponentVersion entities.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link to the next page of ComponentVersion objects. If null, there are no additional pages.", - "type": "string" - }, - "value": { - "description": "An array of objects of type ComponentVersion.", - "type": "array", - "items": { - "$ref": "#/definitions/ComponentVersionResource" - } + "jobDefinition": { + "description": "[Required] Defines Schedule action definition details.", + "$ref": "#/definitions/JobBase", + "x-ms-mutability": [ + "create", + "read", + "update" + ] } }, + "x-ms-discriminator-value": "CreateJob", "additionalProperties": false }, - "ContainerResourceRequirements": { - "description": "Resource requirements for each container instance within an online deployment.", + "JobService": { + "description": "Job endpoint definition", "type": "object", "properties": { - "containerResourceLimits": { - "description": "Container resource limit info:", - "$ref": "#/definitions/ContainerResourceSettings", + "endpoint": { + "description": "Url for endpoint.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], "x-nullable": true }, - "containerResourceRequests": { - "description": "Container resource request info:", - "$ref": "#/definitions/ContainerResourceSettings", - "x-nullable": true - } - }, - "additionalProperties": false - }, - "ContainerResourceSettings": { - "type": "object", - "properties": { - "cpu": { - "description": "Number of vCPUs request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "errorMessage": { + "description": "Any error in the service.", "type": "string", - "example": "1", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-nullable": true }, - "gpu": { - "description": "Number of Nvidia GPU cards request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "jobServiceType": { + "description": "Endpoint type.", "type": "string", - "example": "1", + "x-ms-mutability": [ + "create", + "read" + ], "x-nullable": true }, - "memory": { - "description": "Memory size request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "port": { + "format": "int32", + "description": "Port for endpoint.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "properties": { + "description": "Additional properties to set on the endpoint.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "status": { + "description": "Status of endpoint.", "type": "string", - "example": "2Gi", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-nullable": true } }, "additionalProperties": false }, - "ContainerType": { + "JobStatus": { + "description": "The status of a job.", "enum": [ - "StorageInitializer", - "InferenceServer" + "NotStarted", + "Starting", + "Provisioning", + "Preparing", + "Queued", + "Running", + "Finalizing", + "CancelRequested", + "Completed", + "Failed", + "Canceled", + "NotResponding", + "Paused", + "Unknown", + "Scheduled" ], "type": "string", "x-ms-enum": { - "name": "ContainerType", + "name": "JobStatus", "modelAsString": true, "values": [ { - "value": "StorageInitializer" + "value": "NotStarted", + "description": "Run hasn't started yet." }, { - "value": "InferenceServer" + "value": "Starting", + "description": "Run has started. The user has a run ID." + }, + { + "value": "Provisioning", + "description": "(Not used currently) It will be used if ES is creating the compute target." + }, + { + "value": "Preparing", + "description": "The run environment is being prepared." + }, + { + "value": "Queued", + "description": "The job is queued in the compute target. For example, in BatchAI the job is in queued state, while waiting for all required nodes to be ready." + }, + { + "value": "Running", + "description": "The job started to run in the compute target." + }, + { + "value": "Finalizing", + "description": "Job is completed in the target. It is in output collection state now." + }, + { + "value": "CancelRequested", + "description": "Cancellation has been requested for the job." + }, + { + "value": "Completed", + "description": "Job completed successfully. This reflects that both the job itself and output collection states completed successfully" + }, + { + "value": "Failed", + "description": "Job failed." + }, + { + "value": "Canceled", + "description": "Following cancellation request, the job is now successfully canceled." + }, + { + "value": "NotResponding", + "description": "When heartbeat is enabled, if the run isn't updating any information to RunHistory then the run goes to NotResponding state.\nNotResponding is the only state that is exempt from strict transition orders. A run can go from NotResponding to any of the previous states." + }, + { + "value": "Paused", + "description": "The job is paused by users. Some adjustment to labeling jobs can be made only in paused state." + }, + { + "value": "Unknown", + "description": "Default job status if not mapped to all other statuses" + }, + { + "value": "Scheduled", + "description": "The job is in a scheduled state. Job is not in any active state." } ] }, "additionalProperties": false }, - "CredentialsType": { - "description": "Enum to determine the datastore credentials type.", + "JobType": { + "description": "Enum to determine the type of job.", "enum": [ - "AccountKey", - "Certificate", - "None", - "Sas", - "ServicePrincipal" + "AutoML", + "Command", + "Labeling", + "Sweep", + "Pipeline", + "Spark" ], "type": "string", "x-ms-enum": { - "name": "CredentialsType", + "name": "JobType", "modelAsString": true, "values": [ { - "value": "AccountKey" + "value": "AutoML" }, { - "value": "Certificate" + "value": "Command" }, { - "value": "None" + "value": "Labeling" }, { - "value": "Sas" + "value": "Sweep" }, { - "value": "ServicePrincipal" + "value": "Pipeline" + }, + { + "value": "Spark" } ] }, "additionalProperties": false }, - "CustomModelJobInput": { + "KerberosCredentials": { + "required": [ + "kerberosKdcAddress", + "kerberosPrincipal", + "kerberosRealm" + ], + "type": "object", + "properties": { + "kerberosKdcAddress": { + "description": "[Required] IP Address or DNS HostName.", + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "kerberosPrincipal": { + "description": "[Required] Kerberos Username", + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "kerberosRealm": { + "description": "[Required] Domain over which a Kerberos authentication server has the authority to authenticate a user, host or service.", + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "KerberosKeytabCredentials": { + "required": [ + "secrets" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetJobInput" + "$ref": "#/definitions/KerberosCredentials" }, { - "$ref": "#/definitions/JobInput" + "$ref": "#/definitions/DatastoreCredentials" } ], - "x-ms-discriminator-value": "custom_model", + "properties": { + "secrets": { + "description": "[Required] Keytab secrets.", + "$ref": "#/definitions/KerberosKeytabSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + }, + "x-ms-discriminator-value": "KerberosKeytab", "additionalProperties": false }, - "CustomModelJobOutput": { + "KerberosKeytabSecrets": { "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetJobOutput" - }, - { - "$ref": "#/definitions/JobOutput" + "$ref": "#/definitions/DatastoreSecrets" } ], - "x-ms-discriminator-value": "custom_model", + "properties": { + "kerberosKeytab": { + "description": "Kerberos keytab secret.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "KerberosKeytab", "additionalProperties": false }, - "DataContainer": { - "description": "Container for data asset versions.", + "KerberosPasswordCredentials": { "required": [ - "dataType" + "secrets" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetContainer" + "$ref": "#/definitions/KerberosCredentials" + }, + { + "$ref": "#/definitions/DatastoreCredentials" } ], "properties": { - "dataType": { - "description": "[Required] Specifies the type of data.", - "$ref": "#/definitions/DataType", + "secrets": { + "description": "[Required] Kerberos password secrets.", + "$ref": "#/definitions/KerberosPasswordSecrets", "x-ms-mutability": [ "create", - "read" - ] + "update" + ], + "x-ms-secret": true } }, - "x-ms-client-name": "DataContainerProperties", + "x-ms-discriminator-value": "KerberosPassword", "additionalProperties": false }, - "DataContainerResource": { - "description": "Azure Resource Manager resource envelope.", - "required": [ - "properties" - ], + "KerberosPasswordSecrets": { "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + "$ref": "#/definitions/DatastoreSecrets" } ], "properties": { - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/DataContainer" + "kerberosPassword": { + "description": "Kerberos password secret.", + "type": "string", + "x-nullable": true } }, - "x-ms-client-name": "DataContainer", + "x-ms-discriminator-value": "KerberosPassword", "additionalProperties": false }, - "DataContainerResourceArmPaginatedResult": { - "description": "A paginated list of DataContainer entities.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link to the next page of DataContainer objects. If null, there are no additional pages.", - "type": "string" - }, - "value": { - "description": "An array of objects of type DataContainer.", - "type": "array", - "items": { - "$ref": "#/definitions/DataContainerResource" + "KeyType": { + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true, + "values": [ + { + "value": "Primary" + }, + { + "value": "Secondary" } - } + ] }, "additionalProperties": false }, - "DataPathAssetReference": { - "description": "Reference to an asset via its path in a datastore.", + "KubernetesOnlineDeployment": { + "description": "Properties specific to a KubernetesOnlineDeployment.", "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetReferenceBase" + "$ref": "#/definitions/OnlineDeployment" } ], "properties": { - "datastoreId": { - "description": "ARM resource ID of the datastore where the asset is located.", + "containerResourceRequirements": { + "description": "The resource requirements for the container (cpu and memory).", + "$ref": "#/definitions/ContainerResourceRequirements", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Kubernetes", + "additionalProperties": false + }, + "LabelCategory": { + "description": "Label category definition", + "type": "object", + "properties": { + "classes": { + "description": "Dictionary of label classes in this category.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/LabelClass", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, + "displayName": { + "description": "Display name of the label category.", "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], "x-nullable": true }, - "path": { - "description": "The path of the file/directory in the datastore.", + "multiSelectEnabled": { + "description": "Indicates whether it is allowed to select multiple classes in this category.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "additionalProperties": false + }, + "LabelClass": { + "description": "Label class definition", + "type": "object", + "properties": { + "displayName": { + "description": "Display name of the label class.", "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "subclasses": { + "description": "Dictionary of subclasses of the label class.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/LabelClass", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ], "x-nullable": true } }, - "x-ms-discriminator-value": "DataPath", "additionalProperties": false }, - "Datastore": { - "description": "Base definition for datastore contents configuration.", - "required": [ - "credentials", - "datastoreType" - ], + "LabelingDataConfiguration": { + "description": "Labeling data configuration definition", + "type": "object", + "properties": { + "dataId": { + "description": "Resource Id of the data asset to perform labeling.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "incrementalDataRefreshEnabled": { + "description": "Indicates whether to enable incremental data refresh.", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "additionalProperties": false + }, + "LabelingJob": { + "description": "Labeling job definition", "type": "object", "allOf": [ { - "$ref": "#/definitions/ResourceBase" + "$ref": "#/definitions/JobBase" } ], "properties": { - "credentials": { - "description": "[Required] Account credentials.", - "$ref": "#/definitions/DatastoreCredentials" + "createdDateTime": { + "format": "date-time", + "description": "Created time of the job in UTC timezone.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true }, - "datastoreType": { - "description": "[Required] Storage type backing the datastore.", - "$ref": "#/definitions/DatastoreType" + "dataConfiguration": { + "description": "Configuration of data used in the job.", + "$ref": "#/definitions/LabelingDataConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true }, - "isDefault": { - "description": "Readonly property to indicate if datastore is the workspace default datastore", - "type": "boolean", + "jobInstructions": { + "description": "Labeling instructions of the job.", + "$ref": "#/definitions/LabelingJobInstructions", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, + "labelCategories": { + "description": "Label categories of the job.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/LabelCategory", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, + "labelingJobMediaProperties": { + "description": "Media type specific properties in the job.", + "$ref": "#/definitions/LabelingJobMediaProperties", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "mlAssistConfiguration": { + "description": "Configuration of MLAssist feature in the job.", + "default": "{\"MLAssist\":\"Disabled\"}", + "$ref": "#/definitions/MLAssistConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "progressMetrics": { + "description": "Progress metrics of the job.", + "$ref": "#/definitions/ProgressMetrics", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "projectId": { + "format": "uuid", + "description": "Internal id of the job(Previously called project).", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "provisioningState": { + "description": "Specifies the labeling job provisioning state.", + "$ref": "#/definitions/JobProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "statusMessages": { + "description": "Status messages of the job.", + "type": "array", + "items": { + "$ref": "#/definitions/StatusMessage" + }, "readOnly": true, "x-ms-mutability": [ "read" - ] - } - }, - "discriminator": "datastoreType", - "x-ms-client-name": "DatastoreProperties" - }, - "DatastoreCredentials": { - "description": "Base definition for datastore credentials.", - "required": [ - "credentialsType" - ], - "type": "object", - "properties": { - "credentialsType": { - "description": "[Required] Credential type used to authentication with storage.", - "$ref": "#/definitions/CredentialsType" + ], + "x-nullable": true, + "x-ms-identifiers": [] } }, - "discriminator": "credentialsType" + "x-ms-discriminator-value": "Labeling", + "x-ms-client-name": "LabelingJobProperties", + "additionalProperties": false }, - "DatastoreResource": { - "description": "Azure Resource Manager resource envelope.", - "required": [ - "properties" - ], + "LabelingJobImageProperties": { + "description": "Properties of a labeling job for image data", "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + "$ref": "#/definitions/LabelingJobMediaProperties" } ], "properties": { - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/Datastore" - } - }, - "x-ms-client-name": "Datastore", - "additionalProperties": false - }, - "DatastoreResourceArmPaginatedResult": { - "description": "A paginated list of Datastore entities.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link to the next page of Datastore objects. If null, there are no additional pages.", - "type": "string" - }, - "value": { - "description": "An array of objects of type Datastore.", - "type": "array", - "items": { - "$ref": "#/definitions/DatastoreResource" - } + "annotationType": { + "description": "Annotation type of image labeling job.", + "default": "Classification", + "$ref": "#/definitions/ImageAnnotationType", + "x-ms-mutability": [ + "create", + "read" + ] } }, + "x-ms-discriminator-value": "Image", "additionalProperties": false }, - "DatastoreSecrets": { - "description": "Base definition for datastore secrets.", - "required": [ - "secretsType" - ], + "LabelingJobInstructions": { + "description": "Instructions for labeling job", "type": "object", "properties": { - "secretsType": { - "description": "[Required] Credential type used to authentication with storage.", - "$ref": "#/definitions/SecretsType" + "uri": { + "description": "The link to a page with detailed labeling instructions for labelers.", + "type": "string", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true } }, - "discriminator": "secretsType" - }, - "DatastoreType": { - "description": "Enum to determine the datastore contents type.", - "enum": [ - "AzureBlob", - "AzureDataLakeGen1", - "AzureDataLakeGen2", - "AzureFile" - ], - "type": "string", - "x-ms-enum": { - "name": "DatastoreType", - "modelAsString": true, - "values": [ - { - "value": "AzureBlob" - }, - { - "value": "AzureDataLakeGen1" - }, - { - "value": "AzureDataLakeGen2" - }, - { - "value": "AzureFile" - } - ] - }, "additionalProperties": false }, - "DataType": { - "description": "Enum to determine the type of data.", - "enum": [ - "uri_file", - "uri_folder", - "mltable" - ], - "type": "string", - "x-ms-enum": { - "name": "DataType", - "modelAsString": true, - "values": [ - { - "value": "uri_file" - }, - { - "value": "uri_folder" - }, - { - "value": "mltable" - } - ] - }, - "additionalProperties": false - }, - "DataVersionBase": { - "description": "Data version base definition", + "LabelingJobMediaProperties": { + "description": "Properties of a labeling job", "required": [ - "dataType", - "dataUri" + "mediaType" ], "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AssetBase" - } - ], "properties": { - "dataType": { - "description": "[Required] Specifies the type of data.", - "$ref": "#/definitions/DataType", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "dataUri": { - "description": "[Required] Uri of the data. Usage/meaning depends on Microsoft.MachineLearning.ManagementFrontEnd.Contracts.V20220501.Assets.DataVersionBase.DataType", - "pattern": "[a-zA-Z0-9_]", - "type": "string", + "mediaType": { + "description": "[Required] Media type of the job.", + "$ref": "#/definitions/MediaType", "x-ms-mutability": [ "create", "read" ] } }, - "discriminator": "dataType", - "x-ms-client-name": "DataVersionBaseProperties" + "discriminator": "mediaType" }, - "DataVersionBaseResource": { + "LabelingJobResource": { "description": "Azure Resource Manager resource envelope.", "required": [ "properties" @@ -6933,208 +11611,180 @@ "properties": { "properties": { "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/DataVersionBase" + "$ref": "#/definitions/LabelingJob" } }, - "x-ms-client-name": "DataVersionBase", + "x-ms-client-name": "LabelingJob", "additionalProperties": false }, - "DataVersionBaseResourceArmPaginatedResult": { - "description": "A paginated list of DataVersionBase entities.", + "LabelingJobResourceArmPaginatedResult": { + "description": "A paginated list of LabelingJob entities.", "type": "object", "properties": { "nextLink": { - "description": "The link to the next page of DataVersionBase objects. If null, there are no additional pages.", + "description": "The link to the next page of LabelingJob objects. If null, there are no additional pages.", "type": "string" }, "value": { - "description": "An array of objects of type DataVersionBase.", + "description": "An array of objects of type LabelingJob.", "type": "array", "items": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/LabelingJobResource" } } }, "additionalProperties": false }, - "DefaultScaleSettings": { + "LabelingJobTextProperties": { + "description": "Properties of a labeling job for text data", "type": "object", "allOf": [ { - "$ref": "#/definitions/OnlineScaleSettings" + "$ref": "#/definitions/LabelingJobMediaProperties" } ], - "x-ms-discriminator-value": "Default", - "additionalProperties": false - }, - "DeploymentLogs": { - "type": "object", - "properties": { - "content": { - "description": "The retrieved online deployment logs.", - "type": "string", - "x-nullable": true - } - }, - "additionalProperties": false - }, - "DeploymentLogsRequest": { - "type": "object", "properties": { - "containerType": { - "description": "The type of container to retrieve logs from.", - "default": "InferenceServer", - "$ref": "#/definitions/ContainerType" - }, - "tail": { - "format": "int32", - "description": "The maximum number of lines to tail.", - "type": "integer", - "x-nullable": true + "annotationType": { + "description": "Annotation type of text labeling job.", + "default": "Classification", + "$ref": "#/definitions/TextAnnotationType", + "x-ms-mutability": [ + "create", + "read" + ] } }, + "x-ms-discriminator-value": "Text", "additionalProperties": false }, - "DeploymentProvisioningState": { - "description": "Possible values for DeploymentProvisioningState.", + "LearningRateScheduler": { + "description": "Learning rate scheduler enum.", "enum": [ - "Creating", - "Deleting", - "Scaling", - "Updating", - "Succeeded", - "Failed", - "Canceled" + "None", + "WarmupCosine", + "Step" ], "type": "string", "x-ms-enum": { - "name": "DeploymentProvisioningState", + "name": "LearningRateScheduler", "modelAsString": true, "values": [ { - "value": "Creating" - }, - { - "value": "Deleting" - }, - { - "value": "Scaling" - }, - { - "value": "Updating" - }, - { - "value": "Succeeded" + "value": "None", + "description": "No learning rate scheduler selected." }, { - "value": "Failed" + "value": "WarmupCosine", + "description": "Cosine Annealing With Warmup." }, { - "value": "Canceled" + "value": "Step", + "description": "Step learning rate scheduler." } ] }, "additionalProperties": false }, - "DistributionConfiguration": { - "description": "Base definition for job distribution configuration.", - "required": [ - "distributionType" - ], - "type": "object", - "properties": { - "distributionType": { - "description": "[Required] Specifies the type of distribution framework.", - "$ref": "#/definitions/DistributionType", - "x-ms-mutability": [ - "create", - "read" - ] - } - }, - "discriminator": "distributionType" - }, - "DistributionType": { - "description": "Enum to determine the job distribution type.", + "ListViewType": { "enum": [ - "PyTorch", - "TensorFlow", - "Mpi" + "ActiveOnly", + "ArchivedOnly", + "All" ], "type": "string", "x-ms-enum": { - "name": "DistributionType", + "name": "ListViewType", "modelAsString": true, "values": [ { - "value": "PyTorch" + "value": "ActiveOnly" }, { - "value": "TensorFlow" + "value": "ArchivedOnly" }, { - "value": "Mpi" + "value": "All" } ] }, "additionalProperties": false }, - "EarlyTerminationPolicy": { - "description": "Early termination policies enable canceling poor-performing runs before they complete", + "LiteralJobInput": { + "description": "Literal input type.", "required": [ - "policyType" + "value" ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobInput" + } + ], "properties": { - "delayEvaluation": { - "format": "int32", - "description": "Number of intervals by which to delay the first evaluation.", - "default": 0, - "type": "integer" - }, - "evaluationInterval": { - "format": "int32", - "description": "Interval (number of runs) between policy evaluations.", - "default": 0, - "type": "integer" - }, - "policyType": { - "description": "[Required] Name of policy configuration", - "$ref": "#/definitions/EarlyTerminationPolicyType" + "value": { + "description": "[Required] Literal value for the input.", + "pattern": "[a-zA-Z0-9_]", + "type": "string" } }, - "discriminator": "policyType" + "x-ms-discriminator-value": "literal", + "additionalProperties": false }, - "EarlyTerminationPolicyType": { + "LogVerbosity": { + "description": "Enum for setting log verbosity.", "enum": [ - "Bandit", - "MedianStopping", - "TruncationSelection" + "NotSet", + "Debug", + "Info", + "Warning", + "Error", + "Critical" ], "type": "string", "x-ms-enum": { - "name": "EarlyTerminationPolicyType", + "name": "LogVerbosity", "modelAsString": true, "values": [ { - "value": "Bandit" + "value": "NotSet", + "description": "No logs emitted." }, { - "value": "MedianStopping" + "value": "Debug", + "description": "Debug and above log statements logged." }, { - "value": "TruncationSelection" + "value": "Info", + "description": "Info and above log statements logged." + }, + { + "value": "Warning", + "description": "Warning and above log statements logged." + }, + { + "value": "Error", + "description": "Error and above log statements logged." + }, + { + "value": "Critical", + "description": "Only critical statements logged." } ] }, "additionalProperties": false }, - "EndpointAuthKeys": { - "description": "Keys for endpoint authentication.", + "ManagedIdentity": { + "description": "Managed identity configuration.", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IdentityConfiguration" + } + ], "properties": { - "primaryKey": { - "description": "The primary key.", + "clientId": { + "format": "uuid", + "description": "Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.", "type": "string", "x-ms-mutability": [ "create", @@ -7142,8 +11792,18 @@ ], "x-nullable": true }, - "secondaryKey": { - "description": "The secondary key.", + "objectId": { + "format": "uuid", + "description": "Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resourceId": { + "description": "Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.", "type": "string", "x-ms-mutability": [ "create", @@ -7152,233 +11812,227 @@ "x-nullable": true } }, + "x-ms-discriminator-value": "Managed", "additionalProperties": false }, - "EndpointAuthMode": { - "description": "Enum to determine endpoint authentication mode.", + "ManagedOnlineDeployment": { + "description": "Properties specific to a ManagedOnlineDeployment.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OnlineDeployment" + } + ], + "x-ms-discriminator-value": "Managed", + "additionalProperties": false + }, + "MedianStoppingPolicy": { + "description": "Defines an early termination policy based on running averages of the primary metric of all runs", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EarlyTerminationPolicy" + } + ], + "x-ms-discriminator-value": "MedianStopping", + "additionalProperties": false + }, + "MediaType": { + "description": "Media type of data asset.", "enum": [ - "AMLToken", - "Key", - "AADToken" + "Image", + "Text" ], "type": "string", "x-ms-enum": { - "name": "EndpointAuthMode", + "name": "MediaType", "modelAsString": true, "values": [ { - "value": "AMLToken" - }, - { - "value": "Key" + "value": "Image" }, { - "value": "AADToken" + "value": "Text" } ] }, "additionalProperties": false }, - "EndpointAuthToken": { - "description": "Service Token", + "MLAssistConfiguration": { + "description": "Labeling MLAssist configuration definition", + "required": [ + "mlAssist" + ], "type": "object", "properties": { - "accessToken": { - "description": "Access token for endpoint authentication.", + "mlAssist": { + "description": "[Required] Indicates whether MLAssist feature is enabled.", + "$ref": "#/definitions/MLAssistConfigurationType", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "discriminator": "mlAssist" + }, + "MLAssistConfigurationDisabled": { + "description": "Labeling MLAssist configuration definition when MLAssist is disabled", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MLAssistConfiguration" + } + ], + "x-ms-discriminator-value": "Disabled", + "additionalProperties": false + }, + "MLAssistConfigurationEnabled": { + "description": "Labeling MLAssist configuration definition when MLAssist is enabled", + "required": [ + "inferencingComputeBinding", + "trainingComputeBinding" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MLAssistConfiguration" + } + ], + "properties": { + "inferencingComputeBinding": { + "description": "[Required] AML compute binding used in inferencing.", + "pattern": "[a-zA-Z0-9_]", "type": "string", - "x-nullable": true - }, - "expiryTimeUtc": { - "format": "int64", - "description": "Access token expiry time (UTC).", - "default": 0, - "type": "integer" - }, - "refreshAfterTimeUtc": { - "format": "int64", - "description": "Refresh access token after time (UTC).", - "default": 0, - "type": "integer" + "x-ms-mutability": [ + "create", + "read", + "update" + ] }, - "tokenType": { - "description": "Access token type.", + "trainingComputeBinding": { + "description": "[Required] AML compute binding used in training.", + "pattern": "[a-zA-Z0-9_]", "type": "string", - "x-nullable": true + "x-ms-mutability": [ + "create", + "read", + "update" + ] } }, + "x-ms-discriminator-value": "Enabled", "additionalProperties": false }, - "EndpointComputeType": { - "description": "Enum to determine endpoint compute type.", + "MLAssistConfigurationType": { "enum": [ - "Managed", - "Kubernetes", - "AzureMLCompute" + "Enabled", + "Disabled" ], "type": "string", "x-ms-enum": { - "name": "EndpointComputeType", + "name": "MLAssistConfigurationType", "modelAsString": true, "values": [ { - "value": "Managed" - }, - { - "value": "Kubernetes" + "value": "Enabled" }, { - "value": "AzureMLCompute" + "value": "Disabled" } ] }, "additionalProperties": false }, - "EndpointDeploymentPropertiesBase": { - "description": "Base definition for endpoint deployment.", + "MLFlowModelJobInput": { "type": "object", - "properties": { - "codeConfiguration": { - "description": "Code configuration for the endpoint deployment.", - "$ref": "#/definitions/CodeConfiguration", - "x-nullable": true - }, - "description": { - "description": "Description of the endpoint deployment.", - "type": "string", - "x-nullable": true - }, - "environmentId": { - "description": "ARM resource ID or AssetId of the environment specification for the endpoint deployment.", - "type": "string", - "x-nullable": true - }, - "environmentVariables": { - "description": "Environment variables configuration for the deployment.", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true - }, - "x-nullable": true + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" }, - "properties": { - "description": "Property dictionary. Properties can be added, but not removed or altered.", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true - }, - "x-nullable": true + { + "$ref": "#/definitions/JobInput" } - }, + ], + "x-ms-discriminator-value": "mlflow_model", "additionalProperties": false }, - "EndpointPropertiesBase": { - "description": "Inference Endpoint base definition", - "required": [ - "authMode" - ], + "MLFlowModelJobOutput": { "type": "object", - "properties": { - "authMode": { - "description": "[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.", - "$ref": "#/definitions/EndpointAuthMode" - }, - "description": { - "description": "Description of the inference endpoint.", - "type": "string", - "x-nullable": true - }, - "keys": { - "description": "EndpointAuthKeys to set initially on an Endpoint.\r\nThis property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.", - "$ref": "#/definitions/EndpointAuthKeys", - "x-ms-mutability": [ - "create" - ], - "x-ms-secret": true, - "x-nullable": true + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" }, - "properties": { - "description": "Property dictionary. Properties can be added, but not removed or altered.", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "mlflow_model", + "additionalProperties": false + }, + "MLTableData": { + "description": "MLTable data definition", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataVersionBase" + } + ], + "properties": { + "referencedUris": { + "description": "Uris referenced in the MLTable definition (required for lineage)", + "type": "array", + "items": { + "type": "string" }, - "x-nullable": true - }, - "scoringUri": { - "format": "uri", - "description": "Endpoint URI.", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-nullable": true - }, - "swaggerUri": { - "format": "uri", - "description": "Endpoint Swagger URI.", - "type": "string", - "readOnly": true, "x-ms-mutability": [ + "create", "read" ], "x-nullable": true } }, + "x-ms-discriminator-value": "mltable", "additionalProperties": false }, - "EndpointProvisioningState": { - "description": "State of endpoint provisioning.", - "enum": [ - "Creating", - "Deleting", - "Succeeded", - "Failed", - "Updating", - "Canceled" + "MLTableJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } ], - "type": "string", - "x-ms-enum": { - "name": "EndpointProvisioningState", - "modelAsString": true, - "values": [ - { - "value": "Creating" - }, - { - "value": "Deleting" - }, - { - "value": "Succeeded" - }, - { - "value": "Failed" - }, - { - "value": "Updating" - }, - { - "value": "Canceled" - } - ] - }, + "x-ms-discriminator-value": "mltable", "additionalProperties": false }, - "EnvironmentContainer": { - "description": "Container for environment specification versions.", + "MLTableJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "mltable", + "additionalProperties": false + }, + "ModelContainer": { "type": "object", "allOf": [ { "$ref": "#/definitions/AssetContainer" } ], - "x-ms-client-name": "EnvironmentContainerProperties", + "x-ms-client-name": "ModelContainerProperties", "additionalProperties": false }, - "EnvironmentContainerResource": { + "ModelContainerResource": { "description": "Azure Resource Manager resource envelope.", "required": [ "properties" @@ -7392,53 +12046,70 @@ "properties": { "properties": { "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/EnvironmentContainer" + "$ref": "#/definitions/ModelContainer" } }, - "x-ms-client-name": "EnvironmentContainer", + "x-ms-client-name": "ModelContainer", "additionalProperties": false }, - "EnvironmentContainerResourceArmPaginatedResult": { - "description": "A paginated list of EnvironmentContainer entities.", + "ModelContainerResourceArmPaginatedResult": { + "description": "A paginated list of ModelContainer entities.", "type": "object", "properties": { "nextLink": { - "description": "The link to the next page of EnvironmentContainer objects. If null, there are no additional pages.", + "description": "The link to the next page of ModelContainer objects. If null, there are no additional pages.", "type": "string" }, "value": { - "description": "An array of objects of type EnvironmentContainer.", + "description": "An array of objects of type ModelContainer.", "type": "array", "items": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/ModelContainerResource" } } }, "additionalProperties": false }, - "EnvironmentType": { - "description": "Environment type is either user created or curated by Azure ML service", + "ModelSize": { + "description": "Image model size.", "enum": [ - "Curated", - "UserCreated" + "None", + "Small", + "Medium", + "Large", + "ExtraLarge" ], "type": "string", "x-ms-enum": { - "name": "EnvironmentType", + "name": "ModelSize", "modelAsString": true, "values": [ { - "value": "Curated" + "value": "None", + "description": "No value selected." }, { - "value": "UserCreated" + "value": "Small", + "description": "Small size." + }, + { + "value": "Medium", + "description": "Medium size." + }, + { + "value": "Large", + "description": "Large size." + }, + { + "value": "ExtraLarge", + "description": "Extra large size." } ] }, "additionalProperties": false }, - "EnvironmentVersion": { - "description": "Environment version details.", + "ModelVersion": { + "description": "Model asset version details.", "type": "object", "allOf": [ { @@ -7446,61 +12117,35 @@ } ], "properties": { - "build": { - "description": "Configuration settings for Docker build context.", - "$ref": "#/definitions/BuildContext", - "x-ms-mutability": [ - "create", - "read" - ] + "flavors": { + "description": "Mapping of model flavors to their properties.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/FlavorData", + "x-nullable": true + }, + "x-nullable": true }, - "condaFile": { - "description": "Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.\r\n", + "jobName": { + "description": "Name of the training job which produced this model", "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "environmentType": { - "description": "Environment type is either user managed or curated by the Azure ML service\r\n", - "$ref": "#/definitions/EnvironmentType", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "x-nullable": true }, - "image": { - "description": "Name of the image that will be used for the environment.\r\n", + "modelType": { + "description": "The storage format for this entity. Used for NCD.", "type": "string", - "example": "docker.io/tensorflow/serving:latest", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "inferenceConfig": { - "description": "Defines configuration specific to inference.", - "$ref": "#/definitions/InferenceContainerProperties", - "x-ms-mutability": [ - "create", - "read" - ] + "x-nullable": true }, - "osType": { - "description": "The OS type of the environment.", - "default": "Linux", - "$ref": "#/definitions/OperatingSystemType", - "x-ms-mutability": [ - "create", - "read" - ] + "modelUri": { + "description": "The URI path to the model contents.", + "type": "string", + "x-nullable": true } }, - "x-ms-client-name": "EnvironmentVersionProperties", + "x-ms-client-name": "ModelVersionProperties", "additionalProperties": false }, - "EnvironmentVersionResource": { + "ModelVersionResource": { "description": "Azure Resource Manager resource envelope.", "required": [ "properties" @@ -7514,210 +12159,225 @@ "properties": { "properties": { "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/EnvironmentVersion" + "$ref": "#/definitions/ModelVersion" } }, - "x-ms-client-name": "EnvironmentVersion", + "x-ms-client-name": "ModelVersion", "additionalProperties": false }, - "EnvironmentVersionResourceArmPaginatedResult": { - "description": "A paginated list of EnvironmentVersion entities.", + "ModelVersionResourceArmPaginatedResult": { + "description": "A paginated list of ModelVersion entities.", "type": "object", "properties": { "nextLink": { - "description": "The link to the next page of EnvironmentVersion objects. If null, there are no additional pages.", + "description": "The link to the next page of ModelVersion objects. If null, there are no additional pages.", "type": "string" }, "value": { - "description": "An array of objects of type EnvironmentVersion.", + "description": "An array of objects of type ModelVersion.", "type": "array", "items": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/ModelVersionResource" } } }, "additionalProperties": false }, - "FlavorData": { - "type": "object", - "properties": { - "data": { - "description": "Model flavor-specific data.", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true - }, - "x-nullable": true - } - }, - "additionalProperties": false - }, - "Goal": { - "description": "Defines supported metric goals for hyperparameter tuning", - "enum": [ - "Minimize", - "Maximize" - ], - "type": "string", - "x-ms-enum": { - "name": "Goal", - "modelAsString": true, - "values": [ - { - "value": "Minimize" - }, - { - "value": "Maximize" - } - ] - }, - "additionalProperties": false - }, - "GridSamplingAlgorithm": { - "description": "Defines a Sampling Algorithm that exhaustively generates every value combination in the space", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SamplingAlgorithm" - } - ], - "x-ms-discriminator-value": "Grid", - "additionalProperties": false - }, - "IdAssetReference": { - "description": "Reference to an asset via its ARM resource ID.", - "required": [ - "assetId" - ], + "Mpi": { + "description": "MPI distribution configuration.", "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetReferenceBase" + "$ref": "#/definitions/DistributionConfiguration" } ], "properties": { - "assetId": { - "description": "[Required] ARM resource ID of the asset.", - "pattern": "[a-zA-Z0-9_]", - "type": "string" + "processCountPerInstance": { + "format": "int32", + "description": "Number of processes per MPI node.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, - "x-ms-discriminator-value": "Id", + "x-ms-discriminator-value": "Mpi", "additionalProperties": false }, - "IdentityConfiguration": { - "description": "Base definition for identity configuration.", + "NCrossValidations": { + "description": "N-Cross validations value.", "required": [ - "identityType" + "mode" ], "type": "object", "properties": { - "identityType": { - "description": "[Required] Specifies the type of identity framework.", - "$ref": "#/definitions/IdentityConfigurationType", + "mode": { + "description": "[Required] Mode for determining N-Cross validations.", + "$ref": "#/definitions/NCrossValidationsMode", "x-ms-mutability": [ "create", "read" ] } }, - "discriminator": "identityType" + "discriminator": "mode" }, - "IdentityConfigurationType": { - "description": "Enum to determine identity framework.", + "NCrossValidationsMode": { + "description": "Determines how N-Cross validations value is determined.", "enum": [ - "Managed", - "AMLToken", - "UserIdentity" + "Auto", + "Custom" ], "type": "string", "x-ms-enum": { - "name": "IdentityConfigurationType", + "name": "NCrossValidationsMode", "modelAsString": true, "values": [ { - "value": "Managed" - }, - { - "value": "AMLToken" + "value": "Auto", + "description": "Determine N-Cross validations value automatically. Supported only for 'Forecasting' AutoML task." }, { - "value": "UserIdentity" + "value": "Custom", + "description": "Use custom N-Cross validations value." } ] }, "additionalProperties": false }, - "InferenceContainerProperties": { + "NlpVertical": { + "description": "Abstract class for NLP related AutoML tasks.\r\nNLP - Natural Language Processing.", "type": "object", "properties": { - "livenessRoute": { - "description": "The route to check the liveness of the inference server container.", - "$ref": "#/definitions/Route" + "featurizationSettings": { + "description": "Featurization inputs needed for AutoML job.", + "$ref": "#/definitions/NlpVerticalFeaturizationSettings", + "x-nullable": true }, - "readinessRoute": { - "description": "The route to check the readiness of the inference server container.", - "$ref": "#/definitions/Route" + "limitSettings": { + "description": "Execution constraints for AutoMLJob.", + "$ref": "#/definitions/NlpVerticalLimitSettings", + "x-nullable": true }, - "scoringRoute": { - "description": "The port to send the scoring requests to, within the inference server container.", - "$ref": "#/definitions/Route" + "validationData": { + "description": "Validation data inputs.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true } }, "additionalProperties": false }, - "InputDeliveryMode": { - "description": "Enum to determine the input data delivery mode.", + "NlpVerticalFeaturizationSettings": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeaturizationSettings" + } + ], + "additionalProperties": false + }, + "NlpVerticalLimitSettings": { + "description": "Job execution constraints.", + "type": "object", + "properties": { + "maxConcurrentTrials": { + "format": "int32", + "description": "Maximum Concurrent AutoML iterations.", + "default": 1, + "type": "integer" + }, + "maxTrials": { + "format": "int32", + "description": "Number of AutoML iterations.", + "default": 1, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "AutoML job timeout.", + "type": "string" + } + }, + "additionalProperties": false + }, + "NoneDatastoreCredentials": { + "description": "Empty/none datastore credentials.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "x-ms-discriminator-value": "None", + "additionalProperties": false + }, + "ObjectDetectionPrimaryMetrics": { + "description": "Primary metrics for Image ObjectDetection task.", "enum": [ - "ReadOnlyMount", - "ReadWriteMount", - "Download", - "Direct", - "EvalMount", - "EvalDownload" + "MeanAveragePrecision" ], "type": "string", "x-ms-enum": { - "name": "InputDeliveryMode", + "name": "ObjectDetectionPrimaryMetrics", "modelAsString": true, "values": [ { - "value": "ReadOnlyMount" - }, - { - "value": "ReadWriteMount" - }, - { - "value": "Download" - }, - { - "value": "Direct" - }, - { - "value": "EvalMount" - }, - { - "value": "EvalDownload" + "value": "MeanAveragePrecision", + "description": "Mean Average Precision (MAP) is the average of AP (Average Precision).\nAP is calculated for each class and averaged to get the MAP." } ] }, "additionalProperties": false }, - "JobBase": { - "description": "Base definition for a job.", + "Objective": { + "description": "Optimization objective.", "required": [ - "jobType" + "goal", + "primaryMetric" + ], + "type": "object", + "properties": { + "goal": { + "description": "[Required] Defines supported metric goals for hyperparameter tuning", + "$ref": "#/definitions/Goal" + }, + "primaryMetric": { + "description": "[Required] Name of the metric to optimize.", + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "additionalProperties": false + }, + "OnlineDeployment": { + "required": [ + "endpointComputeType" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/ResourceBase" + "$ref": "#/definitions/EndpointDeploymentPropertiesBase" } ], "properties": { - "computeId": { - "description": "ARM resource ID of the compute resource.", + "appInsightsEnabled": { + "description": "If true, enables Application Insights logging.", + "default": false, + "type": "boolean" + }, + "egressPublicNetworkAccess": { + "description": "If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.", + "default": "Enabled", + "$ref": "#/definitions/EgressPublicNetworkAccessType" + }, + "endpointComputeType": { + "description": "[Required] The compute type of the endpoint.", + "$ref": "#/definitions/EndpointComputeType" + }, + "instanceType": { + "description": "Compute instance type.", "type": "string", "x-ms-mutability": [ "create", @@ -7725,565 +12385,518 @@ ], "x-nullable": true }, - "displayName": { - "description": "Display name of job.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], + "livenessProbe": { + "description": "Liveness probe monitors the health of the container regularly.", + "$ref": "#/definitions/ProbeSettings", "x-nullable": true }, - "experimentName": { - "description": "The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment.", - "default": "Default", + "model": { + "description": "The URI path to the model.", "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "identity": { - "description": "Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null.\r\nDefaults to AmlToken if null.", - "$ref": "#/definitions/IdentityConfiguration", - "x-ms-mutability": [ - "create", - "read" - ], "x-nullable": true }, - "isArchived": { - "description": "Is the asset archived?", - "default": false, - "type": "boolean", - "x-ms-mutability": [ - "create", - "read", - "update" - ] + "modelMountPath": { + "description": "The path to mount the model in custom container.", + "type": "string", + "x-nullable": true }, - "jobType": { - "description": "[Required] Specifies the type of job.", - "$ref": "#/definitions/JobType", + "provisioningState": { + "description": "Provisioning state for the endpoint deployment.", + "$ref": "#/definitions/DeploymentProvisioningState", + "readOnly": true, "x-ms-mutability": [ - "create", "read" ] }, - "services": { - "description": "List of JobEndpoints.\r\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/JobService", - "x-nullable": true - }, + "readinessProbe": { + "description": "Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.", + "$ref": "#/definitions/ProbeSettings", "x-nullable": true }, - "status": { - "description": "Status of the job.", - "$ref": "#/definitions/JobStatus", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "requestSettings": { + "description": "Request settings for the deployment.", + "$ref": "#/definitions/OnlineRequestSettings", + "x-nullable": true + }, + "scaleSettings": { + "description": "Scale settings for the deployment.\r\nIf it is null or not provided,\r\nit defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment\r\nand to DefaultScaleSettings for ManagedOnlineDeployment.", + "$ref": "#/definitions/OnlineScaleSettings", + "x-nullable": true } }, - "discriminator": "jobType", - "x-ms-client-name": "JobBaseProperties" + "discriminator": "endpointComputeType", + "x-ms-client-name": "OnlineDeploymentProperties" }, - "JobBaseResource": { - "description": "Azure Resource Manager resource envelope.", + "OnlineDeploymentTrackedResource": { "required": [ + "location", "properties" ], "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" } ], "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, "properties": { "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/JobBase" + "$ref": "#/definitions/OnlineDeployment" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" } }, - "x-ms-client-name": "JobBase", + "x-ms-client-name": "OnlineDeployment", "additionalProperties": false }, - "JobBaseResourceArmPaginatedResult": { - "description": "A paginated list of JobBase entities.", + "OnlineDeploymentTrackedResourceArmPaginatedResult": { + "description": "A paginated list of OnlineDeployment entities.", "type": "object", "properties": { "nextLink": { - "description": "The link to the next page of JobBase objects. If null, there are no additional pages.", + "description": "The link to the next page of OnlineDeployment objects. If null, there are no additional pages.", "type": "string" }, "value": { - "description": "An array of objects of type JobBase.", + "description": "An array of objects of type OnlineDeployment.", "type": "array", "items": { - "$ref": "#/definitions/JobBaseResource" + "$ref": "#/definitions/OnlineDeploymentTrackedResource" } } }, "additionalProperties": false }, - "JobInput": { - "description": "Command job definition.", - "required": [ - "jobInputType" - ], + "OnlineEndpoint": { + "description": "Online endpoint configuration", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointPropertiesBase" + } + ], "properties": { - "description": { - "description": "Description for the input.", + "compute": { + "description": "ARM resource ID of the compute if it exists.\r\noptional", "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], "x-nullable": true }, - "jobInputType": { - "description": "[Required] Specifies the type of job.", - "$ref": "#/definitions/JobInputType", + "mirrorTraffic": { + "description": "Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the endpoint.", + "$ref": "#/definitions/EndpointProvisioningState", + "readOnly": true, "x-ms-mutability": [ - "create", "read" ] - } - }, - "discriminator": "jobInputType" - }, - "JobInputType": { - "description": "Enum to determine the Job Input Type.", - "enum": [ - "literal", - "uri_file", - "uri_folder", - "mltable", - "custom_model", - "mlflow_model", - "triton_model" - ], - "type": "string", - "x-ms-enum": { - "name": "JobInputType", - "modelAsString": true, - "values": [ - { - "value": "literal" - }, - { - "value": "uri_file" - }, - { - "value": "uri_folder" - }, - { - "value": "mltable" - }, - { - "value": "custom_model" - }, - { - "value": "mlflow_model" + }, + "publicNetworkAccess": { + "description": "Set to \"Enabled\" for endpoints that should allow public access when Private Link is enabled.", + "default": "Enabled", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "traffic": { + "description": "Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" }, - { - "value": "triton_model" - } - ] + "x-nullable": true + } }, + "x-ms-client-name": "OnlineEndpointProperties", "additionalProperties": false }, - "JobLimits": { + "OnlineEndpointTrackedResource": { "required": [ - "jobLimitsType" + "location", + "properties" ], "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], "properties": { - "jobLimitsType": { - "description": "[Required] JobLimit type.", - "$ref": "#/definitions/JobLimitsType" + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, - "timeout": { - "format": "duration", - "description": "The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.", - "type": "string", - "x-nullable": true + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/OnlineEndpoint" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" } }, - "discriminator": "jobLimitsType" - }, - "JobLimitsType": { - "enum": [ - "Command", - "Sweep" - ], - "type": "string", - "x-ms-enum": { - "name": "JobLimitsType", - "modelAsString": true, - "values": [ - { - "value": "Command" - }, - { - "value": "Sweep" - } - ] - }, + "x-ms-client-name": "OnlineEndpoint", "additionalProperties": false }, - "JobOutput": { - "description": "Job output definition container information on where to find job output/logs.", - "required": [ - "jobOutputType" - ], + "OnlineEndpointTrackedResourceArmPaginatedResult": { + "description": "A paginated list of OnlineEndpoint entities.", "type": "object", "properties": { - "description": { - "description": "Description for the output.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true + "nextLink": { + "description": "The link to the next page of OnlineEndpoint objects. If null, there are no additional pages.", + "type": "string" }, - "jobOutputType": { - "description": "[Required] Specifies the type of job.", - "$ref": "#/definitions/JobOutputType", - "x-ms-mutability": [ - "create", - "read" - ] - } - }, - "discriminator": "jobOutputType" - }, - "JobOutputType": { - "description": "Enum to determine the Job Output Type.", - "enum": [ - "uri_file", - "uri_folder", - "mltable", - "custom_model", - "mlflow_model", - "triton_model" - ], - "type": "string", - "x-ms-enum": { - "name": "JobOutputType", - "modelAsString": true, - "values": [ - { - "value": "uri_file" - }, - { - "value": "uri_folder" - }, - { - "value": "mltable" - }, - { - "value": "custom_model" - }, - { - "value": "mlflow_model" - }, - { - "value": "triton_model" + "value": { + "description": "An array of objects of type OnlineEndpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" } - ] + } }, "additionalProperties": false }, - "JobService": { - "description": "Job endpoint definition", + "OnlineRequestSettings": { + "description": "Online deployment scoring requests configuration.", "type": "object", "properties": { - "endpoint": { - "description": "Url for endpoint.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "errorMessage": { - "description": "Any error in the service.", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-nullable": true - }, - "jobServiceType": { - "description": "Endpoint type.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "port": { + "maxConcurrentRequestsPerInstance": { "format": "int32", - "description": "Port for endpoint.", - "type": "integer", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true + "description": "The number of maximum concurrent requests per node allowed per deployment. Defaults to 1.", + "default": 1, + "type": "integer" }, - "properties": { - "description": "Additional properties to set on the endpoint.", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true - }, - "x-nullable": true + "maxQueueWait": { + "format": "duration", + "description": "The maximum amount of time a request will stay in the queue in ISO 8601 format.\r\nDefaults to 500ms.", + "default": "PT0.5S", + "type": "string" }, - "status": { - "description": "Status of endpoint.", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-nullable": true + "requestTimeout": { + "format": "duration", + "description": "The scoring timeout in ISO 8601 format.\r\nDefaults to 5000ms.", + "default": "PT5S", + "type": "string" } }, "additionalProperties": false }, - "JobStatus": { - "description": "The status of a job.", + "OnlineScaleSettings": { + "description": "Online deployment scaling configuration.", + "required": [ + "scaleType" + ], + "type": "object", + "properties": { + "scaleType": { + "description": "[Required] Type of deployment scaling algorithm", + "$ref": "#/definitions/ScaleType" + } + }, + "discriminator": "scaleType" + }, + "OperatingSystemType": { + "description": "The type of operating system.", "enum": [ - "NotStarted", - "Starting", - "Provisioning", - "Preparing", - "Queued", - "Running", - "Finalizing", - "CancelRequested", - "Completed", - "Failed", - "Canceled", - "NotResponding", - "Paused", - "Unknown" + "Linux", + "Windows" ], "type": "string", "x-ms-enum": { - "name": "JobStatus", + "name": "OperatingSystemType", "modelAsString": true, "values": [ { - "value": "NotStarted", - "description": "Run hasn't started yet." - }, - { - "value": "Starting", - "description": "Run has started. The user has a run ID." - }, - { - "value": "Provisioning", - "description": "(Not used currently) It will be used if ES is creating the compute target." - }, - { - "value": "Preparing", - "description": "The run environment is being prepared." - }, - { - "value": "Queued", - "description": "The job is queued in the compute target. For example, in BatchAI the job is in queued state, while waiting for all required nodes to be ready." - }, - { - "value": "Running", - "description": "The job started to run in the compute target." - }, - { - "value": "Finalizing", - "description": "Job is completed in the target. It is in output collection state now." - }, - { - "value": "CancelRequested", - "description": "Cancellation has been requested for the job." - }, - { - "value": "Completed", - "description": "Job completed successfully. This reflects that both the job itself and output collection states completed successfully" - }, - { - "value": "Failed", - "description": "Job failed." - }, - { - "value": "Canceled", - "description": "Following cancellation request, the job is now successfully canceled." - }, - { - "value": "NotResponding", - "description": "When heartbeat is enabled, if the run isn't updating any information to RunHistory then the run goes to NotResponding state.\nNotResponding is the only state that is exempt from strict transition orders. A run can go from NotResponding to any of the previous states." - }, - { - "value": "Paused", - "description": "The job is paused by users. Some adjustment to labeling jobs can be made only in paused state." + "value": "Linux" }, { - "value": "Unknown", - "description": "Default job status if not mapped to all other statuses" + "value": "Windows" } ] }, "additionalProperties": false }, - "JobType": { - "description": "Enum to determine the type of job.", + "OrderString": { "enum": [ - "Command", - "Sweep", - "Pipeline" + "CreatedAtDesc", + "CreatedAtAsc", + "UpdatedAtDesc", + "UpdatedAtAsc" ], "type": "string", "x-ms-enum": { - "name": "JobType", + "name": "OrderString", "modelAsString": true, "values": [ { - "value": "Command" + "value": "CreatedAtDesc" }, { - "value": "Sweep" + "value": "CreatedAtAsc" }, { - "value": "Pipeline" + "value": "UpdatedAtDesc" + }, + { + "value": "UpdatedAtAsc" } ] }, "additionalProperties": false }, - "KeyType": { + "OutputDeliveryMode": { + "description": "Output data delivery mode enums.", "enum": [ - "Primary", - "Secondary" + "ReadWriteMount", + "Upload" ], "type": "string", "x-ms-enum": { - "name": "KeyType", + "name": "OutputDeliveryMode", "modelAsString": true, "values": [ { - "value": "Primary" + "value": "ReadWriteMount" }, { - "value": "Secondary" + "value": "Upload" } ] }, "additionalProperties": false }, - "KubernetesOnlineDeployment": { - "description": "Properties specific to a KubernetesOnlineDeployment.", + "OutputPathAssetReference": { + "description": "Reference to an asset via its path in a job output.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetReferenceBase" + } + ], + "properties": { + "jobId": { + "description": "ARM resource ID of the job.", + "type": "string", + "x-nullable": true + }, + "path": { + "description": "The path of the file/directory in the job output.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "OutputPath", + "additionalProperties": false + }, + "PartialBatchDeployment": { + "description": "Mutable batch inference settings per deployment.", + "type": "object", + "properties": { + "description": { + "description": "Description of the endpoint deployment.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties": { + "description": "Strictly used in update requests.", + "type": "object", + "properties": { + "properties": { + "description": "Additional attributes of the entity.", + "$ref": "#/definitions/PartialBatchDeployment" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + } + }, + "additionalProperties": false + }, + "PartialManagedServiceIdentity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "type": "object", + "properties": { + "type": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentityType" + }, + "userAssignedIdentities": { + "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/PartialUserAssignedIdentity" + } + } + }, + "additionalProperties": false + }, + "PartialMinimalTrackedResource": { + "description": "Strictly used in update requests.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + } + }, + "additionalProperties": false + }, + "PartialMinimalTrackedResourceWithIdentity": { + "description": "Strictly used in update requests.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PartialMinimalTrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "#/definitions/PartialManagedServiceIdentity" + } + }, + "additionalProperties": false + }, + "PartialMinimalTrackedResourceWithSku": { + "description": "Strictly used in update requests.", "type": "object", "allOf": [ { - "$ref": "#/definitions/OnlineDeployment" + "$ref": "#/definitions/PartialMinimalTrackedResource" } ], "properties": { - "containerResourceRequirements": { - "description": "The resource requirements for the container (cpu and memory).", - "$ref": "#/definitions/ContainerResourceRequirements", - "x-nullable": true + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "#/definitions/PartialSku" } }, - "x-ms-discriminator-value": "Kubernetes", - "additionalProperties": false - }, - "ListViewType": { - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "type": "string", - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - }, "additionalProperties": false }, - "LiteralJobInput": { - "description": "Literal input type.", - "required": [ - "value" - ], + "PartialSku": { + "description": "Common SKU definition.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/JobInput" - } - ], "properties": { - "value": { - "description": "[Required] Literal value for the input.", - "pattern": "[a-zA-Z0-9_]", + "capacity": { + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.", + "type": "integer" + }, + "family": { + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", + "type": "string" + }, + "name": { + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code.", + "type": "string" + }, + "size": { + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.", "type": "string" + }, + "tier": { + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" } }, - "x-ms-discriminator-value": "literal", "additionalProperties": false }, - "ManagedIdentity": { - "description": "Managed identity configuration.", + "PartialUserAssignedIdentity": { + "type": "object", + "additionalProperties": false + }, + "PipelineJob": { + "description": "Pipeline Job definition: defines generic to MFE attributes.", "type": "object", "allOf": [ { - "$ref": "#/definitions/IdentityConfiguration" + "$ref": "#/definitions/JobBase" } ], "properties": { - "clientId": { - "format": "uuid", - "description": "Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.", - "type": "string", + "inputs": { + "description": "Inputs for the pipeline job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, "x-ms-mutability": [ "create", "read" ], "x-nullable": true }, - "objectId": { - "format": "uuid", - "description": "Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.", - "type": "string", + "jobs": { + "description": "Jobs construct the Pipeline Job.", + "type": "object", + "additionalProperties": { + "type": "object", + "x-nullable": true + }, "x-ms-mutability": [ "create", "read" ], "x-nullable": true }, - "resourceId": { - "description": "Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.", + "outputs": { + "description": "Outputs for the pipeline job", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "settings": { + "description": "Pipeline settings, for things like ContinueRunOnStepFailure etc.", + "type": "object", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "sourceJobId": { + "description": "ARM resource ID of source job.", "type": "string", "x-ms-mutability": [ "create", @@ -8292,307 +12905,518 @@ "x-nullable": true } }, - "x-ms-discriminator-value": "Managed", - "additionalProperties": false - }, - "ManagedOnlineDeployment": { - "description": "Properties specific to a ManagedOnlineDeployment.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/OnlineDeployment" - } - ], - "x-ms-discriminator-value": "Managed", - "additionalProperties": false - }, - "MedianStoppingPolicy": { - "description": "Defines an early termination policy based on running averages of the primary metric of all runs", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/EarlyTerminationPolicy" - } - ], - "x-ms-discriminator-value": "MedianStopping", + "x-ms-discriminator-value": "Pipeline", "additionalProperties": false }, - "MLFlowModelJobInput": { + "ProbeSettings": { + "description": "Deployment container liveness/readiness probe configuration.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AssetJobInput" + "properties": { + "failureThreshold": { + "format": "int32", + "description": "The number of failures to allow before returning an unhealthy status.", + "default": 30, + "type": "integer" }, - { - "$ref": "#/definitions/JobInput" - } - ], - "x-ms-discriminator-value": "mlflow_model", - "additionalProperties": false - }, - "MLFlowModelJobOutput": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AssetJobOutput" + "initialDelay": { + "format": "duration", + "description": "The delay before the first probe in ISO 8601 format.", + "type": "string", + "x-nullable": true }, - { - "$ref": "#/definitions/JobOutput" + "period": { + "format": "duration", + "description": "The length of time between probes in ISO 8601 format.", + "default": "PT10S", + "type": "string" + }, + "successThreshold": { + "format": "int32", + "description": "The number of successful probes before returning a healthy status.", + "default": 1, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "The probe timeout in ISO 8601 format.", + "default": "PT2S", + "type": "string" } - ], - "x-ms-discriminator-value": "mlflow_model", + }, "additionalProperties": false }, - "MLTableData": { - "description": "MLTable data definition", + "ProgressMetrics": { + "description": "Progress metrics definition", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DataVersionBase" - } - ], "properties": { - "referencedUris": { - "description": "Uris referenced in the MLTable definition (required for lineage)", - "type": "array", - "items": { - "type": "string" - }, + "completedDatapointCount": { + "format": "int64", + "description": "The completed datapoint count.", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "incrementalDataLastRefreshDateTime": { + "format": "date-time", + "description": "The time of last successful incremental data refresh in UTC.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "skippedDatapointCount": { + "format": "int64", + "description": "The skipped datapoint count.", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "totalDatapointCount": { + "format": "int64", + "description": "The total datapoint count.", + "type": "integer", + "readOnly": true, "x-ms-mutability": [ - "create", "read" ], "x-nullable": true } }, - "x-ms-discriminator-value": "mltable", "additionalProperties": false }, - "MLTableJobInput": { + "PublicNetworkAccessType": { + "description": "Enum to determine whether PublicNetworkAccess is Enabled or Disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "PyTorch": { + "description": "PyTorch distribution configuration.", "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetJobInput" - }, - { - "$ref": "#/definitions/JobInput" + "$ref": "#/definitions/DistributionConfiguration" } ], - "x-ms-discriminator-value": "mltable", + "properties": { + "processCountPerInstance": { + "format": "int32", + "description": "Number of processes per node.", + "type": "integer", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "PyTorch", "additionalProperties": false }, - "MLTableJobOutput": { + "RandomSamplingAlgorithm": { + "description": "Defines a Sampling Algorithm that generates values randomly", "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetJobOutput" - }, - { - "$ref": "#/definitions/JobOutput" + "$ref": "#/definitions/SamplingAlgorithm" } ], - "x-ms-discriminator-value": "mltable", + "properties": { + "rule": { + "description": "The specific type of random algorithm", + "default": "Random", + "$ref": "#/definitions/RandomSamplingAlgorithmRule" + }, + "seed": { + "format": "int32", + "description": "An optional integer to use as the seed for random number generation", + "type": "integer", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Random", "additionalProperties": false }, - "ModelContainer": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AssetContainer" - } + "RandomSamplingAlgorithmRule": { + "description": "The specific type of random algorithm", + "enum": [ + "Random", + "Sobol" ], - "x-ms-client-name": "ModelContainerProperties", + "type": "string", + "x-ms-enum": { + "name": "RandomSamplingAlgorithmRule", + "modelAsString": true, + "values": [ + { + "value": "Random" + }, + { + "value": "Sobol" + } + ] + }, "additionalProperties": false }, - "ModelContainerResource": { - "description": "Azure Resource Manager resource envelope.", - "required": [ - "properties" - ], - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } + "RecurrenceFrequency": { + "description": "Enum to describe the frequency of a recurrence schedule", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" ], - "properties": { - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/ModelContainer" - } + "type": "string", + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": true, + "values": [ + { + "value": "Minute", + "description": "Minute frequency" + }, + { + "value": "Hour", + "description": "Hour frequency" + }, + { + "value": "Day", + "description": "Day frequency" + }, + { + "value": "Week", + "description": "Week frequency" + }, + { + "value": "Month", + "description": "Month frequency" + } + ] }, - "x-ms-client-name": "ModelContainer", "additionalProperties": false }, - "ModelContainerResourceArmPaginatedResult": { - "description": "A paginated list of ModelContainer entities.", + "RecurrenceSchedule": { + "required": [ + "hours", + "minutes" + ], "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of ModelContainer objects. If null, there are no additional pages.", - "type": "string" + "hours": { + "description": "[Required] List of hours for the schedule.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } }, - "value": { - "description": "An array of objects of type ModelContainer.", + "minutes": { + "description": "[Required] List of minutes for the schedule.", "type": "array", "items": { - "$ref": "#/definitions/ModelContainerResource" + "format": "int32", + "type": "integer" } + }, + "weekDays": { + "description": "List of days for the schedule.", + "type": "array", + "items": { + "$ref": "#/definitions/WeekDay" + }, + "x-nullable": true } }, "additionalProperties": false }, - "ModelVersion": { - "description": "Model asset version details.", + "RecurrenceTrigger": { + "required": [ + "frequency", + "interval", + "schedule" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetBase" + "$ref": "#/definitions/TriggerBase" } ], "properties": { - "flavors": { - "description": "Mapping of model flavors to their properties.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/FlavorData", - "x-nullable": true - }, - "x-nullable": true + "frequency": { + "description": "[Required] The frequency to trigger schedule.", + "$ref": "#/definitions/RecurrenceFrequency" }, - "jobName": { - "description": "Name of the training job which produced this model", - "type": "string", - "x-nullable": true + "interval": { + "format": "int32", + "description": "[Required] Specifies schedule interval in conjunction with frequency", + "type": "integer" }, - "modelType": { - "description": "The storage format for this entity. Used for NCD.", - "type": "string", - "x-nullable": true + "schedule": { + "description": "[Required] The recurrence schedule.", + "$ref": "#/definitions/RecurrenceSchedule" + } + }, + "x-ms-discriminator-value": "Recurrence", + "additionalProperties": false + }, + "ReferenceType": { + "description": "Enum to determine which reference method to use for an asset.", + "enum": [ + "Id", + "DataPath", + "OutputPath" + ], + "type": "string", + "x-ms-enum": { + "name": "ReferenceType", + "modelAsString": true, + "values": [ + { + "value": "Id" + }, + { + "value": "DataPath" + }, + { + "value": "OutputPath" + } + ] + }, + "additionalProperties": false + }, + "RegenerateEndpointKeysRequest": { + "required": [ + "keyType" + ], + "type": "object", + "properties": { + "keyType": { + "description": "[Required] Specification for which type of key to generate. Primary or Secondary.", + "$ref": "#/definitions/KeyType", + "example": "Primary" }, - "modelUri": { - "description": "The URI path to the model contents.", + "keyValue": { + "description": "The value the key is set to.", "type": "string", "x-nullable": true } }, - "x-ms-client-name": "ModelVersionProperties", "additionalProperties": false }, - "ModelVersionResource": { - "description": "Azure Resource Manager resource envelope.", - "required": [ - "properties" - ], + "Regression": { + "description": "Regression task in AutoML Table vertical.", "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + "$ref": "#/definitions/TableVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" } ], "properties": { - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/ModelVersion" + "primaryMetric": { + "description": "Primary metric for regression task.", + "default": "NormalizedRootMeanSquaredError", + "$ref": "#/definitions/RegressionPrimaryMetrics" + }, + "trainingSettings": { + "description": "Inputs for training phase for an AutoML Job.", + "$ref": "#/definitions/RegressionTrainingSettings", + "x-nullable": true } }, - "x-ms-client-name": "ModelVersion", + "x-ms-discriminator-value": "Regression", "additionalProperties": false }, - "ModelVersionResourceArmPaginatedResult": { - "description": "A paginated list of ModelVersion entities.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link to the next page of ModelVersion objects. If null, there are no additional pages.", - "type": "string" - }, - "value": { - "description": "An array of objects of type ModelVersion.", - "type": "array", - "items": { - "$ref": "#/definitions/ModelVersionResource" + "RegressionModels": { + "description": "Enum for all Regression models supported by AutoML.", + "enum": [ + "ElasticNet", + "GradientBoosting", + "DecisionTree", + "KNN", + "LassoLars", + "SGD", + "RandomForest", + "ExtremeRandomTrees", + "LightGBM", + "XGBoostRegressor" + ], + "type": "string", + "x-ms-enum": { + "name": "RegressionModels", + "modelAsString": true, + "values": [ + { + "value": "ElasticNet", + "description": "Elastic net is a popular type of regularized linear regression that combines two popular penalties, specifically the L1 and L2 penalty functions." + }, + { + "value": "GradientBoosting", + "description": "The technique of transiting week learners into a strong learner is called Boosting. The gradient boosting algorithm process works on this theory of execution." + }, + { + "value": "DecisionTree", + "description": "Decision Trees are a non-parametric supervised learning method used for both classification and regression tasks.\nThe goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from the data features." + }, + { + "value": "KNN", + "description": "K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints\nwhich further means that the new data point will be assigned a value based on how closely it matches the points in the training set." + }, + { + "value": "LassoLars", + "description": "Lasso model fit with Least Angle Regression a.k.a. Lars. It is a Linear Model trained with an L1 prior as regularizer." + }, + { + "value": "SGD", + "description": "SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications\nto find the model parameters that correspond to the best fit between predicted and actual outputs.\nIt's an inexact but powerful technique." + }, + { + "value": "RandomForest", + "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the “bagging” method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." + }, + { + "value": "ExtremeRandomTrees", + "description": "Extreme Trees is an ensemble machine learning algorithm that combines the predictions from many decision trees. It is related to the widely used random forest algorithm." + }, + { + "value": "LightGBM", + "description": "LightGBM is a gradient boosting framework that uses tree based learning algorithms." + }, + { + "value": "XGBoostRegressor", + "description": "XGBoostRegressor: Extreme Gradient Boosting Regressor is a supervised machine learning model using ensemble of base learners." + } + ] + }, + "additionalProperties": false + }, + "RegressionPrimaryMetrics": { + "description": "Primary metrics for Regression task.", + "enum": [ + "SpearmanCorrelation", + "NormalizedRootMeanSquaredError", + "R2Score", + "NormalizedMeanAbsoluteError" + ], + "type": "string", + "x-ms-enum": { + "name": "RegressionPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "SpearmanCorrelation", + "description": "The Spearman's rank coefficient of correlation is a nonparametric measure of rank correlation." + }, + { + "value": "NormalizedRootMeanSquaredError", + "description": "The Normalized Root Mean Squared Error (NRMSE) the RMSE facilitates the comparison between models with different scales." + }, + { + "value": "R2Score", + "description": "The R2 score is one of the performance evaluation measures for forecasting-based machine learning models." + }, + { + "value": "NormalizedMeanAbsoluteError", + "description": "The Normalized Mean Absolute Error (NMAE) is a validation metric to compare the Mean Absolute Error (MAE) of (time) series with different scales." } - } + ] }, "additionalProperties": false }, - "Mpi": { - "description": "MPI distribution configuration.", + "RegressionTrainingSettings": { + "description": "Regression Training related configuration.", "type": "object", "allOf": [ { - "$ref": "#/definitions/DistributionConfiguration" + "$ref": "#/definitions/TrainingSettings" } ], "properties": { - "processCountPerInstance": { - "format": "int32", - "description": "Number of processes per MPI node.", - "type": "integer", - "x-ms-mutability": [ - "create", - "read" - ], + "allowedTrainingAlgorithms": { + "description": "Allowed models for regression task.", + "type": "array", + "items": { + "$ref": "#/definitions/RegressionModels" + }, + "x-nullable": true + }, + "blockedTrainingAlgorithms": { + "description": "Blocked models for regression task.", + "type": "array", + "items": { + "$ref": "#/definitions/RegressionModels" + }, "x-nullable": true } }, - "x-ms-discriminator-value": "Mpi", - "additionalProperties": false - }, - "NoneDatastoreCredentials": { - "description": "Empty/none datastore credentials.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatastoreCredentials" - } - ], - "x-ms-discriminator-value": "None", "additionalProperties": false }, - "Objective": { - "description": "Optimization objective.", - "required": [ - "goal", - "primaryMetric" - ], + "ResourceBase": { "type": "object", "properties": { - "goal": { - "description": "[Required] Defines supported metric goals for hyperparameter tuning", - "$ref": "#/definitions/Goal" + "description": { + "description": "The asset description text.", + "type": "string", + "x-nullable": true }, - "primaryMetric": { - "description": "[Required] Name of the metric to optimize.", - "pattern": "[a-zA-Z0-9_]", - "type": "string" + "properties": { + "description": "The asset property dictionary.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "tags": { + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true } }, "additionalProperties": false }, - "OnlineDeployment": { - "required": [ - "endpointComputeType" - ], + "ResourceConfiguration": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/EndpointDeploymentPropertiesBase" - } - ], "properties": { - "appInsightsEnabled": { - "description": "If true, enables Application Insights logging.", - "default": false, - "type": "boolean" - }, - "endpointComputeType": { - "description": "[Required] The compute type of the endpoint.", - "$ref": "#/definitions/EndpointComputeType" + "instanceCount": { + "format": "int32", + "description": "Optional number of instances or nodes used by the compute target.", + "default": 1, + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] }, "instanceType": { - "description": "Compute instance type.", + "description": "Optional type of VM used as supported by the compute target.", "type": "string", "x-ms-mutability": [ "create", @@ -8600,707 +13424,760 @@ ], "x-nullable": true }, - "livenessProbe": { - "description": "Liveness probe monitors the health of the container regularly.", - "$ref": "#/definitions/ProbeSettings", - "x-nullable": true - }, - "model": { - "description": "The URI path to the model.", - "type": "string", - "x-nullable": true - }, - "modelMountPath": { - "description": "The path to mount the model in custom container.", - "type": "string", - "x-nullable": true - }, - "provisioningState": { - "description": "Provisioning state for the endpoint deployment.", - "$ref": "#/definitions/DeploymentProvisioningState", - "readOnly": true, + "properties": { + "description": "Additional properties bag.", + "type": "object", + "additionalProperties": { + "type": "object", + "x-nullable": true + }, "x-ms-mutability": [ + "create", "read" - ] - }, - "readinessProbe": { - "description": "Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.", - "$ref": "#/definitions/ProbeSettings", - "x-nullable": true - }, - "requestSettings": { - "description": "Request settings for the deployment.", - "$ref": "#/definitions/OnlineRequestSettings", - "x-nullable": true - }, - "scaleSettings": { - "description": "Scale settings for the deployment.\r\nIf it is null or not provided,\r\nit defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment\r\nand to DefaultScaleSettings for ManagedOnlineDeployment.", - "$ref": "#/definitions/OnlineScaleSettings", + ], "x-nullable": true } }, - "discriminator": "endpointComputeType", - "x-ms-client-name": "OnlineDeploymentProperties" + "additionalProperties": false }, - "OnlineDeploymentTrackedResource": { + "Route": { "required": [ - "location", - "properties" + "path", + "port" ], "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], "properties": { - "identity": { - "description": "Managed service identity (system assigned and/or user assigned identities)", - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "kind": { - "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "path": { + "description": "[Required] The path for the route.", + "pattern": "[a-zA-Z0-9_]", "type": "string" }, - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/OnlineDeployment" - }, - "sku": { - "description": "Sku details required for ARM contract for Autoscaling.", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + "port": { + "format": "int32", + "description": "[Required] The port for the route.", + "type": "integer" } }, - "x-ms-client-name": "OnlineDeployment", "additionalProperties": false }, - "OnlineDeploymentTrackedResourceArmPaginatedResult": { - "description": "A paginated list of OnlineDeployment entities.", + "SamplingAlgorithm": { + "description": "The Sampling Algorithm used to generate hyperparameter values, along with properties to\r\nconfigure the algorithm", + "required": [ + "samplingAlgorithmType" + ], "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of OnlineDeployment objects. If null, there are no additional pages.", - "type": "string" - }, - "value": { - "description": "An array of objects of type OnlineDeployment.", - "type": "array", - "items": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" - } + "samplingAlgorithmType": { + "description": "[Required] The algorithm used for generating hyperparameter values, along with configuration properties", + "$ref": "#/definitions/SamplingAlgorithmType" } }, + "discriminator": "samplingAlgorithmType" + }, + "SamplingAlgorithmType": { + "enum": [ + "Grid", + "Random", + "Bayesian" + ], + "type": "string", + "x-ms-enum": { + "name": "SamplingAlgorithmType", + "modelAsString": true, + "values": [ + { + "value": "Grid" + }, + { + "value": "Random" + }, + { + "value": "Bayesian" + } + ] + }, "additionalProperties": false }, - "OnlineEndpoint": { - "description": "Online endpoint configuration", + "SasDatastoreCredentials": { + "description": "SAS datastore credentials configuration.", + "required": [ + "secrets" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/EndpointPropertiesBase" + "$ref": "#/definitions/DatastoreCredentials" } ], "properties": { - "compute": { - "description": "ARM resource ID of the compute if it exists.\r\noptional", - "type": "string", - "x-nullable": true - }, - "provisioningState": { - "description": "Provisioning state for the endpoint.", - "$ref": "#/definitions/EndpointProvisioningState", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "traffic": { - "description": "Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.", - "type": "object", - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "x-nullable": true + "secrets": { + "description": "[Required] Storage container secrets.", + "$ref": "#/definitions/SasDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true } }, - "x-ms-client-name": "OnlineEndpointProperties", + "x-ms-discriminator-value": "Sas", "additionalProperties": false }, - "OnlineEndpointTrackedResource": { - "required": [ - "location", - "properties" - ], + "SasDatastoreSecrets": { + "description": "Datastore SAS secrets.", "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "#/definitions/DatastoreSecrets" } ], "properties": { - "identity": { - "description": "Managed service identity (system assigned and/or user assigned identities)", - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "kind": { - "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", - "type": "string" - }, - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/OnlineEndpoint" - }, - "sku": { - "description": "Sku details required for ARM contract for Autoscaling.", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + "sasToken": { + "description": "Storage container SAS token.", + "type": "string", + "x-nullable": true } }, - "x-ms-client-name": "OnlineEndpoint", + "x-ms-discriminator-value": "Sas", "additionalProperties": false }, - "OnlineEndpointTrackedResourceArmPaginatedResult": { - "description": "A paginated list of OnlineEndpoint entities.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link to the next page of OnlineEndpoint objects. If null, there are no additional pages.", - "type": "string" - }, - "value": { - "description": "An array of objects of type OnlineEndpoint.", - "type": "array", - "items": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" + "ScaleType": { + "enum": [ + "Default", + "TargetUtilization" + ], + "type": "string", + "x-ms-enum": { + "name": "ScaleType", + "modelAsString": true, + "values": [ + { + "value": "Default" + }, + { + "value": "TargetUtilization" } - } + ] }, "additionalProperties": false }, - "OnlineRequestSettings": { - "description": "Online deployment scoring requests configuration.", + "Schedule": { + "description": "Base definition of a schedule", + "required": [ + "action", + "trigger" + ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], "properties": { - "maxConcurrentRequestsPerInstance": { - "format": "int32", - "description": "The number of maximum concurrent requests per node allowed per deployment. Defaults to 1.", - "default": 1, - "type": "integer" + "action": { + "description": "[Required] Specifies the action of the schedule", + "$ref": "#/definitions/ScheduleActionBase", + "x-ms-mutability": [ + "create", + "read", + "update" + ] }, - "maxQueueWait": { - "format": "duration", - "description": "The maximum amount of time a request will stay in the queue in ISO 8601 format.\r\nDefaults to 500ms.", - "default": "PT0.5S", - "type": "string" + "displayName": { + "description": "Display name of schedule.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true }, - "requestTimeout": { - "format": "duration", - "description": "The scoring timeout in ISO 8601 format.\r\nDefaults to 5000ms.", - "default": "PT5S", - "type": "string" + "isEnabled": { + "description": "Is the schedule enabled?", + "default": true, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "provisioningState": { + "description": "Provisioning state for the schedule.", + "$ref": "#/definitions/ScheduleProvisioningStatus", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "trigger": { + "description": "[Required] Specifies the trigger details", + "$ref": "#/definitions/TriggerBase", + "x-ms-mutability": [ + "create", + "read", + "update" + ] } }, + "x-ms-client-name": "ScheduleProperties", "additionalProperties": false }, - "OnlineScaleSettings": { - "description": "Online deployment scaling configuration.", + "ScheduleActionBase": { "required": [ - "scaleType" + "actionType" ], "type": "object", "properties": { - "scaleType": { - "description": "[Required] Type of deployment scaling algorithm", - "$ref": "#/definitions/ScaleType" + "actionType": { + "description": "[Required] Specifies the action type of the schedule", + "$ref": "#/definitions/ScheduleActionType", + "x-ms-mutability": [ + "create", + "read", + "update" + ] } }, - "discriminator": "scaleType" + "discriminator": "actionType" }, - "OperatingSystemType": { - "description": "The type of operating system.", + "ScheduleActionType": { "enum": [ - "Linux", - "Windows" + "CreateJob", + "InvokeBatchEndpoint" ], "type": "string", "x-ms-enum": { - "name": "OperatingSystemType", + "name": "ScheduleActionType", "modelAsString": true, "values": [ { - "value": "Linux" + "value": "CreateJob" }, { - "value": "Windows" + "value": "InvokeBatchEndpoint" } ] }, "additionalProperties": false }, - "OrderString": { + "ScheduleProvisioningStatus": { "enum": [ - "CreatedAtDesc", - "CreatedAtAsc", - "UpdatedAtDesc", - "UpdatedAtAsc" + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" ], "type": "string", "x-ms-enum": { - "name": "OrderString", + "name": "ScheduleProvisioningStatus", "modelAsString": true, "values": [ { - "value": "CreatedAtDesc" + "value": "Creating" }, { - "value": "CreatedAtAsc" + "value": "Updating" }, { - "value": "UpdatedAtDesc" + "value": "Deleting" }, { - "value": "UpdatedAtAsc" - } - ] - }, - "additionalProperties": false - }, - "OutputDeliveryMode": { - "description": "Output data delivery mode enums.", - "enum": [ - "ReadWriteMount", - "Upload" - ], - "type": "string", - "x-ms-enum": { - "name": "OutputDeliveryMode", - "modelAsString": true, - "values": [ + "value": "Succeeded" + }, { - "value": "ReadWriteMount" + "value": "Failed" }, { - "value": "Upload" + "value": "Canceled" } ] }, "additionalProperties": false }, - "OutputPathAssetReference": { - "description": "Reference to an asset via its path in a job output.", + "ScheduleResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetReferenceBase" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" } ], "properties": { - "jobId": { - "description": "ARM resource ID of the job.", - "type": "string", - "x-nullable": true - }, - "path": { - "description": "The path of the file/directory in the job output.", - "type": "string", - "x-nullable": true + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Schedule" } }, - "x-ms-discriminator-value": "OutputPath", + "x-ms-client-name": "Schedule", "additionalProperties": false }, - "PartialBatchDeployment": { - "description": "Mutable batch inference settings per deployment.", + "ScheduleResourceArmPaginatedResult": { + "description": "A paginated list of Schedule entities.", "type": "object", "properties": { - "description": { - "description": "Description of the endpoint deployment.", - "type": "string", - "x-nullable": true + "nextLink": { + "description": "The link to the next page of Schedule objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Schedule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScheduleResource" + } } }, "additionalProperties": false }, - "PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties": { - "description": "Strictly used in update requests.", + "Seasonality": { + "description": "Forecasting seasonality.", + "required": [ + "mode" + ], "type": "object", "properties": { - "properties": { - "description": "Additional attributes of the entity.", - "$ref": "#/definitions/PartialBatchDeployment" - }, - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true - } + "mode": { + "description": "[Required] Seasonality mode.", + "$ref": "#/definitions/SeasonalityMode", + "x-ms-mutability": [ + "create", + "read" + ] } }, - "additionalProperties": false + "discriminator": "mode" }, - "PartialManagedServiceIdentity": { - "description": "Managed service identity (system assigned and/or user assigned identities)", - "type": "object", - "properties": { - "type": { - "description": "Managed service identity (system assigned and/or user assigned identities)", - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentityType" - }, - "userAssignedIdentities": { - "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/PartialUserAssignedIdentity" + "SeasonalityMode": { + "description": "Forecasting seasonality mode.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "SeasonalityMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Seasonality to be determined automatically." + }, + { + "value": "Custom", + "description": "Use the custom seasonality value." } - } + ] }, "additionalProperties": false }, - "PartialMinimalTrackedResource": { - "description": "Strictly used in update requests.", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true + "SecretsType": { + "description": "Enum to determine the datastore secrets type.", + "enum": [ + "AccountKey", + "Certificate", + "Sas", + "ServicePrincipal", + "KerberosPassword", + "KerberosKeytab" + ], + "type": "string", + "x-ms-enum": { + "name": "SecretsType", + "modelAsString": true, + "values": [ + { + "value": "AccountKey" + }, + { + "value": "Certificate" + }, + { + "value": "Sas" + }, + { + "value": "ServicePrincipal" + }, + { + "value": "KerberosPassword" + }, + { + "value": "KerberosKeytab" } - } + ] }, "additionalProperties": false }, - "PartialMinimalTrackedResourceWithIdentity": { - "description": "Strictly used in update requests.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/PartialMinimalTrackedResource" - } + "ServiceDataAccessAuthIdentity": { + "enum": [ + "None", + "WorkspaceSystemAssignedIdentity", + "WorkspaceUserAssignedIdentity" ], - "properties": { - "identity": { - "description": "Managed service identity (system assigned and/or user assigned identities)", - "$ref": "#/definitions/PartialManagedServiceIdentity" - } + "type": "string", + "x-ms-enum": { + "name": "ServiceDataAccessAuthIdentity", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Do not use any identity for service data access." + }, + { + "value": "WorkspaceSystemAssignedIdentity", + "description": "Use the system assigned managed identity of the Workspace to authenticate service data access." + }, + { + "value": "WorkspaceUserAssignedIdentity", + "description": "Use the user assigned managed identity of the Workspace to authenticate service data access." + } + ] }, "additionalProperties": false }, - "PartialMinimalTrackedResourceWithSku": { - "description": "Strictly used in update requests.", + "ServicePrincipalDatastoreCredentials": { + "description": "Service Principal datastore credentials configuration.", + "required": [ + "clientId", + "secrets", + "tenantId" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/PartialMinimalTrackedResource" + "$ref": "#/definitions/DatastoreCredentials" } ], "properties": { - "sku": { - "description": "Sku details required for ARM contract for Autoscaling.", - "$ref": "#/definitions/PartialSku" - } - }, - "additionalProperties": false - }, - "PartialSku": { - "description": "Common SKU definition.", - "type": "object", - "properties": { - "capacity": { - "format": "int32", - "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.", - "type": "integer" + "authorityUrl": { + "description": "Authority URL used for authentication.", + "type": "string", + "x-nullable": true }, - "family": { - "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", + "clientId": { + "format": "uuid", + "description": "[Required] Service principal client ID.", "type": "string" }, - "name": { - "description": "The name of the SKU. Ex - P3. It is typically a letter+number code.", - "type": "string" + "resourceUrl": { + "description": "Resource the service principal has access to.", + "type": "string", + "x-nullable": true }, - "size": { - "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.", - "type": "string" + "secrets": { + "description": "[Required] Service principal secrets.", + "$ref": "#/definitions/ServicePrincipalDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true }, - "tier": { - "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" + "tenantId": { + "format": "uuid", + "description": "[Required] ID of the tenant to which the service principal belongs.", + "type": "string" } }, + "x-ms-discriminator-value": "ServicePrincipal", "additionalProperties": false }, - "PartialUserAssignedIdentity": { - "type": "object", - "additionalProperties": false - }, - "PipelineJob": { - "description": "Pipeline Job definition: defines generic to MFE attributes.", + "ServicePrincipalDatastoreSecrets": { + "description": "Datastore Service Principal secrets.", "type": "object", "allOf": [ { - "$ref": "#/definitions/JobBase" + "$ref": "#/definitions/DatastoreSecrets" } ], "properties": { - "inputs": { - "description": "Inputs for the pipeline job.", - "type": "object", - "additionalProperties": { - "description": "Command job definition.", - "$ref": "#/definitions/JobInput", - "x-nullable": true - }, - "x-ms-mutability": [ - "create", - "read" - ], + "clientSecret": { + "description": "Service principal secret.", + "type": "string", "x-nullable": true - }, - "jobs": { - "description": "Jobs construct the Pipeline Job.", - "type": "object", - "additionalProperties": { - "type": "object", - "x-nullable": true + } + }, + "x-ms-discriminator-value": "ServicePrincipal", + "additionalProperties": false + }, + "ShortSeriesHandlingConfiguration": { + "description": "The parameter defining how if AutoML should handle short time series.", + "enum": [ + "None", + "Auto", + "Pad", + "Drop" + ], + "type": "string", + "x-ms-enum": { + "name": "ShortSeriesHandlingConfiguration", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Represents no/null value." }, - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "outputs": { - "description": "Outputs for the pipeline job", - "type": "object", - "additionalProperties": { - "description": "Job output definition container information on where to find job output/logs.", - "$ref": "#/definitions/JobOutput", - "x-nullable": true + { + "value": "Auto", + "description": "Short series will be padded if there are no long series, otherwise short series will be dropped." }, - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "settings": { - "description": "Pipeline settings, for things like ContinueRunOnStepFailure etc.", - "type": "object", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - } + { + "value": "Pad", + "description": "All the short series will be padded." + }, + { + "value": "Drop", + "description": "All the short series will be dropped." + } + ] }, - "x-ms-discriminator-value": "Pipeline", "additionalProperties": false }, - "ProbeSettings": { - "description": "Deployment container liveness/readiness probe configuration.", + "SkuCapacity": { + "description": "SKU capacity information", "type": "object", "properties": { - "failureThreshold": { + "default": { "format": "int32", - "description": "The number of failures to allow before returning an unhealthy status.", - "default": 30, + "description": "Gets or sets the default capacity.", + "default": 0, "type": "integer" }, - "initialDelay": { - "format": "duration", - "description": "The delay before the first probe in ISO 8601 format.", - "type": "string", - "x-nullable": true - }, - "period": { - "format": "duration", - "description": "The length of time between probes in ISO 8601 format.", - "default": "PT10S", - "type": "string" + "maximum": { + "format": "int32", + "description": "Gets or sets the maximum.", + "default": 0, + "type": "integer" }, - "successThreshold": { + "minimum": { "format": "int32", - "description": "The number of successful probes before returning a healthy status.", - "default": 1, + "description": "Gets or sets the minimum.", + "default": 0, "type": "integer" }, - "timeout": { - "format": "duration", - "description": "The probe timeout in ISO 8601 format.", - "default": "PT2S", - "type": "string" + "scaleType": { + "description": "Gets or sets the type of the scale.", + "default": "Automatic", + "$ref": "#/definitions/SkuScaleType" } }, "additionalProperties": false }, - "PyTorch": { - "description": "PyTorch distribution configuration.", + "SkuResource": { + "description": "Fulfills ARM Contract requirement to list all available SKUS for a resource.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DistributionConfiguration" - } - ], "properties": { - "processCountPerInstance": { - "format": "int32", - "description": "Number of processes per node.", - "type": "integer", + "capacity": { + "description": "Gets or sets the Sku Capacity.", + "$ref": "#/definitions/SkuCapacity", + "x-nullable": true + }, + "resourceType": { + "description": "The resource type name.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "sku": { + "description": "Gets or sets the Sku.", + "$ref": "#/definitions/SkuSetting", "x-nullable": true } }, - "x-ms-discriminator-value": "PyTorch", "additionalProperties": false }, - "RandomSamplingAlgorithm": { - "description": "Defines a Sampling Algorithm that generates values randomly", + "SkuResourceArmPaginatedResult": { + "description": "A paginated list of SkuResource entities.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SamplingAlgorithm" - } - ], "properties": { - "rule": { - "description": "The specific type of random algorithm", - "default": "Random", - "$ref": "#/definitions/RandomSamplingAlgorithmRule" + "nextLink": { + "description": "The link to the next page of SkuResource objects. If null, there are no additional pages.", + "type": "string" }, - "seed": { - "format": "int32", - "description": "An optional integer to use as the seed for random number generation", - "type": "integer", - "x-nullable": true - } - }, - "x-ms-discriminator-value": "Random", - "additionalProperties": false - }, - "RandomSamplingAlgorithmRule": { - "description": "The specific type of random algorithm", - "enum": [ - "Random", - "Sobol" - ], - "type": "string", - "x-ms-enum": { - "name": "RandomSamplingAlgorithmRule", - "modelAsString": true, - "values": [ - { - "value": "Random" + "value": { + "description": "An array of objects of type SkuResource.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuResource" }, - { - "value": "Sobol" - } - ] + "x-ms-identifiers": [] + } }, "additionalProperties": false }, - "ReferenceType": { - "description": "Enum to determine which reference method to use for an asset.", + "SkuScaleType": { + "description": "Node scaling setting for the compute sku.", "enum": [ - "Id", - "DataPath", - "OutputPath" + "Automatic", + "Manual", + "None" ], "type": "string", "x-ms-enum": { - "name": "ReferenceType", + "name": "SkuScaleType", "modelAsString": true, "values": [ { - "value": "Id" + "value": "Automatic", + "description": "Automatically scales node count." }, { - "value": "DataPath" + "value": "Manual", + "description": "Node count scaled upon user request." }, { - "value": "OutputPath" + "value": "None", + "description": "Fixed set of nodes." } ] }, "additionalProperties": false }, - "RegenerateEndpointKeysRequest": { + "SkuSetting": { + "description": "SkuSetting fulfills the need for stripped down SKU info in ARM contract.", "required": [ - "keyType" + "name" ], "type": "object", "properties": { - "keyType": { - "description": "[Required] Specification for which type of key to generate. Primary or Secondary.", - "$ref": "#/definitions/KeyType", - "example": "Primary" + "name": { + "description": "[Required] The name of the SKU. Ex - P3. It is typically a letter+number code.", + "pattern": "[a-zA-Z0-9_]", + "type": "string" }, - "keyValue": { - "description": "The value the key is set to.", - "type": "string", - "x-nullable": true + "tier": { + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", + "default": "Basic", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" } }, "additionalProperties": false }, - "ResourceBase": { + "SparkJob": { + "description": "Spark job definition.", + "required": [ + "codeId", + "entry" + ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], "properties": { - "description": { - "description": "The asset description text.", + "archives": { + "description": "Archive files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "args": { + "description": "Arguments for the job.", "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], "x-nullable": true }, - "properties": { - "description": "The asset property dictionary.", + "codeId": { + "description": "[Required] ARM resource ID of the code asset.", + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "conf": { + "description": "Spark configured properties.", "type": "object", "additionalProperties": { "type": "string", "x-nullable": true }, + "x-ms-mutability": [ + "create", + "read" + ], "x-nullable": true }, - "tags": { - "description": "Tag dictionary. Tags can be added, removed, and updated.", + "entry": { + "description": "[Required] The entry to execute on startup of the job.", + "$ref": "#/definitions/SparkJobEntry", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentId": { + "description": "The ARM resource ID of the Environment specification for the job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "files": { + "description": "Files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inputs": { + "description": "Mapping of input data bindings used in the job.", "type": "object", "additionalProperties": { - "type": "string", + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", "x-nullable": true }, - "x-nullable": true - } - }, - "additionalProperties": false - }, - "ResourceConfiguration": { - "type": "object", - "properties": { - "instanceCount": { - "format": "int32", - "description": "Optional number of instances or nodes used by the compute target.", - "default": 1, - "type": "integer", "x-ms-mutability": [ "create", "read" - ] + ], + "x-nullable": true }, - "instanceType": { - "description": "Optional type of VM used as supported by the compute target.", - "type": "string", + "jars": { + "description": "Jar files used in the job.", + "type": "array", + "items": { + "type": "string" + }, "x-ms-mutability": [ "create", "read" ], "x-nullable": true }, - "properties": { - "description": "Additional properties bag.", + "outputs": { + "description": "Mapping of output data bindings used in the job.", "type": "object", "additionalProperties": { - "type": "object", + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", "x-nullable": true }, "x-ms-mutability": [ @@ -9308,293 +14185,234 @@ "read" ], "x-nullable": true - } - }, - "additionalProperties": false - }, - "Route": { - "required": [ - "path", - "port" - ], - "type": "object", - "properties": { - "path": { - "description": "[Required] The path for the route.", - "pattern": "[a-zA-Z0-9_]", - "type": "string" }, - "port": { - "format": "int32", - "description": "[Required] The port for the route.", - "type": "integer" + "pyFiles": { + "description": "Python files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "$ref": "#/definitions/SparkResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, + "x-ms-discriminator-value": "Spark", "additionalProperties": false }, - "SamplingAlgorithm": { - "description": "The Sampling Algorithm used to generate hyperparameter values, along with properties to\r\nconfigure the algorithm", + "SparkJobEntry": { + "description": "Spark job entry point definition.", "required": [ - "samplingAlgorithmType" + "sparkJobEntryType" ], "type": "object", "properties": { - "samplingAlgorithmType": { - "description": "[Required] The algorithm used for generating hyperparameter values, along with configuration properties", - "$ref": "#/definitions/SamplingAlgorithmType" + "sparkJobEntryType": { + "description": "[Required] Type of the job's entry point.", + "$ref": "#/definitions/SparkJobEntryType", + "x-ms-mutability": [ + "create", + "read" + ] } }, - "discriminator": "samplingAlgorithmType" + "discriminator": "sparkJobEntryType" }, - "SamplingAlgorithmType": { + "SparkJobEntryType": { "enum": [ - "Grid", - "Random", - "Bayesian" + "SparkJobPythonEntry", + "SparkJobScalaEntry" ], "type": "string", "x-ms-enum": { - "name": "SamplingAlgorithmType", + "name": "SparkJobEntryType", "modelAsString": true, "values": [ { - "value": "Grid" - }, - { - "value": "Random" + "value": "SparkJobPythonEntry" }, { - "value": "Bayesian" + "value": "SparkJobScalaEntry" } ] }, "additionalProperties": false }, - "SasDatastoreCredentials": { - "description": "SAS datastore credentials configuration.", + "SparkJobPythonEntry": { "required": [ - "secrets" + "file" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/DatastoreCredentials" + "$ref": "#/definitions/SparkJobEntry" } ], "properties": { - "secrets": { - "description": "[Required] Storage container secrets.", - "$ref": "#/definitions/SasDatastoreSecrets", + "file": { + "description": "[Required] Relative python file path for job entry point.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "example": "train.py", "x-ms-mutability": [ "create", - "update" - ], - "x-ms-secret": true + "read" + ] } }, - "x-ms-discriminator-value": "Sas", + "x-ms-discriminator-value": "SparkJobPythonEntry", "additionalProperties": false }, - "SasDatastoreSecrets": { - "description": "Datastore SAS secrets.", + "SparkJobScalaEntry": { + "required": [ + "className" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/DatastoreSecrets" + "$ref": "#/definitions/SparkJobEntry" } ], "properties": { - "sasToken": { - "description": "Storage container SAS token.", + "className": { + "description": "[Required] Scala class name used as entry point.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "example": "microsoft.aml.sample.myapp", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "SparkJobPythonEntry", + "additionalProperties": false + }, + "SparkResourceConfiguration": { + "type": "object", + "properties": { + "instanceType": { + "description": "Optional type of VM used as supported by the compute target.", "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], "x-nullable": true + }, + "runtimeVersion": { + "description": "Version of spark runtime used for the job.", + "default": "3.1", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] } }, - "x-ms-discriminator-value": "Sas", "additionalProperties": false }, - "ScaleType": { - "enum": [ - "Default", - "TargetUtilization" - ], - "type": "string", - "x-ms-enum": { - "name": "ScaleType", - "modelAsString": true, - "values": [ - { - "value": "Default" - }, - { - "value": "TargetUtilization" - } - ] + "StackEnsembleSettings": { + "description": "Advances setting to customize StackEnsemble run.", + "type": "object", + "properties": { + "stackMetaLearnerKWargs": { + "description": "Optional parameters to pass to the initializer of the meta-learner.", + "type": "object", + "x-nullable": true + }, + "stackMetaLearnerTrainPercentage": { + "format": "double", + "description": "Specifies the proportion of the training set (when choosing train and validation type of training) to be reserved for training the meta-learner. Default value is 0.2.", + "default": 0.2, + "type": "number" + }, + "stackMetaLearnerType": { + "description": "The meta-learner is a model trained on the output of the individual heterogeneous models.", + "default": "None", + "$ref": "#/definitions/StackMetaLearnerType" + } }, "additionalProperties": false }, - "SecretsType": { - "description": "Enum to determine the datastore secrets type.", + "StackMetaLearnerType": { + "description": "The meta-learner is a model trained on the output of the individual heterogeneous models.\r\nDefault meta-learners are LogisticRegression for classification tasks (or LogisticRegressionCV if cross-validation is enabled) and ElasticNet for regression/forecasting tasks (or ElasticNetCV if cross-validation is enabled).\r\nThis parameter can be one of the following strings: LogisticRegression, LogisticRegressionCV, LightGBMClassifier, ElasticNet, ElasticNetCV, LightGBMRegressor, or LinearRegression", "enum": [ - "AccountKey", - "Certificate", - "Sas", - "ServicePrincipal" + "None", + "LogisticRegression", + "LogisticRegressionCV", + "LightGBMClassifier", + "ElasticNet", + "ElasticNetCV", + "LightGBMRegressor", + "LinearRegression" ], "type": "string", "x-ms-enum": { - "name": "SecretsType", + "name": "StackMetaLearnerType", "modelAsString": true, "values": [ { - "value": "AccountKey" + "value": "None" }, { - "value": "Certificate" + "value": "LogisticRegression", + "description": "Default meta-learners are LogisticRegression for classification tasks." }, { - "value": "Sas" + "value": "LogisticRegressionCV", + "description": "Default meta-learners are LogisticRegression for classification task when CV is on." }, { - "value": "ServicePrincipal" - } - ] - }, - "additionalProperties": false - }, - "ServiceDataAccessAuthIdentity": { - "enum": [ - "None", - "WorkspaceSystemAssignedIdentity", - "WorkspaceUserAssignedIdentity" - ], - "type": "string", - "x-ms-enum": { - "name": "ServiceDataAccessAuthIdentity", - "modelAsString": true, - "values": [ + "value": "LightGBMClassifier" + }, { - "value": "None", - "description": "Do not use any identity for service data access." + "value": "ElasticNet", + "description": "Default meta-learners are LogisticRegression for regression task." }, { - "value": "WorkspaceSystemAssignedIdentity", - "description": "Use the system assigned managed identity of the Workspace to authenticate service data access." + "value": "ElasticNetCV", + "description": "Default meta-learners are LogisticRegression for regression task when CV is on." }, { - "value": "WorkspaceUserAssignedIdentity", - "description": "Use the user assigned managed identity of the Workspace to authenticate service data access." + "value": "LightGBMRegressor" + }, + { + "value": "LinearRegression" } ] }, "additionalProperties": false }, - "ServicePrincipalDatastoreCredentials": { - "description": "Service Principal datastore credentials configuration.", - "required": [ - "clientId", - "secrets", - "tenantId" - ], + "StatusMessage": { + "description": "Active message associated with project", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatastoreCredentials" - } - ], "properties": { - "authorityUrl": { - "description": "Authority URL used for authentication.", - "type": "string", - "x-nullable": true - }, - "clientId": { - "format": "uuid", - "description": "[Required] Service principal client ID.", - "type": "string" - }, - "resourceUrl": { - "description": "Resource the service principal has access to.", + "code": { + "description": "Service-defined message code.", "type": "string", - "x-nullable": true - }, - "secrets": { - "description": "[Required] Service principal secrets.", - "$ref": "#/definitions/ServicePrincipalDatastoreSecrets", + "readOnly": true, "x-ms-mutability": [ - "create", - "update" + "read" ], - "x-ms-secret": true - }, - "tenantId": { - "format": "uuid", - "description": "[Required] ID of the tenant to which the service principal belongs.", - "type": "string" - } - }, - "x-ms-discriminator-value": "ServicePrincipal", - "additionalProperties": false - }, - "ServicePrincipalDatastoreSecrets": { - "description": "Datastore Service Principal secrets.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatastoreSecrets" - } - ], - "properties": { - "clientSecret": { - "description": "Service principal secret.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-discriminator-value": "ServicePrincipal", - "additionalProperties": false - }, - "SkuCapacity": { - "description": "SKU capacity information", - "type": "object", - "properties": { - "default": { - "format": "int32", - "description": "Gets or sets the default capacity.", - "default": 0, - "type": "integer" - }, - "maximum": { - "format": "int32", - "description": "Gets or sets the maximum.", - "default": 0, - "type": "integer" - }, - "minimum": { - "format": "int32", - "description": "Gets or sets the minimum.", - "default": 0, - "type": "integer" - }, - "scaleType": { - "description": "Gets or sets the type of the scale.", - "default": "Automatic", - "$ref": "#/definitions/SkuScaleType" - } - }, - "additionalProperties": false - }, - "SkuResource": { - "description": "Fulfills ARM Contract requirement to list all available SKUS for a resource.", - "type": "object", - "properties": { - "capacity": { - "description": "Gets or sets the Sku Capacity.", - "$ref": "#/definitions/SkuCapacity", "x-nullable": true }, - "resourceType": { - "description": "The resource type name.", + "createdDateTime": { + "format": "date-time", + "description": "Time in UTC at which the message was created.", "type": "string", "readOnly": true, "x-ms-mutability": [ @@ -9602,78 +14420,80 @@ ], "x-nullable": true }, - "sku": { - "description": "Gets or sets the Sku.", - "$ref": "#/definitions/SkuSetting", - "x-nullable": true - } - }, - "additionalProperties": false - }, - "SkuResourceArmPaginatedResult": { - "description": "A paginated list of SkuResource entities.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link to the next page of SkuResource objects. If null, there are no additional pages.", - "type": "string" + "level": { + "description": "Severity level of message.", + "$ref": "#/definitions/StatusMessageLevel", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] }, - "value": { - "description": "An array of objects of type SkuResource.", - "type": "array", - "items": { - "$ref": "#/definitions/SkuResource" - }, - "x-ms-identifiers": [] + "message": { + "description": "A human-readable representation of the message code.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true } }, "additionalProperties": false }, - "SkuScaleType": { - "description": "Node scaling setting for the compute sku.", + "StatusMessageLevel": { "enum": [ - "Automatic", - "Manual", - "None" + "Error", + "Information", + "Warning" ], "type": "string", "x-ms-enum": { - "name": "SkuScaleType", + "name": "StatusMessageLevel", "modelAsString": true, "values": [ { - "value": "Automatic", - "description": "Automatically scales node count." + "value": "Error" }, { - "value": "Manual", - "description": "Node count scaled upon user request." + "value": "Information" }, { - "value": "None", - "description": "Fixed set of nodes." + "value": "Warning" } ] }, "additionalProperties": false }, - "SkuSetting": { - "description": "SkuSetting fulfills the need for stripped down SKU info in ARM contract.", - "required": [ - "name" + "StochasticOptimizer": { + "description": "Stochastic optimizer for image models.", + "enum": [ + "None", + "Sgd", + "Adam", + "Adamw" ], - "type": "object", - "properties": { - "name": { - "description": "[Required] The name of the SKU. Ex - P3. It is typically a letter+number code.", - "pattern": "[a-zA-Z0-9_]", - "type": "string" - }, - "tier": { - "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", - "default": "Basic", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" - } + "type": "string", + "x-ms-enum": { + "name": "StochasticOptimizer", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No optimizer selected." + }, + { + "value": "Sgd", + "description": "Stochastic Gradient Descent optimizer." + }, + { + "value": "Adam", + "description": "Adam is algorithm the optimizes stochastic objective functions based on adaptive estimates of moments" + }, + { + "value": "Adamw", + "description": "AdamW is a variant of the optimizer Adam that has an improved implementation of weight decay." + } + ] }, "additionalProperties": false }, @@ -9735,54 +14555,327 @@ "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true - }, - "samplingAlgorithm": { - "description": "[Required] The hyperparameter sampling algorithm", - "$ref": "#/definitions/SamplingAlgorithm" - }, - "searchSpace": { - "description": "[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter", - "type": "object" - }, - "trial": { - "description": "[Required] Trial component definition.", - "$ref": "#/definitions/TrialComponent" + ], + "x-nullable": true + }, + "samplingAlgorithm": { + "description": "[Required] The hyperparameter sampling algorithm", + "$ref": "#/definitions/SamplingAlgorithm" + }, + "searchSpace": { + "description": "[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter", + "type": "object" + }, + "trial": { + "description": "[Required] Trial component definition.", + "$ref": "#/definitions/TrialComponent" + } + }, + "x-ms-discriminator-value": "Sweep", + "additionalProperties": false + }, + "SweepJobLimits": { + "description": "Sweep Job limit class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobLimits" + } + ], + "properties": { + "maxConcurrentTrials": { + "format": "int32", + "description": "Sweep Job max concurrent trials.", + "type": "integer", + "x-nullable": true + }, + "maxTotalTrials": { + "format": "int32", + "description": "Sweep Job max total trials.", + "type": "integer", + "x-nullable": true + }, + "trialTimeout": { + "format": "duration", + "description": "Sweep Job Trial timeout value.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Sweep", + "additionalProperties": false + }, + "TableVertical": { + "description": "Abstract class for AutoML tasks that use table dataset as input - such as Classification/Regression/Forecasting.", + "type": "object", + "properties": { + "cvSplitColumnNames": { + "description": "Columns to use for CVSplit data.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "featurizationSettings": { + "description": "Featurization inputs needed for AutoML job.", + "$ref": "#/definitions/TableVerticalFeaturizationSettings", + "x-nullable": true + }, + "limitSettings": { + "description": "Execution constraints for AutoMLJob.", + "$ref": "#/definitions/TableVerticalLimitSettings", + "x-nullable": true + }, + "nCrossValidations": { + "description": "Number of cross validation folds to be applied on training dataset\r\nwhen validation dataset is not provided.", + "$ref": "#/definitions/NCrossValidations", + "x-nullable": true + }, + "testData": { + "description": "Test data input.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + }, + "testDataSize": { + "format": "double", + "description": "The fraction of test dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", + "type": "number", + "x-nullable": true + }, + "validationData": { + "description": "Validation data inputs.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + }, + "validationDataSize": { + "format": "double", + "description": "The fraction of training dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", + "type": "number", + "x-nullable": true + }, + "weightColumnName": { + "description": "The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to be weighted up or down.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "TableVerticalFeaturizationSettings": { + "description": "Featurization Configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeaturizationSettings" + } + ], + "properties": { + "blockedTransformers": { + "description": "These transformers shall not be used in featurization.", + "type": "array", + "items": { + "$ref": "#/definitions/BlockedTransformers" + }, + "x-nullable": true + }, + "columnNameAndTypes": { + "description": "Dictionary of column name and its type (int, float, string, datetime etc).", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "enableDnnFeaturization": { + "description": "Determines whether to use Dnn based featurizers for data featurization.", + "default": false, + "type": "boolean" + }, + "mode": { + "description": "Featurization mode - User can keep the default 'Auto' mode and AutoML will take care of necessary transformation of the data in featurization phase.\r\nIf 'Off' is selected then no featurization is done.\r\nIf 'Custom' is selected then user can specify additional inputs to customize how featurization is done.", + "default": "Auto", + "$ref": "#/definitions/FeaturizationMode" + }, + "transformerParams": { + "description": "User can specify additional transformers to be used along with the columns to which it would be applied and parameters for the transformer constructor.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/ColumnTransformer" + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "TableVerticalLimitSettings": { + "description": "Job execution constraints.", + "type": "object", + "properties": { + "enableEarlyTermination": { + "description": "Enable early termination, determines whether or not if AutoMLJob will terminate early if there is no score improvement in last 20 iterations.", + "default": true, + "type": "boolean" + }, + "exitScore": { + "format": "double", + "description": "Exit score for the AutoML job.", + "type": "number", + "x-nullable": true + }, + "maxConcurrentTrials": { + "format": "int32", + "description": "Maximum Concurrent iterations.", + "default": 1, + "type": "integer" + }, + "maxCoresPerTrial": { + "format": "int32", + "description": "Max cores per iteration.", + "default": -1, + "type": "integer" + }, + "maxTrials": { + "format": "int32", + "description": "Number of iterations.", + "default": 1000, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "AutoML job timeout.", + "default": "PT6H", + "type": "string" + }, + "trialTimeout": { + "format": "duration", + "description": "Iteration timeout.", + "default": "PT30M", + "type": "string" + } + }, + "additionalProperties": false + }, + "TargetAggregationFunction": { + "description": "Target aggregate function.", + "enum": [ + "None", + "Sum", + "Max", + "Min", + "Mean" + ], + "type": "string", + "x-ms-enum": { + "name": "TargetAggregationFunction", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Represent no value set." + }, + { + "value": "Sum" + }, + { + "value": "Max" + }, + { + "value": "Min" + }, + { + "value": "Mean" + } + ] + }, + "additionalProperties": false + }, + "TargetLags": { + "description": "The number of past periods to lag from the target column.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] Set target lags mode - Auto/Custom", + "$ref": "#/definitions/TargetLagsMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "TargetLagsMode": { + "description": "Target lags selection modes.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "TargetLagsMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Target lags to be determined automatically." + }, + { + "value": "Custom", + "description": "Use the custom target lags." + } + ] + }, + "additionalProperties": false + }, + "TargetRollingWindowSize": { + "description": "Forecasting target rolling window size.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] TargetRollingWindowSiz detection mode.", + "$ref": "#/definitions/TargetRollingWindowSizeMode", + "x-ms-mutability": [ + "create", + "read" + ] } }, - "x-ms-discriminator-value": "Sweep", - "additionalProperties": false + "discriminator": "mode" }, - "SweepJobLimits": { - "description": "Sweep Job limit class.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/JobLimits" - } + "TargetRollingWindowSizeMode": { + "description": "Target rolling windows size mode.", + "enum": [ + "Auto", + "Custom" ], - "properties": { - "maxConcurrentTrials": { - "format": "int32", - "description": "Sweep Job max concurrent trials.", - "type": "integer", - "x-nullable": true - }, - "maxTotalTrials": { - "format": "int32", - "description": "Sweep Job max total trials.", - "type": "integer", - "x-nullable": true - }, - "trialTimeout": { - "format": "duration", - "description": "Sweep Job Trial timeout value.", - "type": "string", - "x-nullable": true - } + "type": "string", + "x-ms-enum": { + "name": "TargetRollingWindowSizeMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Determine rolling windows size automatically." + }, + { + "value": "Custom", + "description": "Use the specified rolling window size." + } + ] }, - "x-ms-discriminator-value": "Sweep", "additionalProperties": false }, "TargetUtilizationScaleSettings": { @@ -9821,6 +14914,69 @@ "x-ms-discriminator-value": "TargetUtilization", "additionalProperties": false }, + "TaskType": { + "description": "AutoMLJob Task type.", + "enum": [ + "Classification", + "Regression", + "Forecasting", + "ImageClassification", + "ImageClassificationMultilabel", + "ImageObjectDetection", + "ImageInstanceSegmentation", + "TextClassification", + "TextClassificationMultilabel", + "TextNER" + ], + "type": "string", + "x-ms-enum": { + "name": "TaskType", + "modelAsString": true, + "values": [ + { + "value": "Classification", + "description": "Classification in machine learning and statistics is a supervised learning approach in which\nthe computer program learns from the data given to it and make new observations or classifications." + }, + { + "value": "Regression", + "description": "Regression means to predict the value using the input data. Regression models are used to predict a continuous value." + }, + { + "value": "Forecasting", + "description": "Forecasting is a special kind of regression task that deals with time-series data and creates forecasting model\nthat can be used to predict the near future values based on the inputs." + }, + { + "value": "ImageClassification", + "description": "Image Classification. Multi-class image classification is used when an image is classified with only a single label\nfrom a set of classes - e.g. each image is classified as either an image of a 'cat' or a 'dog' or a 'duck'." + }, + { + "value": "ImageClassificationMultilabel", + "description": "Image Classification Multilabel. Multi-label image classification is used when an image could have one or more labels\nfrom a set of labels - e.g. an image could be labeled with both 'cat' and 'dog'." + }, + { + "value": "ImageObjectDetection", + "description": "Image Object Detection. Object detection is used to identify objects in an image and locate each object with a\nbounding box e.g. locate all dogs and cats in an image and draw a bounding box around each." + }, + { + "value": "ImageInstanceSegmentation", + "description": "Image Instance Segmentation. Instance segmentation is used to identify objects in an image at the pixel level,\ndrawing a polygon around each object in the image." + }, + { + "value": "TextClassification", + "description": "Text classification (also known as text tagging or text categorization) is the process of sorting texts into categories.\nCategories are mutually exclusive." + }, + { + "value": "TextClassificationMultilabel", + "description": "Multilabel classification task assigns each sample to a group (zero or more) of target labels." + }, + { + "value": "TextNER", + "description": "Text Named Entity Recognition a.k.a. TextNER.\nNamed Entity Recognition (NER) is the ability to take free-form text and identify the occurrences of entities such as people, locations, organizations, and more." + } + ] + }, + "additionalProperties": false + }, "TensorFlow": { "description": "TensorFlow distribution configuration.", "type": "object", @@ -9854,6 +15010,133 @@ "x-ms-discriminator-value": "TensorFlow", "additionalProperties": false }, + "TextAnnotationType": { + "description": "Annotation type of text data.", + "enum": [ + "Classification", + "NamedEntityRecognition" + ], + "type": "string", + "x-ms-enum": { + "name": "TextAnnotationType", + "modelAsString": true, + "values": [ + { + "value": "Classification" + }, + { + "value": "NamedEntityRecognition" + } + ] + }, + "additionalProperties": false + }, + "TextClassification": { + "description": "Text Classification task in AutoML NLP vertical.\r\nNLP - Natural Language Processing.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NlpVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric for Text-Classification task.", + "default": "Accuracy", + "$ref": "#/definitions/ClassificationPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "TextClassification", + "additionalProperties": false + }, + "TextClassificationMultilabel": { + "description": "Text Classification Multilabel task in AutoML NLP vertical.\r\nNLP - Natural Language Processing.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NlpVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric for Text-Classification-Multilabel task.\r\nCurrently only Accuracy is supported as primary metric, hence user need not set it explicitly.", + "$ref": "#/definitions/ClassificationMultilabelPrimaryMetrics", + "readOnly": true + } + }, + "x-ms-discriminator-value": "TextClassificationMultilabel", + "additionalProperties": false + }, + "TextNer": { + "description": "Text-NER task in AutoML NLP vertical.\r\nNER - Named Entity Recognition.\r\nNLP - Natural Language Processing.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NlpVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric for Text-NER task.\r\nOnly 'Accuracy' is supported for Text-NER, so user need not set this explicitly.", + "$ref": "#/definitions/ClassificationPrimaryMetrics", + "readOnly": true + } + }, + "x-ms-discriminator-value": "TextNER", + "additionalProperties": false + }, + "TrainingSettings": { + "description": "Training related configuration.", + "type": "object", + "properties": { + "enableDnnTraining": { + "description": "Enable recommendation of DNN models.", + "default": false, + "type": "boolean" + }, + "enableModelExplainability": { + "description": "Flag to turn on explainability on best model.", + "default": true, + "type": "boolean" + }, + "enableOnnxCompatibleModels": { + "description": "Flag for enabling onnx compatible models.", + "default": false, + "type": "boolean" + }, + "enableStackEnsemble": { + "description": "Enable stack ensemble run.", + "default": true, + "type": "boolean" + }, + "enableVoteEnsemble": { + "description": "Enable voting ensemble run.", + "default": true, + "type": "boolean" + }, + "ensembleModelDownloadTimeout": { + "format": "duration", + "description": "During VotingEnsemble and StackEnsemble model generation, multiple fitted models from the previous child runs are downloaded.\r\nConfigure this parameter with a higher value than 300 secs, if more time is needed.", + "default": "PT5M", + "type": "string" + }, + "stackEnsembleSettings": { + "description": "Stack ensemble settings for stack ensemble run.", + "$ref": "#/definitions/StackEnsembleSettings", + "x-nullable": true + } + }, + "additionalProperties": false + }, "TrialComponent": { "description": "Trial component definition.", "required": [ @@ -9911,7 +15194,7 @@ "resources": { "description": "Compute Resource configuration for the job.", "default": "{}", - "$ref": "#/definitions/ResourceConfiguration", + "$ref": "#/definitions/JobResourceConfiguration", "x-ms-mutability": [ "create", "read" @@ -9920,6 +15203,59 @@ }, "additionalProperties": false }, + "TriggerBase": { + "required": [ + "triggerType" + ], + "type": "object", + "properties": { + "endTime": { + "description": "Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601.\r\nRecommented format would be \"2022-06-01T00:00:01\"\r\nIf not present, the schedule will run indefinitely", + "type": "string", + "x-nullable": true + }, + "startTime": { + "description": "Specifies start time of schedule in ISO 8601 format, but without a UTC offset.", + "type": "string", + "x-nullable": true + }, + "timeZone": { + "description": "Specifies time zone in which the schedule runs.\r\nTimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11", + "default": "UTC", + "type": "string" + }, + "triggerType": { + "description": "[Required] ", + "$ref": "#/definitions/TriggerType", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "discriminator": "triggerType" + }, + "TriggerType": { + "enum": [ + "Recurrence", + "Cron" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggerType", + "modelAsString": true, + "values": [ + { + "value": "Recurrence" + }, + { + "value": "Cron" + } + ] + }, + "additionalProperties": false + }, "TritonModelJobInput": { "type": "object", "allOf": [ @@ -10049,6 +15385,113 @@ ], "x-ms-discriminator-value": "UserIdentity", "additionalProperties": false + }, + "UseStl": { + "description": "Configure STL Decomposition of the time-series target column.", + "enum": [ + "None", + "Season", + "SeasonTrend" + ], + "type": "string", + "x-ms-enum": { + "name": "UseStl", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No stl decomposition." + }, + { + "value": "Season" + }, + { + "value": "SeasonTrend" + } + ] + }, + "additionalProperties": false + }, + "ValidationMetricType": { + "description": "Metric computation method to use for validation metrics in image tasks.", + "enum": [ + "None", + "Coco", + "Voc", + "CocoVoc" + ], + "type": "string", + "x-ms-enum": { + "name": "ValidationMetricType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No metric." + }, + { + "value": "Coco", + "description": "Coco metric." + }, + { + "value": "Voc", + "description": "Voc metric." + }, + { + "value": "CocoVoc", + "description": "CocoVoc metric." + } + ] + }, + "additionalProperties": false + }, + "WeekDay": { + "description": "Enum of weekday", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true, + "values": [ + { + "value": "Monday", + "description": "Monday weekday" + }, + { + "value": "Tuesday", + "description": "Tuesday weekday" + }, + { + "value": "Wednesday", + "description": "Wednesday weekday" + }, + { + "value": "Thursday", + "description": "Thursday weekday" + }, + { + "value": "Friday", + "description": "Friday weekday" + }, + { + "value": "Saturday", + "description": "Saturday weekday" + }, + { + "value": "Sunday", + "description": "Sunday weekday" + } + ] + }, + "additionalProperties": false } }, "securityDefinitions": {