Azure / Azure/MachineLearningNotebooks
Please provide better documentation for diagnose_workspace
- Linguagem predominante
- Jupyter Notebook
- Estrelas
- 4.4k
- Forks
- 2.6k
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
On page https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.workspace(class)?view=azure-ml-py#diagnose-workspace-diagnose-parameters- .
For method `Workspace.diagnose_workspace`, there is required parameter `diagnose_parameters`. For this the following explanation is provided: "The parameter of diagnosing workspace health".
This explains nothing about what sort of input is expected and in which format. Please clarify this.
---
#### Document Details
⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*
* ID: 90efe042-27ac-6e77-9292-10df77bb1c36
* Version Independent ID: 3b9f2576-7d3f-00f8-0afe-549960520f08
* Content: [azureml.core.Workspace class - Azure Machine Learning Python](https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.workspace(class)?view=azure-ml-py#attributes)
* Content Source: [AzureML-Docset/stable/docs-ref-autogen/azureml-core/azureml.core.Workspace(class).yml](https://github.com/MicrosoftDocs/MachineLearning-Python-pr/blob/live/AzureML-Docset/stable/docs-ref-autogen/azureml-core/azureml.core.Workspace(class).yml)
* Service: **machine-learning**
* Sub-service: **core**
* GitHub Login: @DebFro
* Microsoft Alias: **debfro**
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Direção de pesquisa
Abra AzureML-Docset/stable/docs-ref-autogen/azureml-core/azureml.core.Workspace(class).yml e encontre a entrada diagnose_workspace diagnose_parameters. Determine e documente a entrada e o formato esperados para esse parâmetro obrigatório e, em seguida, verifique se a página da API de Workspace gerada o explica claramente.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- azure, python
- Domínio
- documentation, machine-learning
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Claramente especificada
- Facilidade para iniciantes
- 45/100