pm4py.ocel#

The pm4py.ocel module contains the object-centric process mining features offered in pm4py.

Functions

cluster_equivalent_ocel(ocel, object_type[, ...])

Clusters the object-centric event log based on the 'executions' of a single object type.

discover_objects_graph(ocel[, graph_type])

Discovers an object graph from the provided object-centric event log.

discover_oc_petri_net(ocel[, ...])

Discovers an object-centric Petri net from the provided object-centric event log.

discover_ocdfg(ocel[, business_hours, ...])

Discovers an Object-Centric Directly-Follows Graph (OC-DFG) from an object-centric event log.

ocel_add_index_based_timedelta(ocel)

Adds a small time delta to the timestamp column based on the event index to ensure the correct ordering of events within any object-centric process mining solution.

ocel_drop_duplicates(ocel)

Removes duplicate relations between events and objects that occur at the same time, have the same activity, and are linked to the same object identifier.

ocel_e2o_lifecycle_enrichment(ocel)

Enriches the OCEL with lifecycle-based information, indicating when an object is created, terminated, or has other types of relations, by updating the E2O relations.

ocel_flattening(ocel, object_type)

Flattens the object-centric event log to a traditional event log based on a chosen object type.

ocel_get_attribute_names(ocel)

Returns the list of attributes at the event and object levels of an object-centric event log (e.g., ["cost", "amount", "name"]).

ocel_get_object_types(ocel)

Returns the list of object types contained in the object-centric event log (e.g., ["order", "item", "delivery"]).

ocel_merge_duplicates(ocel[, have_common_object])

Merges events in the OCEL that have the same activity and timestamp.

ocel_o2o_enrichment(ocel[, included_graphs])

Enriches the OCEL with information inferred from graph computations by inserting them into the O2O relations.

ocel_object_type_activities(ocel)

Returns the set of activities performed for each object type.

ocel_objects_interactions_summary(ocel)

Returns the objects interactions summary of an object-centric event log.

ocel_objects_ot_count(ocel)

Returns the count of related objects per type for each event.

ocel_objects_summary(ocel)

Returns the objects summary of an object-centric event log.

ocel_sort_by_additional_column(ocel, ...[, ...])

Sorts the OCEL based on the primary timestamp column and an additional column to determine the order of events occurring at the same timestamp.

ocel_temporal_summary(ocel)

Returns the temporal summary of an object-centric event log.

sample_ocel_connected_components(ocel[, ...])

Returns a sampled object-centric event log containing a specified number of connected components.

sample_ocel_objects(ocel, num_objects)

Returns a sampled object-centric event log containing a random subset of objects.