Improve the documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- azure, python
- Domain
- documentation, machine-learning
Research direction
Start with the linked Learn page for azureml.core.dataset.Dataset and its source, AzureML-Docset/stable/docs-ref-autogen/azureml-core/azureml.core.dataset.Dataset.yml. Check how SDK version labels and example links are represented in the generated reference documentation. Done means the relevant documentation identifies the SDK version near the top and provides example links for the requested methods or classes.
Written by the indexing model from the issue text.
Description
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
- Content Source: 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
- Dominant language
- Jupyter Notebook
- Stars
- 4.4k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Azure/MachineLearningNotebooks
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Azure/MachineLearningNotebooks#1975 · 1 comment ·
-
duplicates Open
Difficulty 1/5 Under an hour Newbie friendliness 68/100
Azure/MachineLearningNotebooks#1960 ·
-
machine Open
Difficulty 5/5 Over a week Newbie friendliness 10/100
Azure/MachineLearningNotebooks#1987 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
Azure/MachineLearningNotebooks#1985 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
Azure/MachineLearningNotebooks#1981 · 1 reaction ·
All issues in Azure/MachineLearningNotebooks
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
palladius/rails8-app-on-gcp#145 ·
-
NeedsTriage
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
error Open
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
textual definition
Difficulty 1/5 Under an hour Newbie friendliness 90/100
geneontology/go-ontology#32653 ·