morpheus_dfp.stages.multi_file_source.MultiFileSource#

class MultiFileSource(c, filenames, watch=False, watch_interval=1.0)[source]#

Bases: SingleOutputSource

Source stage is used to load messages from a file and dumping the contents into the pipeline immediately. Useful for testing performance and accuracy of a pipeline.

Parameters:

cmorpheus.config.Config: Pipeline configuration instance.
filenamesList[str]: List of paths to be read from, can be a list of S3 urls (s3://path) amd can include wildcard characters * as defined by fsspec: https://filesystem-spec.readthedocs.io/en/latest/api.html?highlight=open_files#fsspec.open_files
watchbool, default = False: When True, will check filenames for new files and emit them as they appear. This assumes that at least one of the paths in filenames contains a wildecard character.
watch_intervalfloat, default = 1.0: When watch is True, this is the time in seconds between polling the paths in filenames for new files. Ignored when watch is False.

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_count: Return None for no max intput count
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

`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_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`.
`is_stop_requested`()	Returns `True` if a stop has been requested.
`join`()	Awaitable method that stages can implement this to perform cleanup steps when pipeline is stopped.
`request_stop`()	Request the source to stop processing data.
`start_async`()	This function is called along with on_start during stage initialization.
`stop`()	This method is invoked by the pipeline whenever there is an unexpected shutdown.
`supported_execution_modes`()	Returns a tuple of supported execution modes of this stage.
`supports_cpp_node`()	Indicates whether this stage supports 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_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:

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.

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

is_stop_requested()[source]#

Returns True if a stop has been requested.

Returns:

bool:: True if a stop has been requested, 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#: 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.

request_stop()[source]#: Request the source to stop processing data.

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]#: This method is invoked by the pipeline whenever there is an unexpected shutdown. Subclasses should override this method to perform any necessary cleanup operations.

supported_execution_modes()[source]#

Returns a tuple of supported execution modes of this stage. By default this returns (ExecutionMode.GPU,). Subclasses can override this method to specify different execution modes.

For most stages the values will be static, and this can be accomplished by making use of either the CpuOnlyMixin or GpuAndCpuMixin mixins.

However, complex stages may choose to make this decision at runtime, in which case this method should be overridden. directly within the stage class.

supports_cpp_node()[source]#: Indicates whether this stage supports C++ nodes.

property unique_name: str#

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

Returns:

str: Unique name of stage.