Azure / azure-sdk-for-python

This repository is for active development of the Azure SDK for Python. For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/python/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-python.
MIT License
4.36k stars 2.71k forks source link

we maybe need to clarify what we can specify at `settings` parameter. #34211

Open KazuOnuki opened 4 months ago

KazuOnuki commented 4 months ago

Type of issue

Missing information

Description

settings parameter type is Dict, so we actually don't know what we can specify key/value at settings parameter. I assume this parameter key/value is showed at PipelineJobSettings, however some people can't understand what they set this parameter because this parameter type is Dict not PipelineJobSettings.

Page URL

https://learn.microsoft.com/en-us/python/api/azure-ai-ml/azure.ai.ml.entities.pipelinecomponentbatchdeployment?view=azure-python

Content source URL

https://github.com/MicrosoftDocs/azure-docs-sdk-python/blob/main/docs-ref-autogen/azure-ai-ml/azure.ai.ml.entities.PipelineComponentBatchDeployment.yml

Document Version Independent Id

c976e889-7896-e593-f8ec-a63e8ff196e6

Article author

@lmazuel

Metadata

mccoyp commented 4 months ago

Hi @KazuOnuki, thank you for opening this issue; I'll get this routed to the ML team so they can take a look. cc @azureml-github

github-actions[bot] commented 4 months ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @Azure/azure-ml-sdk @azureml-github.

KazuOnuki commented 4 months ago

@eniac871 would u pls check it? if you would think it's fix isn't needed in the future, please close it.

eniac871 commented 4 months ago

@santiagxf could you please take a look? Customer is asking about batch deployment settings