pm4py.streaming.conversion package#

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

Submodules#

pm4py.streaming.conversion.from_pandas module#

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

class pm4py.streaming.conversion.from_pandas.Parameters(value)[source]#

Bases: Enum

An enumeration.

CASE_ID_KEY = 'pm4py:param:case_id_key'#
ACTIVITY_KEY = 'pm4py:param:activity_key'#
TIMESTAMP_KEY = 'pm4py:param:timestamp_key'#
INDEX_KEY = 'index_key'#
class pm4py.streaming.conversion.from_pandas.PandasDataframeAsIterable(dataframe: DataFrame, parameters: Optional[Dict[Any, Any]] = None)[source]#

Bases: object

read_trace() Trace[source]#
reset()[source]#
to_trace_stream(trace_stream: LiveTraceStream)[source]#

Sends the content of the dataframe to a trace stream

Parameters#

trace_stream

Trace stream

pm4py.streaming.conversion.from_pandas.apply(dataframe, parameters=None) PandasDataframeAsIterable[source]#

Transforms the Pandas dataframe object to an iterable

Parameters#

dataframe

Pandas dataframe

parameters

Parameters of the algorithm, including: - Parameters.CASE_ID_KEY => the attribute to be used as case identifier (default: constants.CASE_CONCEPT_NAME) - Parameters.ACTIVITY_KEY => the attribute to be used as activity (default: xes_constants.DEFAULT_NAME_KEY) - Parameters.TIMESTAMP_KEY => the attribute to be used as timestamp (default: xes_constants.DEFAULT_TIMESTAMP_KEY)

Returns#

log_iterable
Iterable log object, which can be iterated directly or added to a live trace stream

(using the method to_trace_stream).

pm4py.streaming.conversion.ocel_flatts_distributor module#

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

class pm4py.streaming.conversion.ocel_flatts_distributor.Parameters(value)[source]#

Bases: Enum

An enumeration.

ACTIVITY_KEY = 'pm4py:param:activity_key'#
CASE_ID_KEY = 'pm4py:param:case_id_key'#
TIMESTAMP_KEY = 'pm4py:param:timestamp_key'#
OCEL_ACTIVITY_KEY = 'param:event:activity'#
OCEL_TIMESTAMP_KEY = 'param:event:timestamp'#
OCEL_TYPE_PREFIX = 'param:object:type:prefix:extended'#
class pm4py.streaming.conversion.ocel_flatts_distributor.OcelFlattsDistributor(parameters: Optional[Dict[Any, Any]] = None)[source]#

Bases: object

register(object_type: str, live_event_stream: LiveEventStream)[source]#

Register a new event stream (listener) for a given object type.

Parameters#

object_type

Given object type

live_event_stream

Live event stream

append(event: Dict[str, Any])[source]#

Flattens an OCEL among all the available object types, and send its flattening to each corresponding event stream.

Parameters#

event

OCEL event (obtained for example using the ocel_iterator)