Azure / Azure/MachineLearningNotebooks

Improve the documentation

Offen
#1,947 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Jupyter Notebook
Sterne
4.4k
Forks
2.6k
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Hi, I have two comments that can improve the documentation:
1- Please indicate in the page on the top whether it is for SDK V1 or V2. If it is in the page, I didn't notice it. Somewhere on the top will be better.
2- For each method or class, please include link to the examples, so that it is easy to follow without further search. Examples are the Pandas Python library that has examples (https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.merge.html).

---
#### Document Details

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

* ID: 1b905f15-6470-b8cf-0963-efb5c16a848d
* Version Independent ID: 02bcf9a3-057d-b4e4-3f6d-acbe8a689ba8
* Content: [azureml.core.dataset.Dataset class - Azure Machine Learning Python](https://learn.microsoft.com/en-us/python/api/azureml-core/azureml.core.dataset.dataset?view=azure-ml-py)
* Content Source: [AzureML-Docset/stable/docs-ref-autogen/azureml-core/azureml.core.dataset.Dataset.yml](https://github.com/MicrosoftDocs/MachineLearning-Python-pr/blob/live/AzureML-Docset/stable/docs-ref-autogen/azureml-core/azureml.core.dataset.Dataset.yml)
* Service: **machine-learning**
* Sub-service: **core**
* GitHub Login: @DebFro
* Microsoft Alias: **debfro**

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginnen Sie mit der verlinkten Learn-Seite für azureml.core.dataset.Dataset und deren Quelle AzureML-Docset/stable/docs-ref-autogen/azureml-core/azureml.core.dataset.Dataset.yml. Prüfen Sie, wie SDK-Versionsbezeichnungen und Beispiel-Links in der generierten Referenzdokumentation dargestellt werden. Als abgeschlossen gilt die Aufgabe, wenn die relevante Dokumentation die SDK-Version nahe am Anfang angibt und Beispiel-Links für die angeforderten Methoden oder Klassen bereitstellt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
azure, python
Bereich
documentation, machine-learning
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.