ScriptRunConfig class

Definition

A class for setting up configurations for script runs. Type: ChainedIdentity.

ScriptRunConfig(source_directory, script=None, arguments=None, run_config=None, _telemetry_values=None)
Inheritance
builtins.object
azureml._logging.chained_identity.ChainedIdentity
ScriptRunConfig

Parameters

source_directory
str
script
str
arguments
<xref:azureml.core.list>
run_config
RunConfiguration
_telemetry_values
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; the returned ScriptRun object gives you programmatic access to information about the training run. ScriptRun is a child class of Run.

The key concept to remember is that there are different configuration objects that are used to submit an experiment, based on what kind of run you want to trigger (script run, automl run, pipeline, published pipeline, etc). The type of the configuration object then informs what child class of Run you get back from the submit method. When we pass a ScriptRunConfig object in a call to Experiment's submit method, we get back a ScriptRun object.