Azure / Azure/MachineLearningNotebooks
<<Customer Feedback>> Could we please rectify the doc for clarity
- Dominant language
- Jupyter Notebook
- Stars
- 4.4k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
[Enter feedback here]
The documentation states that "cloud" and "identity_config" parameters are required, but all examples in the documentation are without these parameters (and normally, they do not need to be supplied so they are not really required parameters). Also, it is stated that "Check the documentation for your hosting environment to learn what values it expects". But I was not able to find the information for AKS clusters, which could be failure on my side.
---
#### Document Details
⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*
* ID: aeee5fbb-56db-817e-f095-928ea13e478e
* Version Independent ID: 10f2c77a-1dd7-29bb-7e04-c57885c39813
* Content: [azureml.core.authentication.MsiAuthentication class - Azure Machine Learning Python](https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.authentication.msiauthentication?view=azure-ml-py)
* Content Source: [AzureML-Docset/stable/docs-ref-autogen/azureml-core/azureml.core.authentication.MsiAuthentication.yml](https://github.com/MicrosoftDocs/MachineLearning-Python-pr/blob/live/AzureML-Docset/stable/docs-ref-autogen/azureml-core/azureml.core.authentication.MsiAuthentication.yml)
* Service: **machine-learning**
* Sub-service: **core**
* GitHub Login: @DebFro
* Microsoft Alias: **debfro**
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with AzureML-Docset/stable/docs-ref-autogen/azureml-core/azureml.core.authentication.msiauthentication.yml and compare it with the linked MsiAuthentication documentation page. Check the descriptions of the cloud and identity_config parameters and the hosting-environment guidance, including whether AKS information is present. Done means the documentation accurately identifies optional parameters and explains where to find the expected values.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, python
- Domain
- documentation, machine-learning
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100