compute_target Module

Contains functionality for compute targets not managed by Azure Machine Learning.

Compute targets define your training compute environment, and can be either local, or remote resources in the cloud. Remote resources allow you to easily scale up or scale out your machine learning experimentation by taking advantage of accelerated CPU and GPU processing capabilities.

For information on compute targets managed by Azure Machine Learning, see the ComputeTarget class. For more information, see What are compute targets in Azure Machine Learning?

Classes

AbstractComputeTarget

An abstract class for compute targets not managed by Azure Machine Learning.

Class AbstractComputeTarget constructor.

LocalTarget

A class to define the local machine as a compute target.

Set up local target.

Functions

attach_legacy_compute_target

Attaches a compute target to this project.

attach_legacy_compute_target(experiment, source_directory, compute_target)

Parameters

Name Description
experiment
Required
source_directory
Required
str
compute_target
Required
str

A compute target object to attach.

Returns

Type Description

None if the attach is successful, otherwise throws an exception.

is_compute_target_prepared

Check compute target is prepared.

Checks whether the compute target, specified in run_config, is already prepared or not for the specified run configuration.

is_compute_target_prepared(experiment, source_directory, run_config)

Parameters

Name Description
experiment
Required
source_directory
Required
str
run_config
Required

The run configuration. This can be a run configuration name, as string, or a azureml.core.runconfig.RunConfiguration object.

Returns

Type Description

True, if the compute target is prepared.

prepare_compute_target

Prepare the compute target.

Installs all the required packages for an experiment run based on run_config and custom_run_config.

prepare_compute_target(experiment, source_directory, run_config)

Parameters

Name Description
experiment
Required
source_directory
Required
str
run_config
Required

The run configuration. This can be a run configuration name, as string, or a azureml.core.runconfig.RunConfiguration object.

Returns

Type Description

A run object

remove_legacy_compute_target

Remove a compute target from the project.

remove_legacy_compute_target(experiment, source_directory, compute_target_name)

Parameters

Name Description
experiment
Required
source_directory
Required
str
compute_target_name
Required
str

Returns

Type Description

None if the removal of the compute target is successful, otherwise throws an exception.