morpheus.stages.output.compare_dataframe_stage.CompareDataFrameStage
NVIDIA Docs Hub  NVIDIA Morpheus  morpheus.stages.output.compare_dataframe_stage.CompareDataFrameStage
class CompareDataFrameStage(c, compare_df, include=None, exclude=None, index_col=None, abs_tol=0.001, rel_tol=0.005, reset_index=False)[source]

Bases: morpheus.stages.output.in_memory_sink_stage.InMemorySinkStage

Collects incoming messages, comparing the concatinated dataframe of all messages against an expected dataframe compare_df.

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

Parameters
cmorpheus.config.Config

Pipeline configuration instance.
compare_dftyping.Union[pd.DataFrame, cudf.DataFrame, str]

Dataframe to compare against the aggregate DataFrame composed from the received messages. When compare_df is a string it is assumed to be a file path.
includetyping.List[str], optional

List of regex patterns to match columns to include. By default all columns are included.
excludetyping.List[str], optional

List of regex patters to match columns to exclude. By default no columns are excluded.
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.
reset_indexbool, default = False

When True the index of the aggregate DataFrame will be reset. Useful for testing with KafkaSourceStage, where the index restarts for each MessageMeta emitted.
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.
name

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.

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_messages()

Returns

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.

on_start()

This function can be overridden to add usecase-specific implementation at the start of any stage in the pipeline.

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.

supports_cpp_node()

Specifies whether this Stage is capable of creating C++ nodes.
_build(builder, in_ports_streams)[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 StreamPair tuple which contain the input mrc.SegmentObject object and the message data type.

Parameters
buildermrc.Builder

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

List of tuples containing the input mrc.SegmentObject object and the message data type.
Returns
typing.List[morpheus.pipeline.pipeline.StreamPair]

List of tuples containing the output mrc.SegmentObject object from this stage and the message data type.
accepted_types()[source]

Accepted input types for this stage are returned.

Returns
typing.Tuple(typing.Any, )

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.
clear()[source]

Clear the messages that have been collected so far
get_all_input_stages()[source]

Get all input stages to this stage.

Returns
typing.List[morpheus.pipeline.pipeline.StreamWrapper]

All input stages.
get_all_inputs()[source]

Get all input senders to this stage.

Returns
typing.List[morpheus.pipeline.pipeline.Sender]

All input senders.
get_all_output_stages()[source]

Get all output stages from this stage.

Returns
typing.List[morpheus.pipeline.pipeline.StreamWrapper]

All output stages.
get_all_outputs()[source]

Get all output receivers from this stage.

Returns
typing.List[morpheus.pipeline.pipeline.Receiver]

All output receivers.
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[morpheus.pipeline.receiver.Receiver]

Input ports to this stage.

Returns
typing.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.
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.
on_start()[source]

This function can be overridden to add usecase-specific implementation at the start of any stage in the pipeline.
property output_ports: List[morpheus.pipeline.sender.Sender]

Output ports from this stage.

Returns
typing.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]

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.
© Copyright 2023, NVIDIA. Last updated on Apr 11, 2023.