pm4py.statistics.variants.log.get module#

PM4Py – A Process Mining Library for Python Copyright (C) 2026 Process Intelligence Solutions GmbH

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see this software project’s root or visit <https://www.gnu.org/licenses/>.

Website: https://processintelligence.solutions Contact: info@processintelligence.solutions

class pm4py.statistics.variants.log.get.Parameters(*values)[source]#

Bases: Enum

ATTRIBUTE_KEY = 'pm4py:param:attribute_key'#
ACTIVITY_KEY = 'pm4py:param:activity_key'#
START_TIMESTAMP_KEY = 'pm4py:param:start_timestamp_key'#
TIMESTAMP_KEY = 'pm4py:param:timestamp_key'#
CASE_ID_KEY = 'pm4py:param:case_id_key'#
MAX_NO_POINTS_SAMPLE = 'max_no_of_points_to_sample'#
KEEP_ONCE_PER_CASE = 'keep_once_per_case'#
pm4py.statistics.variants.log.get.get_language(log: EventLog, parameters: Dict[str | Parameters, Any] | None = None) → Dict[List[str], float] | Dict[str, float][source]#

Gets the stochastic language of the log (from the variants)

Parameters:

  • log – Event log

  • parameters – Parameters

Returns:

Dictionary containing the stochastic language of the log (variant associated to a number between 0 and 1; the sum is 1)

Return type:

dictio

pm4py.statistics.variants.log.get.get_variants(log: EventLog, parameters: Dict[str | Parameters, Any] | None = None) → Dict[List[str], List[Trace]] | Dict[str, List[Trace]][source]#

Gets a dictionary whose key is the variant and as value there is the list of traces that share the variant

Parameters:

  • log – Trace log

  • parameters –

    Parameters of the algorithm, including:

    Parameters.ACTIVITY_KEY -> Attribute identifying the activity in the log

Returns:

Dictionary with variant as the key and the list of traces as the value

Return type:

variant

pm4py.statistics.variants.log.get.get_variants_along_with_case_durations(log: EventLog, parameters: Dict[str | Parameters, Any] | None = None) → Tuple[Dict[List[str], List[Trace]] | Dict[str, List[Trace]], array][source]#

Gets a dictionary whose key is the variant and as value there is the list of traces that share the variant

Parameters:

  • log – Trace log

  • parameters –

    Parameters of the algorithm, including:

    Parameters.ACTIVITY_KEY -> Attribute identifying the activity in the log

Returns:

Dictionary with variant as the key and the list of traces as the value

Return type:

variant

pm4py.statistics.variants.log.get.get_variants_from_log_trace_idx(log, parameters=None)[source]#

Gets a dictionary whose key is the variant and as value there is the list of traces indexes that share the variant

Parameters:

  • log – Log

  • parameters –

    Parameters of the algorithm, including:

    Parameters.ACTIVITY_KEY -> Attribute identifying the activity in the log

Returns:

Dictionary with variant as the key and the list of traces indexes as the value

Return type:

variant

pm4py.statistics.variants.log.get.get_variants_sorted_by_count(variants)[source]#

From the dictionary of variants returns an ordered list of variants along with their count

Parameters:

variants – Dictionary with variant as the key and the list of traces as the value

Returns:

List of variant names along with their count

Return type:

var_count

pm4py.statistics.variants.log.get.convert_variants_trace_idx_to_trace_obj(log, variants_trace_idx)[source]#

Converts variants expressed as trace indexes to trace objects

Parameters:

  • log – Trace log object

  • variants_trace_idx – Variants associated to a list of belonging indexes

Returns:

Variants associated to a list of belonging traces

Return type:

variants