morpheus.stages.general.multi_processing_stage.MultiProcessingStage#

class MultiProcessingStage( *, c, unique_name, process_fn, process_pool_usage, max_in_flight_messages=None, )[source]#

Bases: MultiProcessingBaseStage[InputT, OutputT]

A derived class of MultiProcessingBaseStage that allows the user to define a process function that will be executed based on shared process pool.

Parameters:

cmorpheus.config.Config: Pipeline configuration instance.
unique_namestr: A unique name for the stage.
process_fn: typing.Callable[[InputT], OutputT]: The function that will be executed in the process pool.
max_in_flight_messagesint, default = None: The number of progress engines used by the stage.

Attributes:

has_multi_input_ports: Indicates if this stage has multiple input ports.
has_multi_output_ports: Indicates if this stage has multiple output ports.
input_ports: Input ports to this stage.
is_built: Indicates if this stage has been built.
is_pre_built: Indicates if this stage has been built.
name: Return the name of the stage.
output_ports: Output ports from this stage.
unique_name: Unique name of stage.

Methods

`accepted_types`()	Accepted input types for this stage are returned.
`build`(builder[, do_propagate])	Build this stage.
`can_build`([check_ports])	Determines if all inputs have been built allowing this node to be built.
`can_pre_build`([check_ports])	Determines if all inputs have been built allowing this node to be built.
`compute_schema`(schema)	Compute the output schema for the stage.
`create`(*, c, unique_name, process_fn, ...)	Create a MultiProcessingStage instance by deducing the input and output types from the process function.
`get_all_input_stages`()	Get all input stages to this stage.
`get_all_inputs`()	Get all input senders to this stage.
`get_all_output_stages`()	Get all output stages from this stage.
`get_all_outputs`()	Get all output receivers from this stage.
`get_needed_columns`()	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`.
`join`()	Awaitable method that stages can implement this to perform cleanup steps when pipeline is stopped.
`start_async`()	This function is called along with on_start during stage initialization.
`stop`()	Stages can implement this to perform cleanup steps when pipeline is stopped.
`supported_execution_modes`()	Returns a tuple of supported execution modes of this stage.
`supports_cpp_node`()	Whether this stage supports a C++ node.

_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:

buildermrc.Builder: mrc.Builder object for the pipeline. This should be used to construct/attach the internal mrc.SegmentObject.
input_nodeslist[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.

accepted_types()[source]#

Accepted input types for this stage are returned.

Returns:

typing.Tuple: Accepted input types.

Raises:

RuntimeError: If the accepted types cannot be deduced from either __orig_class__ or __orig_bases__.

build(builder, do_propagate=True)[source]#

Build this stage.

Parameters:

buildermrc.Builder: MRC segment for this stage.
do_propagatebool, optional: 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_portsbool, optional: 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_portsbool, optional: 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 output schema for the stage.

Parameters:

schemaStageSchema: The schema for the stage.

Raises:

RuntimeError: If the output type cannot be deduced from either __orig_class__ or __orig_bases__.

static create( *, c, unique_name, process_fn, process_pool_usage, )[source]#

Create a MultiProcessingStage instance by deducing the input and output types from the process function.

Parameters:

cmorpheus.config.Config: Pipeline configuration instance.
unique_namestr: A unique name for the stage.
process_fntyping.Callable[[InputT], OutputT]: The function that will be executed in the process pool.
process_pool_usagefloat: The fraction of the process pool workers that this stage could use. Should be between 0 and 1.

Returns:

MultiProcessingStage[InputT, OutputT]: A MultiProcessingStage instance with deduced input and output types.

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_ports: list[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.

property name: str#: Return the name of the stage.

property output_ports: list[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.

supported_execution_modes()[source]#

Returns a tuple of supported execution modes of this stage.

supports_cpp_node()[source]#: 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.