morpheus.stages.general.router_stage.RouterStage#

class RouterStage(c, *, keys, key_fn, processing_engines=0)[source]#

Bases: GpuAndCpuMixin, Stage

Buffer results.

The input messages are buffered by this stage class for faster access to downstream stages. Allows upstream stages to run faster than downstream stages.

Parameters:

cmorpheus.config.Config: Pipeline configuration instance.
keyslist[str]: List of keys to route the messages.
key_fntyping.Callable[[object], str]: Function to determine the key for the message. The function should take a message as input and return a key. The key should be one of the keys in the keys list.
processing_enginesint: Number of processing engines to use for the router. If set to 0, the router will use the thread from the upstream node for processing. In this situation, slow downstream nodes can block which can prevent routing to other, non-blocked downstream nodes. To resolve this, set the processing_engines parameter to a value greater than 0. This will create separate engines (similar to a thread) which can continue routing even if one gets blocked. Higher values of processing_engines can prevent blocking at the expense of additional threads.

Attributes:

df_type_str: Returns the DataFrame module that should be used for the given execution mode.
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: The name of the stage.
output_ports: Output ports from this stage.
unique_name: Unique name of stage.

Methods

`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 schema for this stage based on the incoming schema from upstream stages.
`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_df_class`()	Returns the DataFrame class that should be used for the given execution mode.
`get_df_pkg`()	Returns the DataFrame package that should be used for the given execution mode.
`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`()	Specifies whether this Stage is capable of creating C++ nodes.

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

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

>>> for (port_idx, port_schema) in enumerate(schema.input_schemas):
...     schema.output_schemas[port_idx].set_type(port_schema.get_type())
>>>

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

property df_type_str: Literal['cudf', 'pandas']#: Returns the DataFrame module that should be used for the given execution mode.

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_df_class()[source]#

Returns the DataFrame class that should be used for the given execution mode.

get_df_pkg()[source]#

Returns the DataFrame package that should be used for the given execution mode.

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#

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[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]#: Specifies whether this Stage is capable of creating C++ nodes. During the build phase, this value will be combined with CppConfig.get_should_use_cpp() to determine whether or not a C++ node is created. This is an instance method to allow runtime decisions and derived classes to override base implementations.

property unique_name: str#

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

Returns:

str: Unique name of stage.