InputPortDef Class

Definition of an input port.

Create an input port.

Inheritance

builtins.object

InputPortDef

Constructor

InputPortDef(name, data_types=None, default_datastore_mode=None, default_path_on_compute=None, is_optional=False, default_overwrite=None, default_data_reference_name=None, is_resource=False, label=None, additional_transformations=None, **kwargs)

Parameters

Name	Description
name Required	str Name of the input port.
data_types	list List of datatypes to allow as input ("AnyFile" or "AnyDirectory"). Default value: None
default_datastore_mode	str Default mode to access the data store data ("mount" or "download"). Default value: None
default_path_on_compute	str For "download" mode, the path to which the module reads from during execution. Default value: None
is_optional	bool Set to true if the input is optional. Default value: False
default_overwrite	bool For "download" mode, indicate whether to overwrite existing data. Default value: None
default_data_reference_name	str Default name of the data reference. Default value: None
is_resource	bool Indicate whether input is a resource. Resources are downloaded to the script folder and provide a way to change the behavior of script at run-time. Default value: False
label	str Label of the output port, acts as a short description for the port. Default value: None
additional_transformations	<xref:azureml.dataprep.Dataflow> Additional transformations to apply to the input dataset. Default value: None
name Required	str Name of the input port.
data_types Required	list List of data types to allow as input.
default_datastore_mode Required	str Default mode to access the data store data ("mount" or "download").
default_path_on_compute Required	str For "download" mode, the path to which the module reads from during execution.
is_optional Required	bool Set to true if the input is optional.
default_overwrite Required	bool For "download" mode, indicate whether to overwrite existing data.
default_data_reference_name Required	str Default name of the data reference.
is_resource Required	bool Indicate whether input is a resource. Resources are downloaded to the script folder and provide a way to change the behavior of script at run-time.
label Required	str Label of the output port, acts as a short description for the port.
additional_transformations Required	<xref:azureml.dataprep.Dataflow> Additional transformations to apply to the input dataset.

Attributes

additional_transformations

Get the additional transformations that will be applied to the dataset.

Returns

Type	Description
<xref:azureml.dataprep.Dataflow>	The additional transformations that will be applied to the dataset.

data_types

Get the list of DataTypes allowed as input.

Returns

Type	Description
list	The list of DataTypes.

default_data_reference_name

Get the default name of the data reference.

Returns

Type	Description
str	The default data reference name.

default_datastore_mode

Get the default mode for producing output.

Either "mount" (mounted drive) or "download" (download the data to a local path).

Returns

Type	Description
str	The default datastore mode.

default_overwrite

Indicate whether to overwrite existing data.

Returns

Type	Description
bool	The default overwrite value.

default_path_on_compute

For "download" mode, the path to which the module writes this output during execution.

Returns

Type	Description
str	The default path on compute.

is_optional

Indicate whether to the input port is optional.

Returns

Type	Description
bool	The is_optional property of the InputPortDef.

is_resource

Get whether input is a resource.

Returns

Type	Description
bool	Is input a resource.

label

Get the label of the port.

Returns

Type	Description
str	The label of the port.

name

Get the name of the input port.

Returns

Type	Description
str	The name of the input port.