Sign in

v2

latestSwagger 2.0raw.githubusercontent.com2019-10-0841927.1 KB
Execution

Start a run from a snapshot on a remote compute target.

Starts an experiment run on the remote compute target using the provided definition.json file to define the run. The code for the run is retrieved using the snapshotId in definition.json.

post/execution/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/snapshotrun

Path parameters

subscriptionIdstring uuid required

The Azure Subscription ID.

resourceGroupNamestring required

The Name of the resource group in which the workspace is located.

workspaceNamestring required

The name of the workspace.

experimentNamestring required

The experiment name.

Query parameters

runIdstring

A run id. If not supplied a run id will be created automatically.

Request body

snapshotIdstring uuid

Snapshots are user project folders that have been uploaded to the cloud for subsequent execution. This field is required when executing against cloud-based compute targets unless the run submission was against the API endpoint that takes a zipped project folder inline with the request.

parentRunIdstring

Specifies that the run history entry for this execution should be scoped within an existing run as a child. Defaults to null, meaning the run has no parent. This is intended for first-party service integration, not third-party API users.

runTypestring

Specifies the runsource property for this run. The default value is "experiment" if not specified.

Example request

{
  "configuration": {
    "script": "findsquare.py",
    "framework": "Python",
    "communicator": "None",
    "target": "amlcompute",
    "jobName": "FindSquaresJob",
    "environment": {
      "name": "mydevenvironment",
      "version": "1",
      "docker": {
        "baseImage": "ubuntu:latest",
        "baseDockerfile": "FROM ubuntu:latest\r\nRUN echo \"Hello world!\""
      },
      "inferencingStackVersion": "latest"
    }
  },
  "parentRunId": "myexperiment_155000000001_0",
  "runType": "experiment"
}

Response

A snapshot run was successfully started.

runIdstring required

The identifier for a run.

Example response

{
  "runId": "myexperiment_155000000001_0"
}