ModuleDef Class

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 Description
name
Required
str

The name of the module.

description
str

The description of the module.

Default value: None
input_port_defs

A list of the module input port definitions.

Default value: None
output_port_defs

A list of the module output port definitions.

Default value: None
param_defs

A list of parameter definitions.

Default value: None
module_execution_type
str

The module execution type.

Default value: None
create_sequencing_ports

Specifies whether to create sequencing ports or not.

Default value: True
allow_reuse

Specifies whether to allow reuse. The default is True.

Default value: True
version
str

The module version.

Default value: None
module_type
str

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

Default value: None
step_type
str

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

Default value: None
arguments

Annotated arguments list to use when calling this module

Default value: None
runconfig
str

Runconfig that will be used for python_script_step

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

Settings that will be used for clouds

Default value: None
name
Required
str

The name of the module.

description
Required
str

The description of the module.

input_port_defs
Required

A list of the module input port definitions.

output_port_defs
Required

A list of the module output port definitions.

param_defs
Required

A list of parameter definitions.

module_execution_type
Required
str

The module execution type.

create_sequencing_ports
Required

Specifies whether to create sequencing ports or not.

allow_reuse
Required

Specifies whether to allow reuse.

version
Required
str

The module version.

module_type
Required
str

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

step_type
Required
str

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

arguments
Required

Annotated arguments list to use when calling this module

runconfig
Required
str

Runconfig that will be used for python_script_step

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

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

Type Description

The fake input port.

calculate_hash

Calculate the module hash.

calculate_hash()

Returns

Type Description
str

The hexdigest hash.

Attributes

allow_reuse

Specify whether to allow module reuse.

Returns

Type Description

The allow reuse property.

cloud_settings

Get cloud_settings.

:return The cloud_settings. :rtype: str

description

Get the description of the Module.

Returns

Type Description
str

The description string.

input_port_defs

Get the input port definitions of the Module.

Returns

Type Description

The list of InputPortDefs.

module_execution_type

Get the module execution type.

Returns

Type Description
str

The module execution type.

module_type

Get module type.

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

Returns

Type Description
str

The module type.

name

Name of the Module.

Returns

Type Description
str

The name.

output_port_defs

Get the output port definitions of the Module.

Returns

Type Description

The list of OutputPortDefs.

param_defs

Get the parameter definitions of the Module.

Returns

Type Description

The list of ParamDefs.

runconfig

Get runconfig.

:return The runconfig. :rtype: str

step_type

Get step type.

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

Returns

Type Description
str

The step type.

fake_input_prefix

fake_input_prefix = '_run_after_input_'

fake_output_name

fake_output_name = '_run_after_output'