PipelineDataset Class
Acts as an adapter for Dataset and Pipeline.
Note
This class is deprecated. Learn how to use dataset with pipeline, see https://aka.ms/pipeline-with-dataset.
This is an internal class. You should not create this class directly but rather call the as_* instance methods on the Dataset or the OutputDatasetConfig classes.
Act as an adapter for Dataset and Pipeline.
This is an internal class. You should not create this class directly but rather call the as_* instance methods on the Dataset or the OutputDatasetConfig classes.
- Inheritance
-
builtins.objectPipelineDataset
Constructor
PipelineDataset(dataset=None, name=None, bind_mode='mount', path_on_compute=None, overwrite=False, parameter_name=None)
Parameters
- bind_mode
- str
How the dataset should be made available, either mount or download.
- path_on_compute
- str
The path on the compute where the data will be made available.
- parameter_name
- str
The parameter name of the dataset. This is used for published pipeline.
- dataset
- Union[<xref:azureml.core.Datase> or AbstractDataset, OutputDatasetConfig]
The dataset that will be used as the input to the step.
Methods
create |
Create a PipelineDataset from an Azure Machine Learning Dataset. Note This method is deprecated. Learn how to use dataset with pipeline, see |
default_name |
Get the default port name of a dataset/dataset definition. Note This method is deprecated. Learn how to use dataset with pipeline, see |
is_dataset |
Determine whether the input is a dataset or a dataset definition. Note This method is deprecated. Learn how to use dataset with pipeline, see |
validate_dataset |
Validate the state of the dataset. Note This method is deprecated. Learn how to use dataset with pipeline, see It will log a warning if the dataset is deprecated and throws an error if the datasaet is archived. |
create
Create a PipelineDataset from an Azure Machine Learning Dataset.
Note
This method is deprecated. Learn how to use dataset with pipeline, see
static create(dataset, name=None, parameter_name=None)
Parameters
- dataset
- Union[Dataset, DatasetConsumptionConfig, PipelineDataset]
The dataset to create the PipelineDataset from.
- name
- str
The name of the input dataset. If None, a name will be derived based on the type of the input.
Returns
The created PipelineDataset.
Return type
default_name
Get the default port name of a dataset/dataset definition.
Note
This method is deprecated. Learn how to use dataset with pipeline, see
static default_name(dataset)
Parameters
Returns
The name.
Return type
is_dataset
Determine whether the input is a dataset or a dataset definition.
Note
This method is deprecated. Learn how to use dataset with pipeline, see
static is_dataset(dset)
Parameters
Returns
Whether input is a dataset or a dataset definition.
Return type
validate_dataset
Validate the state of the dataset.
Note
This method is deprecated. Learn how to use dataset with pipeline, see
It will log a warning if the dataset is deprecated and throws an error if the datasaet is archived.
static validate_dataset(dset)
Parameters
Attributes
bind_mode
dataset
Get the dataset this input is binded to.
Returns
The dataset.
Return type
dataset_id
dataset_version
name
overwrite
parameter_name
Get the pipeline parameter name of this pipeline dataset.
Returns
The parameter name.
Return type
path_on_compute
Get the path where the data will be made available on the compute.
Returns
The path on compute.
Return type
saved_dataset_id
Return the saved ID of the dataset in the PipelineDataset.
Returns
The saved ID of the dataset.
Return type
workspace
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for