diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/createOrUpdateCommandJob.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/createOrUpdateCommandJob.json new file mode 100644 index 000000000000..924686ba8d57 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/createOrUpdateCommandJob.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2020-09-01-preview", + "id": "testId", + "body": { + "properties": { + "jobType": "Command", + "codeConfiguration": { + "codeArtifactId": "some code artifact", + "command": [ + "python", + "train.py", + "--arg", + "myArgument" + ] + }, + "environmentId": "some environment", + "dataBindings": { + "data binding 1": { + "sourceDataReference": "some data reference 1", + "localReference": "./", + "mode": "Mount" + }, + "data binding 2": { + "sourceDataReference": "some data reference 2", + "localReference": "./", + "mode": "Mount" + } + }, + "experimentName": "some experiment", + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "computeBinding": { + "computeId": "some compute", + "nodeCount": 2 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/jobs/testId", + "name": "testId", + "type": "Microsoft.MachineLearningServices/workspaces/jobs", + "properties": { + "jobType": "Command", + "status": "NotStarted", + "codeConfiguration": { + "codeArtifactId": "some code artifact", + "command": [ + "python", + "train.py", + "--arg", + "myArgument" + ] + }, + "environmentId": "some environment", + "dataBindings": { + "data binding 1": { + "sourceDataReference": "some data reference 1", + "localReference": "./", + "mode": "Mount" + }, + "data binding 2": { + "sourceDataReference": "some data reference 2", + "localReference": "./", + "mode": "Mount" + } + }, + "experimentName": "some experiment", + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "computeBinding": { + "computeId": "some compute", + "nodeCount": 2 + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/getCommandJob.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/getCommandJob.json new file mode 100644 index 000000000000..aac5faa63e68 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/getCommandJob.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2020-09-01-preview", + "id": "testId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/jobs/testId", + "name": "testId", + "type": "Microsoft.MachineLearningServices/workspaces/jobs", + "properties": { + "jobType": "Command", + "status": "Completed", + "codeConfiguration": { + "codeArtifactId": "some code artifact", + "command": [ + "python", + "train.py", + "--arg", + "myArgument" + ] + }, + "environmentId": "some environment", + "dataBindings": { + "data binding 1": { + "sourceDataReference": "some data reference 1", + "localReference": "./", + "mode": "Mount" + }, + "data binding 2": { + "sourceDataReference": "some data reference 2", + "localReference": "./", + "mode": "Mount" + } + }, + "experimentName": "some experiment", + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "computeBinding": { + "computeId": "some compute", + "nodeCount": 2 + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/listJobs.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/listJobs.json new file mode 100644 index 000000000000..22e82714d906 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/listJobs.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2020-09-01-preview", + "$skipToken": "skiptoken" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/jobs/testId1", + "name": "testId1", + "type": "Microsoft.MachineLearningServices/workspaces/jobs", + "properties": { + "jobType": "Command", + "status": "Completed", + "codeConfiguration": { + "codeArtifactId": "some code artifact", + "command": [ + "python", + "train.py", + "--arg", + "myArgument" + ] + }, + "environmentId": "some environment", + "dataBindings": { + "data binding 1": { + "sourceDataReference": "some data reference 1", + "localReference": "./", + "mode": "Mount" + }, + "data binding 2": { + "sourceDataReference": "some data reference 2", + "localReference": "./", + "mode": "Mount" + } + }, + "experimentName": "some experiment", + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "computeBinding": { + "computeId": "some compute", + "nodeCount": 2 + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codeJobs/testId2", + "name": "testId2", + "type": "Microsoft.MachineLearningServices/workspaces/jobs", + "properties": { + "jobType": "Command", + "status": "Completed", + "codeConfiguration": { + "codeArtifactId": "some code artifact", + "command": [ + "python", + "train.py", + "--arg", + "myArgument" + ] + }, + "environmentId": "some environment", + "dataBindings": { + "data binding 1": { + "sourceDataReference": "some data reference 1", + "localReference": "./", + "mode": "Mount" + }, + "data binding 2": { + "sourceDataReference": "some data reference 2", + "localReference": "./", + "mode": "Mount" + } + }, + "experimentName": "some experiment", + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "computeBinding": { + "computeId": "some compute", + "nodeCount": 2 + } + } + } + ], + "nextLink": "nextlink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/jobs.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/jobs.json new file mode 100644 index 000000000000..cd610da537ee --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/jobs.json @@ -0,0 +1,871 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning ManagementFrontEnd Service", + "version": "2020-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": { + "put": { + "tags": [ + "Job" + ], + "summary": "Creates and executes a Job.", + "operationId": "Jobs_CreateOrUpdate", + "x-ms-examples": { + "Create Or Update CommandJob": { + "$ref": "./examples/createOrUpdateCommandJob.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + }, + { + "in": "body", + "name": "body", + "description": "Job definition object.", + "schema": { + "$ref": "#/definitions/JobBaseResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/JobBaseResource" + } + } + } + }, + "get": { + "tags": [ + "Job" + ], + "summary": "Gets a Job by name/id.", + "operationId": "Jobs_Get", + "x-ms-examples": { + "Get CommandJob": { + "$ref": "./examples/getCommandJob.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/JobBaseResource" + } + } + } + }, + "delete": { + "tags": [ + "Job" + ], + "summary": "Deletes a Job.", + "operationId": "Jobs_Delete", + "parameters": [ + { + "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "Success" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs": { + "get": { + "tags": [ + "Job" + ], + "summary": "Lists Jobs in the workspace.", + "operationId": "Jobs_List", + "x-ms-examples": { + "List Jobs": { + "$ref": "./examples/listJobs.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/APIVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/JobBaseResourceArmPaginatedResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": { + "post": { + "tags": [ + "Job" + ], + "summary": "Cancels a Job.", + "operationId": "Jobs_Cancel", + "parameters": [ + { + "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError" + } + }, + "200": { + "description": "Success" + } + } + } + } + }, + "parameters": { + "JobIdParameter": { + "in": "path", + "name": "id", + "type": "string", + "description": "Name and identifier for Job.", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "CodeConfiguration": { + "required": [ + "command" + ], + "type": "object", + "properties": { + "commandType": { + "description": "Specifies the type of command.", + "enum": [ + "Command", + "Python" + ], + "type": "string", + "x-ms-enum": { + "name": "CommandType", + "modelAsString": false + } + }, + "codeArtifactId": { + "description": "The ID of the code asset.", + "type": "string" + }, + "command": { + "description": "The command to execute on startup of the job.", + "minLength": 1, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ComputeConfiguration": { + "type": "object", + "properties": { + "computeType": { + "enum": [ + "AMLCompute", + "AKS", + "ACI" + ], + "type": "string", + "x-ms-enum": { + "name": "ComputeType", + "modelAsString": false + } + } + } + }, + "DataBinding": { + "description": "Data binding definition.", + "type": "object", + "properties": { + "sourceDataReference": { + "description": "Reference to source data artifact.", + "type": "string" + }, + "localReference": { + "description": "Location of data inside the container process.", + "type": "string" + }, + "mode": { + "description": "Describes how the data should be attached to the container.", + "enum": [ + "Mount", + "Download", + "Upload" + ], + "type": "string", + "x-ms-enum": { + "name": "DataBindingMode", + "modelAsString": false + } + } + } + }, + "DistributionConfiguration": { + "type": "object", + "discriminator": "distributionType", + "required": [ + "distributionType" + ], + "properties": { + "distributionType": { + "description": "Specifies the type of distribution framework.", + "enum": [ + "PyTorch", + "Tensorflow", + "Mpi" + ], + "type": "string", + "x-ms-enum": { + "name": "DistributionType", + "modelAsString": false + } + } + } + }, + "Tensorflow": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DistributionConfiguration" + }, + { + "type": "object", + "properties": { + "workerCount": { + "description": "The number of workers.", + "format": "int32", + "type": "integer", + "default": 1 + }, + "parameterServerCount": { + "description": "The number of parameter servers.", + "format": "int32", + "type": "integer", + "default": 1 + } + } + } + ], + "x-ms-discriminator-value": "Tensorflow" + }, + "Mpi": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DistributionConfiguration" + }, + { + "type": "object", + "properties": { + "processCountPerNode": { + "description": "The number of process in each node.", + "format": "int32", + "type": "integer", + "default": 1 + }, + "nodeCount": { + "description": "The number nodes.", + "format": "int32", + "type": "integer" + } + } + } + ], + "x-ms-discriminator-value": "Mpi" + }, + "Pytorch": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DistributionConfiguration" + }, + { + "type": "object", + "properties": { + "communicatorBackend": { + "description": "Specifies the communicator backend.", + "enum": [ + "Nccl", + "Gloo" + ], + "type": "string", + "x-ms-enum": { + "name": "CommunicatorBackend", + "modelAsString": false + } + }, + "nodeCount": { + "description": "The number nodes.", + "format": "int32", + "type": "integer" + } + } + } + ], + "x-ms-discriminator-value": "Pytorch" + }, + "ComputeBinding": { + "description": "Compute binding definition.", + "required": [ + "computeId" + ], + "type": "object", + "properties": { + "computeId": { + "description": "ID of the compute resource.", + "pattern": "\\w", + "type": "string" + }, + "nodeCount": { + "format": "int32", + "description": "Number of nodes.", + "type": "integer" + } + } + }, + "CommandJob": { + "description": "Command Job definition", + "required": [ + "codeConfiguration", + "computeBinding", + "jobType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + }, + { + "type": "object", + "properties": { + "status": { + "description": "Status of the job.", + "enum": [ + "NotStarted", + "Starting", + "Provisioning", + "Preparing", + "Queued", + "Running", + "Finalizing", + "CancelRequested", + "Completed", + "Failed", + "Canceled", + "NotResponding", + "Paused" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": false + }, + "x-ms-mutability": [ + "read" + ] + }, + "maxRunDurationSeconds": { + "format": "int64", + "description": "The max run duration in seconds, after which the job will be cancelled.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "codeConfiguration": { + "$ref": "#/definitions/CodeConfiguration" + }, + "environmentId": { + "description": "Environment specification of the job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dataBindings": { + "description": "Mapping of data bindings used in the job.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DataBinding" + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "distributionConfiguration": { + "$ref": "#/definitions/DistributionConfiguration" + }, + "studioEndpoint": { + "format": "uri", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "trackingEndpoint": { + "format": "uri", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "experimentName": { + "description": "The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "computeBinding": { + "$ref": "#/definitions/ComputeBinding" + } + } + } + ], + "x-ms-discriminator-value": "Command" + }, + "JobBase": { + "description": "Job base definition", + "type": "object", + "required": [ + "jobType" + ], + "discriminator": "jobType", + "properties": { + "jobType": { + "description": "Specifies the type of job.", + "enum": [ + "Command", + "Sweep", + "Labeling", + "Pipeline", + "Data", + "AutoML" + ], + "type": "string", + "x-ms-enum": { + "name": "JobType", + "modelAsString": false + } + }, + "properties": { + "description": "The job property dictionary. Properties can be added, but not removed or altered.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "tags": { + "description": "The job tag dictionary. Tags can be added, removed, and updated.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + } + }, + "JobBaseResource": { + "description": "Azure Resource Manager resource Envelope", + "x-ms-azure-resource": true, + "required": [ + "properties" + ], + "type": "object", + "properties": { + "id": { + "description": "The resource URL of the entity (not URL encoded).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource entity.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The resource provider and type.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/JobBase" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + } + }, + "JobBaseResourceArmPaginatedResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobBaseResource" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "ParameterSamplingConfiguration": { + "description": "class for all hyperparameter sampling algorithms", + "type": "object", + "properties": { + "parameterSpace": { + "description": "A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "description": "A dictionary with additional properties for the algorithm.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "samplingType": { + "description": "Type of the hyperparameter sampling algorithms", + "enum": [ + "Grid", + "Random", + "Bayesian" + ], + "type": "string", + "x-ms-enum": { + "name": "ParameterSamplingType", + "modelAsString": false + } + } + } + }, + "EarlyTerminationPolicyConfiguration": { + "description": "Early termination policies enable canceling poor-performing runs before they complete", + "type": "object", + "properties": { + "policyType": { + "description": "Name of policy configuration", + "enum": [ + "Bandit", + "MedianStopping", + "TruncationSelection" + ], + "type": "string", + "x-ms-enum": { + "name": "EarlyTerminationPolicyType", + "modelAsString": false + } + }, + "evaluationInterval": { + "format": "int32", + "type": "integer" + }, + "delayEvaluation": { + "format": "int32", + "type": "integer" + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TerminationConfiguration": { + "type": "object", + "properties": { + "maxTotalRuns": { + "format": "int32", + "type": "integer" + }, + "maxConcurrentRuns": { + "format": "int32", + "type": "integer" + }, + "maxDurationMinutes": { + "format": "int32", + "type": "integer" + }, + "earlyTerminationPolicyConfiguration": { + "$ref": "#/definitions/EarlyTerminationPolicyConfiguration" + } + } + }, + "EvaluationConfiguration": { + "type": "object", + "properties": { + "primaryMetricName": { + "type": "string" + }, + "primaryMetricGoal": { + "description": "Defines supported metric goals for hyperparameter tuning", + "enum": [ + "Minimize", + "Maximize" + ], + "type": "string", + "x-ms-enum": { + "name": "PrimaryMetricGoal", + "modelAsString": false + } + } + } + }, + "TrialJob": { + "type": "object", + "properties": { + "codeConfiguration": { + "$ref": "#/definitions/CodeConfiguration" + }, + "environmentId": { + "description": "Environment id of the job.", + "type": "string" + }, + "parentRunId": { + "description": "Run ID of the parent job.", + "type": "string" + }, + "snapshotId": { + "format": "uuid", + "description": "Snapshot of the parent run.", + "type": "string" + }, + "user": { + "description": "User creating job", + "type": "string" + } + } + }, + "SweepJob": { + "required": [ + "computeBinding", + "jobType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + }, + { + "type": "object", + "properties": { + "status": { + "description": "The status of a job.", + "enum": [ + "NotStarted", + "Starting", + "Provisioning", + "Preparing", + "Queued", + "Running", + "Finalizing", + "CancelRequested", + "Completed", + "Failed", + "Canceled", + "NotResponding", + "Paused" + ], + "type": "string", + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": false + } + }, + "parameterSamplingConfiguration": { + "$ref": "#/definitions/ParameterSamplingConfiguration" + }, + "terminationConfiguration": { + "$ref": "#/definitions/TerminationConfiguration" + }, + "evaluationConfiguration": { + "$ref": "#/definitions/EvaluationConfiguration" + }, + "trialJob": { + "$ref": "#/definitions/TrialJob" + }, + "experimentName": { + "description": "The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "computeBinding": { + "$ref": "#/definitions/ComputeBinding" + } + } + } + ], + "x-ms-discriminator-value": "Sweep" + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json index 3c283424747c..b9eb42e1b6ce 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json @@ -591,6 +591,12 @@ "schema": { "$ref": "#/definitions/ListWorkspaceQuotas" } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } } }, "x-ms-pageable": { diff --git a/specification/machinelearningservices/resource-manager/readme.md b/specification/machinelearningservices/resource-manager/readme.md index 4870058be3a7..992e0484cd7c 100644 --- a/specification/machinelearningservices/resource-manager/readme.md +++ b/specification/machinelearningservices/resource-manager/readme.md @@ -126,6 +126,7 @@ These settings apply only when `--tag=package-2020-09-01-preview` is specified o ``` yaml $(tag) == 'package-2020-09-01-preview' input-file: - Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json +- Microsoft.MachineLearningServices/preview/2020-09-01-preview/jobs.json ``` ### Tag: package-2020-05-01-preview