Doc sample codes have zero reference to the class itself and its constructor

[aldelar]

The code samples refer to datasets and their respective as_download() methods and so on. No reference at all to the class itself that this doc is about. Very confusing.

---

Document Details

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

• ID: f376be7e-6049-d0db-93a9-2a778dc41fcd
• Version Independent ID: bdc4020e-aad7-056d-16d5-004d27fd5238
• Content: azureml.data.dataset_consumption_config.DatasetConsumptionConfig class - Azure Machine Learning Python
• Content Source: AzureML-Docset/stable/docs-ref-autogen/azureml-core/azureml.data.dataset_consumption_config.DatasetConsumptionConfig.yml
• Service: machine-learning
• Sub-service: core
• GitHub Login: @DebFro
• Microsoft Alias: debfro

[MayMSFT]

Hi Aldelar

What class are you referring to? DatasetConsumptionConfig is the constructor to define how to consume dataset in jobs.
FileDataset class can be found here: https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.data.file_dataset.filedataset?view=azure-ml-py#as-mount-path-on-compute-none-

[aldelar]

As mentioned in my original comment, the page is about this class, but there's no example code using this class/constructor on that page, shouldn't there be? Instead the class is used indirectly coming from dataset.as_named_input('input_1')

But dataset isn't even defined in the sample code. Imagine a non expert user coming to this page, why is this sample code not referencing at all the class this doc page is about?

Either showcase how you also get the dataset, but ideally use the constructor to actually build a config. The code is partial, it only shows the use of the class methods.

Showcase that they are two ways it seems to go about getting a DatasetConsumptionConfig:

• Use the constructor to set the download vs mount, etc. mode
• Use the as_download(), etc. method instead to define the mode on top of a dataset.as_named_input() --> that piece also would need its own explanation... does the named_input() basically returns a DatasetConsumptionConfig? It is, why is that named 'as_named_input()', instead of 'get_dataset_consumption_config()' for instance?

As it is, the doc is cryptic in my opinion. There are quite a few concepts that are glanced over, and the SDK is quite complex, so we should expand on the doc much more than this. It's meant to help a non expert.

I hope that makes sense?