script_run_config Module

  • Reference

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

script_run_config
ScriptRunConfig
Required

The ScriptRunConfig from which to get the run configuration.

Returns

The run configuration.

Return type

RunConfiguration

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

script_run_config
ScriptRunConfig
Required

The configuration information for the run.

workspace
Workspace
Required

A workspace in which to create the experiment.

experiment_name
str
Required

The name of the experiment.

run_id
str
default value: None

An optional ID of the run.

_parent_run_id
str
default value: None

Internal use only.

credential_passthrough
bool
default value: False

Allow remote compute to run with user's credentials.

Returns

A script run object.

Return type

ScriptRun