OutputPortDef class

Definition

Definition of an output port.

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)
Inheritance
builtins.object
OutputPortDef

Parameters

name
str

Name of the output port.

default_datastore_name
str

The default data store to write this output to.

default_datastore_mode
str

The default mode for producing output, either "mount" or "upload".

default_path_on_compute
str

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

is_directory
bool

True if the output is a directory of files, False for a single file (default: False).

data_type
str

The data type to apply to this output. If unspecified, use a default based on is_directory.

default_overwrite
bool

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

training_output
TrainingOutput or optional

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.

label
str

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

The datatype.

Return type

str

default_datastore_mode

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

Returns

The default datastore mode.

Return type

str

default_datastore_name

Get the default data store to write this output to.

Returns

The default datastore name.

Return type

str

default_overwrite

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

Returns

The default_overwrite property of the OutputPortDef.

Return type

default_path_on_compute

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

Returns

The default path on compute.

Return type

str

is_directory

Return True if the output is a directory of files, False for a single file (default -- False).

Returns

The is_directory property of the OutputPortDef.

Return type

label

Get the label of the port.

Returns

The label of the port.

Return type

str

name

Get the name of the output port.

Returns

The name of the output port.

Return type

str

training_output

Get training output.

Returns

Training output

Return type