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 the configuration information needed to submit a run in Azure ML, including the script, compute target, environment, and any distributed job-specific configs. Once a script run is configured and submitted with the submit, a ScriptRun is returned. Class ScriptRunConfig constructor.

Functions

get_run_config_from_script_run

Get the RunConfiguration object with parameters copied from the ScriptRunConfig.

get_run_config_from_script_run(script_run_config)

Parameters

Name	Description
script_run_config Required	ScriptRunConfig The ScriptRunConfig from which to get the run configuration.

Returns

Type	Description
RunConfiguration	The run configuration.

submit

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, credential_passthrough=False)

Parameters

Name	Description
script_run_config Required	ScriptRunConfig The configuration information for the run.
workspace Required	Workspace A workspace in which to create the experiment.
experiment_name Required	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
credential_passthrough	bool Allow remote compute to run with user's credentials. default value: False

Returns

Type	Description
ScriptRun	A script run object.