OutputPortDef Class

Definition of an output port.

Create an output port.

Inheritance

builtins.object

OutputPortDef

Constructor

OutputPortDef(name, default_datastore_name=None, default_datastore_mode=None, default_path_on_compute=None, is_directory=False, data_type=None, default_overwrite=None, training_output=None, label=None)

Parameters

Name	Description
name Required	str Name of the output port.
default_datastore_name	str The default data store to write this output to. default value: None
default_datastore_mode	str The default mode for producing output, either "mount" or "upload". default value: None
default_path_on_compute	str For "upload" mode, the path to which the module writes to during execution. default value: None
is_directory	bool True if the output is a directory of files, False for a single file (default: False). default value: False
data_type	str The data type to apply to this output. If unspecified, use a default based on is_directory. default value: None
default_overwrite	bool For "upload" mode, indicate whether to overwrite existing data. default value: None
training_output	TrainingOutput Defines output for training result. This is needed only for specific trainings which result in different kinds of outputs such as Metrics and Model. For example, AutoMLStep results in metrics and model. You can also define specific training iteration or metric used to get best model. For HyperDriveStep, you can also define the specific model files to be included in the output. default value: None
label	str The optional label of the output port, which acts as a short description for the port. default value: None
name Required	str Name of the output port.
default_datastore_name Required	str The default data store to write this output to.
default_datastore_mode Required	str The default mode for producing output, either "mount" or "upload".
default_path_on_compute Required	str For "upload" mode, the path to which the module writes to during execution.
is_directory Required	bool True if the output is a directory of files, False for a single file (default: False).
data_type Required	str The data type to apply to this output. If unspecified, use a default based on is_directory.
default_overwrite Required	bool For "upload" mode, indicate whether to overwrite existing data.
training_output Required	TrainingOutput Defines output for training result. This is needed only for specific trainings which result in different kinds of outputs such as Metrics and Model. For example, AutoMLStep results in metrics and model. You can also define specific training iteration or metric used to get best model. For HyperDriveStep, you can also define the specific model files to be included in the output.
label Required	The optional label of the output port, which acts as a short description for the port.

Attributes

data_type

Datatype to apply to this output. If unspecified, use a default based on is_directory.

Returns

Type	Description
str	The datatype.

default_datastore_mode

Get the default mode for producing output, either "mount" or "upload" (local file which is uploaded).

Returns

Type	Description
str	The default datastore mode.

default_datastore_name

Get the default data store to write this output to.

Returns

Type	Description
str	The default datastore name.

default_overwrite

For "upload" mode, indicate whether to overwrite existing data.

Returns

Type	Description
bool	The default_overwrite property of the OutputPortDef.

default_path_on_compute

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

Returns

Type	Description
str	The default path on compute.

is_directory

Return a boolean indicating whether the output is a directory of files.

Returns

Type	Description
bool	The is_directory property of the OutputPortDef. True if the output is a directory of files; otherwise, False for a single file.

label

Get the label of the port.

Returns

Type	Description
str	The label of the port.

name

Get the name of the output port.

Returns

Type	Description
str	The name of the output port.

training_output

Get training output.

Returns

Type	Description
TrainingOutput	Training output.