script_run_config module

Contains functionality to manage configuration for submitting training runs in Azure Machine Learning.

Classes

ScriptRunConfig

Represents configuration information for submitting a training run in Azure Machine Learning.

A ScriptRunConfig packages together environment configuration of RunConfiguration with a script for training to create a script run. In most typical scenarios, you will create a ScriptRunConfig object and then access RunConfiguration with the get_run_config_from_script_run(script_run_config) function.

Once a script run is configured and submitted with the submit(config, tags=None, **kwargs) method or with the submit(script_run_config, workspace, experiment_name, run_id=None, _parent_run_id=None) function, a ScriptRun is returned.

For examples of run configurations, see Select and use a compute target to train your model.

Functions

get_run_config_from_script_run(script_run_config)

Get the RunConfiguration object with parameters copied from the ScriptRunConfig.

get_run_config_from_script_run(script_run_config)

Parameters

script_run_config
ScriptRunConfig

The ScriptRunConfig from which to get the run configuration.

Returns

The run configuration.

Return type

submit(script_run_config, workspace, experiment_name, run_id=None, _parent_run_id=None)

Submit and return a script run.

This function creates an Experiment, applies the run configuration, submits the run, and returns a ScriptRun object.

submit(script_run_config, workspace, experiment_name, run_id=None, _parent_run_id=None)

Parameters

script_run_config
ScriptRunConfig

The configuration information for the run.

workspace
Workspace

A workspace in which to create the experiment.

experiment_name
str

The name of the experiment.

run_id
str

An optional ID of the run.

default value: None
_parent_run_id
str

Internal use only.

default value: None

Returns

A script run object.

Return type