- class ValidationStage(c, val_file_name, results_file_name=None, overwrite=False, include=None, exclude=['^ID$', '^_ts_'], index_col=None, abs_tol=0.001, rel_tol=0.005)[source]
Bases:
morpheus.stages.output.compare_dataframe_stage.CompareDataFrameStageValidate 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
includeandexclude, it will be excluded.- Parameters
- c
morpheus.config.Config - val_file_namestr
- results_file_namestr, optional
- overwriteboolean, default = False, is_flag = True
- includetyping.List[str], optional
- excludetyping.List[str], optional
- index_colstr, optional
- abs_tolfloat, default = 0.001
- rel_tolfloat, default = 0.05
The global configuration.
The comparison file, or an instance of a DataFrame.
If not
Nonespecifies an output file path to write a JSON file containing the validation results.Whether to overwrite the validation results if they exist, by default False.
Any columns to include. By default all columns are included.
Any columns to exclude. Takes a regex, by default [r’^ID$’, r’^_ts_’].
Whether to convert any column in the dataset to the index. Useful when the pipeline will change the index, by default None.
Absolute tolerance to use when comparing float columns.
Relative tolerance to use when comparing float columns.
- c
- Raises
- FileExistsError
When overwrite is False and the results file exists.
- Attributes
has_multi_input_portshas_multi_output_portsinput_portsis_builtnameoutput_portsunique_name
Indicates if this stage has multiple input ports.
Indicates if this stage has multiple output ports.
Input ports to this stage.
Indicates if this stage has been built.
The name of the stage.
Output ports from this stage.
Unique name of stage.
Methods
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 to this stage.
Get all input senders to this stage.
Get all output stages from this stage.
Get all output receivers from this stage.
- Returns
Stages which need to have columns inserted into the dataframe, should populate the
self._needed_columnsdictionary with mapping of column names tomorpheus.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.
This function is called along with on_start during stage initialization.
stop()Stages can implement this to perform cleanup steps when pipeline is stopped.
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.SegmentObjectobject. The input of this function contains the returned value from the upstream stage.The input values are the
mrc.Builderfor this stage and aStreamPairtuple which contain the inputmrc.SegmentObjectobject and the message data type.- Parameters
- builder
mrc.Builder - in_ports_streams
morpheus.pipeline.pipeline.StreamPair
mrc.Builderobject for the pipeline. This should be used to construct/attach the internalmrc.SegmentObject.List of tuples containing the input
mrc.SegmentObjectobject and the message data type.- builder
- Returns
typing.List[morpheus.pipeline.pipeline.StreamPair]
List of tuples containing the output
mrc.SegmentObjectobject from this stage and the message data type.
- accepted_types()[source]
Accepted input types for this stage are returned.
- Returns
- typing.Tuple(
morpheus.pipeline.messages.MultiMessage, )
Accepted input types.
- typing.Tuple(
- build(builder, do_propagate=True)[source]
Build this stage.
- Parameters
- builder
mrc.Builder - do_propagatebool, optional
MRC segment for this stage.
Whether to propagate to build output stages, by default True.
- builder
- 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.
- typing.List[
- get_all_inputs()[source]
Get all input senders to this stage.
- Returns
- typing.List[
morpheus.pipeline.pipeline.Sender]
All input senders.
- typing.List[
- get_all_output_stages()[source]
Get all output stages from this stage.
- Returns
- typing.List[
morpheus.pipeline.pipeline.StreamWrapper]
All output stages.
- typing.List[
- get_all_outputs()[source]
Get all output receivers from this stage.
- Returns
- typing.List[
morpheus.pipeline.pipeline.Receiver]
All output receivers.
- typing.List[
- 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_columnsdictionary with mapping of column names tomorpheus.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.
- typing.List[
- 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
stopduring 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.
- typing.List[
- 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.
