pm4py.algo.enhancement.resource_profiles package

Subpackages

Submodules

pm4py.algo.enhancement.resource_profiles.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/>.

pm4py.algo.enhancement.resource_profiles.algorithm.activity_completions(log_obj: Union[pandas.core.frame.DataFrame, pm4py.objects.log.obj.EventLog], t1: Union[datetime.datetime, str], t2: Union[datetime.datetime, str], r: str, parameters: Optional[Dict[Any, Any]] = None) int[source]

The number of activity instances completed by a given resource during a given time slot.

Metric RBI 2.1 in Pika, Anastasiia, et al. “Mining resource profiles from event logs.” ACM Transactions on Management Information Systems (TMIS) 8.1 (2017): 1-30.

Parameters
  • log_obj – Log object

  • t1 – Left interval

  • t2 – Right interval

  • r – Resource

Returns

Value of the metric

Return type

metric

Deprecated since version 2.2.5: This will be removed in 3.0.0. use pm4py.algo.organizational_mining.resource_profiles.algorithm instead

pm4py.algo.enhancement.resource_profiles.algorithm.activity_frequency(log_obj: Union[pandas.core.frame.DataFrame, pm4py.objects.log.obj.EventLog], t1: Union[datetime.datetime, str], t2: Union[datetime.datetime, str], r: str, a: str, parameters: Optional[Dict[Any, Any]] = None) float[source]

Fraction of completions of a given activity a, by a given resource r, during a given time slot, [t1, t2), with respect to the total number of activity completions by resource r during [t1, t2)

Metric RBI 1.3 in Pika, Anastasiia, et al. “Mining resource profiles from event logs.” ACM Transactions on Management Information Systems (TMIS) 8.1 (2017): 1-30.

Parameters
  • log_obj – Log object

  • t1 – Left interval

  • t2 – Right interval

  • r – Resource

  • a – Activity

Returns

Value of the metric

Return type

metric

Deprecated since version 2.2.5: This will be removed in 3.0.0. use pm4py.algo.organizational_mining.resource_profiles.algorithm instead

pm4py.algo.enhancement.resource_profiles.algorithm.average_case_duration(log_obj: Union[pandas.core.frame.DataFrame, pm4py.objects.log.obj.EventLog], t1: Union[datetime.datetime, str], t2: Union[datetime.datetime, str], r: str, parameters: Optional[Dict[Any, Any]] = None) float[source]

The average duration of cases completed during a given time slot in which a given resource was involved.

Metric RBI 4.4 in Pika, Anastasiia, et al. “Mining resource profiles from event logs.” ACM Transactions on Management Information Systems (TMIS) 8.1 (2017): 1-30.

Parameters
  • log_obj – Log object

  • t1 – Left interval

  • t2 – Right interval

  • r – Resource

Returns

Value of the metric

Return type

metric

Deprecated since version 2.2.5: This will be removed in 3.0.0. use pm4py.algo.organizational_mining.resource_profiles.algorithm instead

pm4py.algo.enhancement.resource_profiles.algorithm.average_duration_activity(log_obj: Union[pandas.core.frame.DataFrame, pm4py.objects.log.obj.EventLog], t1: Union[datetime.datetime, str], t2: Union[datetime.datetime, str], r: str, a: str, parameters: Optional[Dict[Any, Any]] = None) float[source]

The average duration of instances of a given activity completed during a given time slot by a given resource.

Metric RBI 4.3 in Pika, Anastasiia, et al. “Mining resource profiles from event logs.” ACM Transactions on Management Information Systems (TMIS) 8.1 (2017): 1-30.

Parameters
  • log_obj – Log object

  • t1 – Left interval

  • t2 – Right interval

  • r – Resource

  • a – Activity

Returns

Value of the metric

Return type

metric

Deprecated since version 2.2.5: This will be removed in 3.0.0. use pm4py.algo.organizational_mining.resource_profiles.algorithm instead

pm4py.algo.enhancement.resource_profiles.algorithm.average_workload(log_obj: Union[pandas.core.frame.DataFrame, pm4py.objects.log.obj.EventLog], t1: Union[datetime.datetime, str], t2: Union[datetime.datetime, str], r: str, parameters: Optional[Dict[Any, Any]] = None) float[source]

The average number of activities started by a given resource but not completed at a moment in time.

Metric RBI 2.4 in Pika, Anastasiia, et al. “Mining resource profiles from event logs.” ACM Transactions on Management Information Systems (TMIS) 8.1 (2017): 1-30.

Parameters
  • log_obj – Log object

  • t1 – Left interval

  • t2 – Right interval

  • r – Resource

Returns

Value of the metric

Return type

metric

Deprecated since version 2.2.5: This will be removed in 3.0.0. use pm4py.algo.organizational_mining.resource_profiles.algorithm instead

pm4py.algo.enhancement.resource_profiles.algorithm.case_completions(log_obj: Union[pandas.core.frame.DataFrame, pm4py.objects.log.obj.EventLog], t1: Union[datetime.datetime, str], t2: Union[datetime.datetime, str], r: str, parameters: Optional[Dict[Any, Any]] = None) int[source]

The number of cases completed during a given time slot in which a given resource was involved.

Metric RBI 2.2 in Pika, Anastasiia, et al. “Mining resource profiles from event logs.” ACM Transactions on Management Information Systems (TMIS) 8.1 (2017): 1-30.

Parameters
  • log_obj – Log object

  • t1 – Left interval

  • t2 – Right interval

  • r – Resource

Returns

Value of the metric

Return type

metric

Deprecated since version 2.2.5: This will be removed in 3.0.0. use pm4py.algo.organizational_mining.resource_profiles.algorithm instead

pm4py.algo.enhancement.resource_profiles.algorithm.distinct_activities(log_obj: Union[pandas.core.frame.DataFrame, pm4py.objects.log.obj.EventLog], t1: Union[datetime.datetime, str], t2: Union[datetime.datetime, str], r: str, parameters: Optional[Dict[Any, Any]] = None) int[source]

Number of distinct activities done by a resource in a given time interval [t1, t2)

Metric RBI 1.1 in Pika, Anastasiia, et al. “Mining resource profiles from event logs.” ACM Transactions on Management Information Systems (TMIS) 8.1 (2017): 1-30.

Parameters
  • log_obj – Log object

  • t1 – Left interval

  • t2 – Right interval

  • r – Resource

Returns

Distinct activities

Return type

distinct_activities

Deprecated since version 2.2.5: This will be removed in 3.0.0. use pm4py.algo.organizational_mining.resource_profiles.algorithm instead

pm4py.algo.enhancement.resource_profiles.algorithm.fraction_case_completions(log_obj: Union[pandas.core.frame.DataFrame, pm4py.objects.log.obj.EventLog], t1: Union[datetime.datetime, str], t2: Union[datetime.datetime, str], r: str, parameters: Optional[Dict[Any, Any]] = None) float[source]

The fraction of cases completed during a given time slot in which a given resource was involved with respect to the total number of cases completed during the time slot.

Metric RBI 2.3 in Pika, Anastasiia, et al. “Mining resource profiles from event logs.” ACM Transactions on Management Information Systems (TMIS) 8.1 (2017): 1-30.

Parameters
  • log_obj – Log object

  • t1 – Left interval

  • t2 – Right interval

  • r – Resource

Returns

Value of the metric

Return type

metric

Deprecated since version 2.2.5: This will be removed in 3.0.0. use pm4py.algo.organizational_mining.resource_profiles.algorithm instead

pm4py.algo.enhancement.resource_profiles.algorithm.interaction_two_resources(log_obj: Union[pandas.core.frame.DataFrame, pm4py.objects.log.obj.EventLog], t1: Union[datetime.datetime, str], t2: Union[datetime.datetime, str], r1: str, r2: str, parameters: Optional[Dict[Any, Any]] = None) float[source]

The number of cases completed during a given time slot in which two given resources were involved.

Metric RBI 5.1 in Pika, Anastasiia, et al. “Mining resource profiles from event logs.” ACM Transactions on Management Information Systems (TMIS) 8.1 (2017): 1-30.

Parameters
  • log_obj – Log object

  • t1 – Left interval

  • t2 – Right interval

  • r1 – Resource 1

  • r2 – Resource 2

Returns

Value of the metric

Return type

metric

Deprecated since version 2.2.5: This will be removed in 3.0.0. use pm4py.algo.organizational_mining.resource_profiles.algorithm instead

pm4py.algo.enhancement.resource_profiles.algorithm.multitasking(log_obj: Union[pandas.core.frame.DataFrame, pm4py.objects.log.obj.EventLog], t1: Union[datetime.datetime, str], t2: Union[datetime.datetime, str], r: str, parameters: Optional[Dict[Any, Any]] = None) float[source]

The fraction of active time during which a given resource is involved in more than one activity with respect to the resource’s active time.

Metric RBI 3.1 in Pika, Anastasiia, et al. “Mining resource profiles from event logs.” ACM Transactions on Management Information Systems (TMIS) 8.1 (2017): 1-30.

Parameters
  • log_obj – Log object

  • t1 – Left interval

  • t2 – Right interval

  • r – Resource

Returns

Value of the metric

Return type

metric

Deprecated since version 2.2.5: This will be removed in 3.0.0. use pm4py.algo.organizational_mining.resource_profiles.algorithm instead

pm4py.algo.enhancement.resource_profiles.algorithm.social_position(log_obj: Union[pandas.core.frame.DataFrame, pm4py.objects.log.obj.EventLog], t1: Union[datetime.datetime, str], t2: Union[datetime.datetime, str], r: str, parameters: Optional[Dict[Any, Any]] = None) float[source]

The fraction of resources involved in the same cases with a given resource during a given time slot with respect to the total number of resources active during the time slot.

Metric RBI 5.2 in Pika, Anastasiia, et al. “Mining resource profiles from event logs.” ACM Transactions on Management Information Systems (TMIS) 8.1 (2017): 1-30.

Parameters
  • log_obj – Log object

  • t1 – Left interval

  • t2 – Right interval

  • r – Resource

Returns

Value of the metric

Return type

metric

Deprecated since version 2.2.5: This will be removed in 3.0.0. use pm4py.algo.organizational_mining.resource_profiles.algorithm instead

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