OutputPortDef Class
Definition of an output port.
Create an output port.
- Inheritance
-
builtins.objectOutputPortDef
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
|
Name of the output port. |
default_datastore_name
|
The default data store to write this output to. default value: None
|
default_datastore_mode
|
The default mode for producing output, either "mount" or "upload". default value: None
|
default_path_on_compute
|
For "upload" mode, the path to which the module writes to during execution. default value: None
|
is_directory
|
True if the output is a directory of files, False for a single file (default: False). default value: False
|
data_type
|
The data type to apply to this output. If unspecified, use a default based on default value: None
|
default_overwrite
|
For "upload" mode, indicate whether to overwrite existing data. default value: None
|
training_output
|
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
|
The optional label of the output port, which acts as a short description for the port. default value: None
|
name
Required
|
Name of the output port. |
default_datastore_name
Required
|
The default data store to write this output to. |
default_datastore_mode
Required
|
The default mode for producing output, either "mount" or "upload". |
default_path_on_compute
Required
|
For "upload" mode, the path to which the module writes to during execution. |
is_directory
Required
|
True if the output is a directory of files, False for a single file (default: False). |
data_type
Required
|
The data type to apply to this output.
If unspecified, use a default based on |
default_overwrite
Required
|
For "upload" mode, indicate whether to overwrite existing data. |
training_output
Required
|
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 |
---|---|
The datatype. |
default_datastore_mode
Get the default mode for producing output, either "mount" or "upload" (local file which is uploaded).
Returns
Type | Description |
---|---|
The default datastore mode. |
default_datastore_name
Get the default data store to write this output to.
Returns
Type | Description |
---|---|
The default datastore name. |
default_overwrite
For "upload" mode, indicate whether to overwrite existing data.
Returns
Type | Description |
---|---|
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 |
---|---|
The default path on compute. |
is_directory
Return a boolean indicating whether the output is a directory of files.
Returns
Type | Description |
---|---|
The |
label
name
training_output
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