morpheus.stages.general.linear_modules_source.LinearModuleSourceStage

Bases: morpheus.pipeline.single_output_source.SingleOutputSource

A stage in the pipeline that serves as a linear module source.

This stage is responsible for integrating a module into the pipeline as a source stage.

Parameters

c

The configuration object for the pipeline.

module_config

The configuration for the module. This can be either a dictionary of configuration parameters or a ModuleDefinition object.

output_port_name

The name of the output port of the module.

output_type

The type of the output.

Attributes

_output_type

The output type of the stage.

_module_config

The configuration of the module.

_output_port_name

The name of the module’s output port.

_unique_name

The unique name of the module.

Methods

_build(builder, input_nodes)[source]

This function is responsible for constructing this stage’s internal mrc.SegmentObject object. The input of this function contains the returned value from the upstream stage.

The input values are the mrc.Builder for this stage and a list of parent nodes.

Parameters

builder : mrc.Builder

mrc.Builder object for the pipeline. This should be used to construct/attach the internal mrc.SegmentObject.

input_nodes : list[mrc.SegmentObject]

List containing the input mrc.SegmentObject objects.

Returns

list[mrc.SegmentObject]

List of tuples containing the output mrc.SegmentObject object from this stage.

_build_source(builder)[source]

Abstract method all derived Source classes should implement. Returns the same value as build.

Returns

mrc.SegmentObject:

The MRC node for this stage.

_build_sources(builder)[source]

Abstract method all derived Source classes should implement. Returns the same value as build.

Returns

mrc.SegmentObject:

The MRC nodes for this stage.

build(builder, do_propagate=True)[source]

Build this stage.

Parameters

builder : mrc.Builder

MRC segment for this stage.

do_propagate

Whether to propagate to build output stages, by default True.

can_build(check_ports=False)[source]

Determines if all inputs have been built allowing this node to be built.

Parameters

check_ports

Check if we can build based on the input ports, by default False.

Returns

bool

True if we can build, False otherwise.

can_pre_build(check_ports=False)[source]

Determines if all inputs have been built allowing this node to be built.

Parameters

check_ports

Check if we can build based on the input ports, by default False.

Returns

bool

True if we can build, False otherwise.

compute_schema(schema)[source]

Compute the schema for this stage based on the incoming schema from upstream stages.

Incoming schema and type information from upstream stages is available via the schema.input_schemas and schema.input_types properties.

Derived classes need to override this method, can set the output type(s) on schema by calling set_type for all output ports. For example a simple pass-thru stage might perform the following:

If the port types in upstream_schema are incompatible the stage should raise a RuntimeError.

get_all_input_stages()[source]

Get all input stages to this stage.

Returns

list[morpheus.pipeline.pipeline.StageBase]

All input stages.

get_all_inputs()[source]

Get all input senders to this stage.

Returns

list[morpheus.pipeline.pipeline.Sender]

All input senders.

get_all_output_stages()[source]

Get all output stages from this stage.

Returns

list[morpheus.pipeline.pipeline.StageBase]

All output stages.

get_all_outputs()[source]

Get all output receivers from this stage.

Returns

list[morpheus.pipeline.pipeline.Receiver]

All output receivers.

get_needed_columns()[source]

Stages which need to have columns inserted into the dataframe, should populate the self._needed_columns dictionary with mapping of column names to morpheus.common.TypeId. This will ensure that the columns are allocated and populated with null values.

property has_multi_input_ports: bool

Indicates if this stage has multiple input ports.

Returns

bool

True if stage has multiple input ports, False otherwise.

property has_multi_output_ports: bool

Indicates if this stage has multiple output ports.

Returns

bool

True if stage has multiple output ports, False otherwise.

property input_count: int

Return None for no max intput count.

property input_ports: list[morpheus.pipeline.receiver.Receiver]

Input ports to this stage.

Returns

list[morpheus.pipeline.pipeline.Receiver]

Input ports to this stage.

property is_built: bool

Indicates if this stage has been built.

Returns

bool

True if stage is built, False otherwise.

property is_pre_built: bool

Indicates if this stage has been built.

Returns

bool

True if stage is built, False otherwise.

async join()[source]

Awaitable method that stages can implement this to perform cleanup steps when pipeline is stopped. Typically this is called after stop during a graceful shutdown, but may not be called if the pipeline is terminated on its own.

property name: str

The name of the stage. Used in logging. Each derived class should override this property with a unique name.

Returns

str

Name of a stage.

property output_ports: list[morpheus.pipeline.sender.Sender]

Output ports from this stage.

Returns

list[morpheus.pipeline.pipeline.Sender]

Output ports from this stage.

async start_async()[source]

This function is called along with on_start during stage initialization. Allows stages to utilize the asyncio loop if needed.

stop()[source]

Stages can implement this to perform cleanup steps when pipeline is stopped.

supports_cpp_node()[source]

Indicates whether this stage supports a C++ node

property unique_name: str

Unique name of stage. Generated by appending stage id to stage name.

Returns

str

Unique name of stage.