Preprocessing Graph

Class

class retentioneering.preprocessing_graph.preprocessing_graph.PreprocessingGraph(source_stream)

Collection of methods for preprocessing graph construction and calculation.

Parameters:

source_streamEventstreamType

Source eventstream.

Notes

See Preprocessing user guide for the details.

add_node(node, parents)

Add node to PreprocessingGraph instance.

Parameters:

nodeNode

An instance of either EventsNode or MergeNode.

parentslist of Nodes

• If node is EventsNode - only 1 parent must be defined.

• If node is MergeNode - at least 2 parents have to be defined.

Returns:

None

See also

PreprocessingGraph.combine

Start PreprocessingGraph recalculation.

EventsNode

Regular nodes of a preprocessing graph.

MergeNode

Merge nodes of a preprocessing graph.

combine(node)

Run calculations from the SourceNode up to the specified node.

Parameters:

nodeNode

Instance of either SourceNode, EventsNode or MergeNode.

Returns:

EventstreamType

Eventstream with all changes applied by data processors.

display(width=960, height=600)

Show constructed PreprocessingGraph.

Parameters:

widthint, default 960

Width of plot in pixels.

heightint, default 600

Height of plot in pixels.

Returns:

Rendered preprocessing graph.

export(payload)

Show PreprocessingGraph as a dict.

Parameters:

payloaddict

Returns:

dict

get_parents(node)

Show parents of the specified node.

Parameters:

nodeNode

Instance of one of the classes SourceNode, EventsNode or MergeNode.

Returns:

list of Nodes

Eventstream

Eventstream.preprocessing_graph(width=960, height=600)

Display the preprocessing GUI tool.

Parameters:

widthint, default 960

Width of plot in pixels.

heightint, default 600

Height of plot in pixels.

Returns:

PreprocessingGraph

Rendered preprocessing graph.