Azure / Azure/MachineLearningNotebooks

Contradiction in Doc for compute_target

Open
#1,481 0 comments 0 reactions 0 assignees View on GitHub
ADO doc-bug Pipelines
Dominant language
Jupyter Notebook
Stars
4.4k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

compute_target
Union[]
[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.*

* ID: 76f6fde8-6396-f360-78c8-97970f5b0a4b
* Version Independent ID: 060905ce-7ab4-2052-6f35-7b1c14c1e581
* Content: [azureml.pipeline.steps.PythonScriptStep class - Azure Machine Learning Python](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-steps/azureml.pipeline.steps.pythonscriptstep?view=azure-ml-py)
* Content Source: [AzureML-Docset/stable/docs-ref-autogen/azureml-pipeline-steps/azureml.pipeline.steps.PythonScriptStep.yml](https://github.com/MicrosoftDocs/MachineLearning-Python-pr/blob/live/AzureML-Docset/stable/docs-ref-autogen/azureml-pipeline-steps/azureml.pipeline.steps.PythonScriptStep.yml)
* Service: **machine-learning**
* Sub-service: **core**
* GitHub Login: @DebFro
* Microsoft Alias: **debfro**

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.