Skip to content

Contradiction in Doc for compute_target #1481

Open
@aldelar

Description

@aldelar

compute_target
Union[xref:azureml.core.compute.DsvmCompute,azureml.core.compute.AmlCompute,azureml.core.compute.RemoteCompute,azureml.core.compute.HDInsightCompute,str,tuple]
[Required] The compute target to use. If unspecified, the target from the runconfig will be used. This parameter may be specified as a compute target object or the string name of a compute target on the workspace. Optionally if the compute target is not available at pipeline creation time, you may specify a tuple of ('compute target name', 'compute target type') to avoid fetching the compute target object (AmlCompute type is 'AmlCompute' and RemoteCompute type is 'VirtualMachine').

PROBLEM: It's a [Required] parameter. So how could there be a note like 'If unspecified, the target of the runconfig will be used....'.
I tested it, if you do not specify it it fails, even with a runconfig which has a compute_target defined.

error: executionId [453eac96]: Assignment for parameter Target is not specified

So the doc is incorrect here.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Metadata

Metadata

Assignees

No one assigned

    Labels

    ADOIssue is documented on MSFT ADO for internal trackingPipelinesdoc-bug

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions