Source code for pm4py.algo.transformation.ocel.description.algorithm

from pm4py.algo.transformation.ocel.description.variants import variant1
from pm4py.objects.ocel.obj import OCEL
from typing import Optional, Dict, Any
from pm4py.util import exec_utils
from enum import Enum




[docs]
class Variants(Enum):
    VARIANT1 = variant1






[docs]
def apply(
    ocel: OCEL,
    variant=Variants.VARIANT1,
    parameters: Optional[Dict[Any, Any]] = None,
) -> str:
    """
    Gets a textual representation from an object-centric event log

    Parameters
    --------------
    ocel
        Object-centric event log
    variant
        Variant of the algorithm to be used, possible values:
        - Variants.VARIANT1
    parameters
        Variant-specific parameters

    Returns
    --------------
    ocel_stri
        A textual representation of the object-centric event log
    """
    if parameters is None:
        parameters = {}

    return exec_utils.get_variant(variant).apply(ocel, parameters=parameters)