ScriptRun class

Definition

An experiment run class to handle and monitor script runs associated with an Experiment and individual run id.

ScriptRun(experiment, run_id, directory=None, _run_config=None, **kwargs)
Inheritance
azureml._run_impl.run_base._RunBase
ScriptRun

Parameters

experiment
Experiment

The experiment object

run_id
str

Run id.

directory
str

The source directory

_run_config
RunConfiguration
kwargs
dict

Remarks

The Azure Machine Learning SDK provides you with a series of interconnected classes, that are designed to help you train and compare machine learning models that are related by the shared problem that they are solving.

An Experiment acts as a logical container for these training runs. A RunConfiguration object is used to codify the information necessary to submit a training run in an experiment. A ScriptRunConfig object is a helper class that packages the RunConfiguration object with an execution script for training; see the python code example in the documentation for RunConfiguration for an example of a ScriptRunConfig object in action.

A ScriptRunConfig object is used to submit a training run as part of an Experiment When a training run is submitted using a ScriptRunConfig object, the submit method returns an object of type ScriptRun.

A ScriptRun object gives you programmatic access to information about the associated training run. Some examples include retrieving the logs corresponding to a run, canceling a run if it's still in progress, cleaning up the artifacts of a completed run, and waiting for completion of a run currently in progress.

Methods

cancel()

Cancel the ongoing run.

cancel()

Cancel the ongoing run.

cancel()

Attributes

RUN_TYPE

RUN_TYPE = 'azureml.scriptrun'