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.object
PipelineDataset

Constructor

PipelineDataset(dataset=None, name=None, bind_mode='mount', path_on_compute=None, overwrite=False, parameter_name=None)

Parameters

Name Description
dataset

The dataset that will be used as the input to the step.

Default value: None
name
str

The name of the input in the pipeline.

Default value: None
bind_mode
str

How the dataset should be made available, either mount or download.

Default value: mount
path_on_compute
str

The path on the compute where the data will be made available.

Default value: None
overwrite

Whether to overwrite existing data or not.

Default value: False
parameter_name
str

The parameter name of the dataset. This is used for published pipeline.

Default value: None
dataset
Required
Union[<xref:azureml.core.Datase> or AbstractDataset, OutputDatasetConfig]

The dataset that will be used as the input to the step.

name
Required
str

The name of the input in the pipeline.

bind_mode
Required
str

How the dataset should be made available, either mount or download.

path_on_compute
Required
str

The path on the compute where the data will be made available.

overwrite
Required

Whether to overwrite existing data or not.

Methods

create

Create a PipelineDataset from an Azure Machine Learning Dataset.

Note

This method is deprecated. Learn how to use dataset with pipeline, see

https://aka.ms/pipeline-with-dataset.

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

https://aka.ms/pipeline-with-dataset.

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

https://aka.ms/pipeline-with-dataset.

validate_dataset

Validate the state of the dataset.

Note

This method is deprecated. Learn how to use dataset with pipeline, see

https://aka.ms/pipeline-with-dataset.

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

https://aka.ms/pipeline-with-dataset.

static create(dataset, name=None, parameter_name=None)

Parameters

Name Description
dataset
Required

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.

Default value: None
parameter_name
str

The pipeline parameter name.

Default value: None

Returns

Type Description

The created PipelineDataset.

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

https://aka.ms/pipeline-with-dataset.

static default_name(dataset)

Parameters

Name Description
dataset
Required

The dataset to calculate the name from.

Returns

Type Description
str

The name.

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

https://aka.ms/pipeline-with-dataset.

static is_dataset(dset)

Parameters

Name Description
dset
Required

The input.

Returns

Type Description

Whether input is a dataset or a dataset definition.

validate_dataset

Validate the state of the dataset.

Note

This method is deprecated. Learn how to use dataset with pipeline, see

https://aka.ms/pipeline-with-dataset.

It will log a warning if the dataset is deprecated and throws an error if the datasaet is archived.

static validate_dataset(dset)

Parameters

Name Description
dset
Required

The dataset to be verified.

Attributes

bind_mode

Get how the dataset should be made available.

Returns

Type Description
str

The bind mode.

dataset

Get the dataset this input is binded to.

Returns

Type Description

The dataset.

dataset_id

Get the dataset ID.

Returns

Type Description
str

The dataset ID.

dataset_version

Get the dataset definition's version.

Returns

Type Description
str

The dataset version.

name

Get the name of the input.

Returns

Type Description
str

The name.

overwrite

Get value indicating whether to overwrite existing data.

Returns

Type Description

Overwrite or not.

parameter_name

Get the pipeline parameter name of this pipeline dataset.

Returns

Type Description
str

The parameter name.

path_on_compute

Get the path where the data will be made available on the compute.

Returns

Type Description
str

The path on compute.

saved_dataset_id

Return the saved ID of the dataset in the PipelineDataset.

Returns

Type Description
str

The saved ID of the dataset.

workspace

Get the workspace the dataset belongs to.

Returns

Type Description

The workspace.