Azure / Azure/MachineLearningNotebooks
Parameter missing from docs - overwrite parameter & description of behavior missing
- Dominant language
- Jupyter Notebook
- Stars
- 4.4k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Parameter missing from docs - overwrite parameter & description of behavior missing from docstring for FileDatasetFactory.upload_directory
What should I expect if overwrite = True? Overwrite the whole directory, or just duplicate files?
Does the method raise if overwrite is false and a duplicate is found?
---
#### Document Details
⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*
* ID: 091afd7e-72ca-a384-01db-4da4d40a6734
* Version Independent ID: 0f3783bf-ab1f-f0d6-08f3-90becae914e8
* Content: [azureml.data.dataset_factory.FileDatasetFactory class - Azure Machine Learning Python](https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.data.dataset_factory.filedatasetfactory?view=azure-ml-py#from-files-path--validate-true--partition-format-none--is-file-false-)
* Content Source: [AzureML-Docset/stable/docs-ref-autogen/azureml-core/azureml.data.dataset_factory.FileDatasetFactory.yml](https://github.com/MicrosoftDocs/MachineLearning-Python-pr/blob/live/AzureML-Docset/stable/docs-ref-autogen/azureml-core/azureml.data.dataset_factory.FileDatasetFactory.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 the linked FileDatasetFactory reference and the AzureML-Docset/stable/docs-ref-autogen/azureml-core/azureml.data.dataset_factory.FileDatasetFactory.yml source. Check the upload_directory API behavior for overwrite=True and duplicate files when overwrite=False, then update the missing parameter description and expected behavior in the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, machine-learning, python
- Domain
- documentation, machine-learning
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100