ModuleDef Class

  • Reference

Definition of a module including execution and port definitions.

Initialize ModuleDef.

Inheritance
builtins.object
ModuleDef

Constructor

ModuleDef(name, description=None, input_port_defs=None, output_port_defs=None, param_defs=None, module_execution_type=None, create_sequencing_ports=True, allow_reuse=True, version=None, module_type=None, step_type=None, arguments=None, runconfig=None, cloud_settings=None)

Parameters

name
str
Required

The name of the module.

description
str
default value: None

The description of the module.

input_port_defs
list
default value: None

A list of the module input port definitions.

output_port_defs
list
default value: None

A list of the module output port definitions.

param_defs
list
default value: None

A list of parameter definitions.

module_execution_type
str
default value: None

The module execution type.

create_sequencing_ports
bool
default value: True

Specifies whether to create sequencing ports or not.

allow_reuse
bool
default value: True

Specifies whether to allow reuse. The default is True.

version
str
default value: None

The module version.

module_type
str
default value: None

The module type. Two values are supported: "None" and "BatchInferencing".

step_type
str
default value: None

Type of step associated with this module, e.g. "PythonScriptStep", "HyperDriveStep", etc.

arguments
list
default value: None

Annotated arguments list to use when calling this module

runconfig
str
default value: None

Runconfig that will be used for python_script_step

cloud_settings
<xref:azureml.pipeline.core._restclients.aeva.models.CloudSettings>
default value: None

Settings that will be used for clouds

name
str
Required

The name of the module.

description
str
Required

The description of the module.

input_port_defs
list
Required

A list of the module input port definitions.

output_port_defs
list
Required

A list of the module output port definitions.

param_defs
list
Required

A list of parameter definitions.

module_execution_type
str
Required

The module execution type.

create_sequencing_ports
bool
Required

Specifies whether to create sequencing ports or not.

allow_reuse
bool
Required

Specifies whether to allow reuse.

version
str
Required

The module version.

module_type
str
Required

The module type. Two values are supported: "None" and "BatchInferencing".

step_type
str
Required

Type of step associated with this module, e.g. "PythonScriptStep", "HyperDriveStep", etc.

arguments
list
Required

Annotated arguments list to use when calling this module

runconfig
str
Required

Runconfig that will be used for python_script_step

cloud_settings
<xref:azureml.pipeline.core._restclients.aeva.models.CloudSettings>
Required

Settings that will be used for clouds

Methods

add_fake_sequencing_input_port

Add fake input ports for sequencing.
calculate_hash

Calculate the module hash.

add_fake_sequencing_input_port

Add fake input ports for sequencing.

add_fake_sequencing_input_port()

Returns

The fake input port.

Return type

InputPortDef

calculate_hash

Calculate the module hash.

calculate_hash()

Returns

The hexdigest hash.

Return type

str

Attributes

allow_reuse

Specify whether to allow module reuse.

Returns

The allow reuse property.

Return type

bool

cloud_settings

Get cloud_settings.

:return The cloud_settings. :rtype: str

description

Get the description of the Module.

Returns

The description string.

Return type

str

input_port_defs

Get the input port definitions of the Module.

Returns

The list of InputPortDefs.

Return type

list

module_execution_type

Get the module execution type.

Returns

The module execution type.

Return type

str

module_type

Get module type.

Two values are supported: "None" and "BatchInferencing".

Returns

The module type.

Return type

str

name

Name of the Module.

Returns

The name.

Return type

str

output_port_defs

Get the output port definitions of the Module.

Returns

The list of OutputPortDefs.

Return type

list

param_defs

Get the parameter definitions of the Module.

Returns

The list of ParamDefs.

Return type

list

runconfig

Get runconfig.

:return The runconfig. :rtype: str

step_type

Get step type.

Example values are "PythonScriptStep", "HyperDriveStep", "ModuleStep".

Returns

The step type.

Return type

str

fake_input_prefix 

fake_input_prefix = '_run_after_input_'

fake_output_name 

fake_output_name = '_run_after_output'