morpheus.stages.postprocess.validation_stage.ValidationStage#

class ValidationStage( c, val_file_name, results_file_name=None, overwrite=False, include=None, exclude=None, index_col=None, abs_tol=0.001, rel_tol=0.005, )[source]#

Bases: CompareDataFrameStage

Validate pipeline output for testing.

The validation stage can be used to combine all output data into a single dataframe and compare against a known good file.

If a column name is matched by both include and exclude, it will be excluded.

Parameters:

cmorpheus.config.Config: The global configuration.
val_file_namestr: The comparison file, or an instance of a DataFrame.
results_file_namestr, optional: If not None specifies an output file path to write a JSON file containing the validation results.
overwriteboolean, default = False, is_flag = True: Whether to overwrite the validation results if they exist, by default False.
includetyping.List[str], optional: Any columns to include. By default all columns are included.
excludetyping.List[str], optional: Any columns to exclude. Takes a regex, by default [r’^ID$’, r’^_ts_’].
index_colstr, optional: Whether to convert any column in the dataset to the index. Useful when the pipeline will change the index, by default None.
abs_tolfloat, default = 0.001: Absolute tolerance to use when comparing float columns.
rel_tolfloat, default = 0.05: Relative tolerance to use when comparing float columns.

Raises:

FileExistsError: When overwrite is False and the results file exists.

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: Unique name for this 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.
`clear`()	Clear the messages that have been collected so far
`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_messages`()
`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`.
`get_results`([clear])	Returns the results dictionary.
`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`()	Indicates whether this stage supports a C++ node.

compute_schema

_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(morpheus.messages.ControlMessage,): Accepted input types.

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.

clear()[source]#: Clear the messages that have been collected so far

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

Returns:

list: Results collected messages

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.

get_results(clear=True)[source]#

Returns the results dictionary. This is the same dictionary that is written to results_file_name

Returns:

dict: Results dictionary

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#: Unique name for this 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]#

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.