pm4py.statistics.variants.polars.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.polars.get.Parameters(*values)[source]#

Bases: Enum

CASE_ID_KEY = 'pm4py:param:case_id_key'#
ACTIVITY_KEY = 'pm4py:param:activity_key'#
TIMESTAMP_KEY = 'pm4py:param:timestamp_key'#
pm4py.statistics.variants.polars.get.pandas_numpy_variants_apply_polars(lf: polars.LazyFrame, parameters=None) → Tuple[Dict[Tuple[str, ...], int], Dict[str, Tuple[str, ...]]][source]#

Efficient method returning the variants from a Polars LazyFrame

Parameters:

  • lf – LazyFrame

  • parameters – Parameters of the algorithm, including: - Parameters.CASE_ID_KEY => the case identifier - Parameters.ACTIVITY_KEY => the activity - Parameters.TIMESTAMP_KEY => the timestamp

Returns:

  • variants_dict – Dictionary associating to each variant the number of occurrences in the dataframe

  • case_variant – Dictionary associating to each case identifier the corresponding variant

pm4py.statistics.variants.polars.get.get_variants_count(lf: polars.LazyFrame, parameters: Dict[Any, Any] | None = None) → Dict[Tuple[str, ...], int][source]#

Gets the dictionary of variants from the current LazyFrame

Parameters:

  • lf – LazyFrame

  • parameters –

    Possible parameters of the algorithm, including:

    Parameters.ACTIVITY_KEY -> Column that contains the activity

Returns:

Dictionary of variants in the log

Return type:

variants_dict

pm4py.statistics.variants.polars.get.get_variants_set(lf: polars.LazyFrame, parameters: Dict[Any, Any] | None = None) → Set[Tuple[str, ...]][source]#

Gets the set of variants from the current LazyFrame

Parameters:

  • lf – LazyFrame

  • parameters –

    Possible parameters of the algorithm, including:

    Parameters.ACTIVITY_KEY -> Column that contains the activity

Returns:

Set of variants in the log

Return type:

variants_set