pm4py.algo.discovery.performance_spectrum package

Submodules

pm4py.algo.discovery.performance_spectrum.algorithm 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.algo.discovery.performance_spectrum.algorithm.Outputs[source]

Bases: enum.Enum

An enumeration.

LIST_ACTIVITIES = 'list_activities'
POINTS = 'points'
class pm4py.algo.discovery.performance_spectrum.algorithm.Parameters[source]

Bases: enum.Enum

An enumeration.

ACTIVITY_KEY = 'pm4py:param:activity_key'
ATTRIBUTE_KEY = 'pm4py:param:attribute_key'
CASE_ID_KEY = 'pm4py:param:case_id_key'
PARAMETER_SAMPLE_SIZE = 'sample_size'
TIMESTAMP_KEY = 'pm4py:param:timestamp_key'
class pm4py.algo.discovery.performance_spectrum.algorithm.Variants[source]

Bases: enum.Enum

An enumeration.

DATAFRAME = <module 'pm4py.algo.discovery.performance_spectrum.variants.dataframe' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/algo/discovery/performance_spectrum/variants/dataframe.py'>
DATAFRAME_DISCONNECTED = <module 'pm4py.algo.discovery.performance_spectrum.variants.dataframe_disconnected' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/algo/discovery/performance_spectrum/variants/dataframe_disconnected.py'>
LOG = <module 'pm4py.algo.discovery.performance_spectrum.variants.log' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/algo/discovery/performance_spectrum/variants/log.py'>
LOG_DISCONNECTED = <module 'pm4py.algo.discovery.performance_spectrum.variants.log_disconnected' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/algo/discovery/performance_spectrum/variants/log_disconnected.py'>
pm4py.algo.discovery.performance_spectrum.algorithm.apply(log: Union[pm4py.objects.log.obj.EventLog, pm4py.objects.log.obj.EventStream, pandas.core.frame.DataFrame], list_activities: List[str], variant=None, parameters: Optional[Dict[Any, Any]] = None) → Dict[str, Any][source]

Finds the performance spectrum provided a log/dataframe and a list of activities

Parameters:

  • log – Event log/Dataframe

  • list_activities – List of activities interesting for the performance spectrum (at least two)

  • variant – Variant to be used (see Variants Enum)

  • parameters –

    Parameters of the algorithm, including:
    • Parameters.ACTIVITY_KEY
    • Parameters.TIMESTAMP_KEY
Returns:

Performance spectrum object (dictionary)
Return type:

ps

pm4py.algo.discovery.performance_spectrum.outputs 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.algo.discovery.performance_spectrum.outputs.Outputs[source]

Bases: enum.Enum

An enumeration.

LIST_ACTIVITIES = 'list_activities'
POINTS = 'points'

pm4py.algo.discovery.performance_spectrum.parameters 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.algo.discovery.performance_spectrum.parameters.Parameters[source]

Bases: enum.Enum

An enumeration.

ACTIVITY_KEY = 'pm4py:param:activity_key'
ATTRIBUTE_KEY = 'pm4py:param:attribute_key'
CASE_ID_KEY = 'pm4py:param:case_id_key'
PARAMETER_SAMPLE_SIZE = 'sample_size'
TIMESTAMP_KEY = 'pm4py:param:timestamp_key'

Module contents

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/>.