# pm4py.algo.organizational_mining.roles package

## pm4py.algo.organizational_mining.roles.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.organizational_mining.roles.algorithm.Variants(value)[source]

Bases: enum.Enum

An enumeration.

LOG = <module 'pm4py.algo.organizational_mining.roles.variants.log' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\algo\\organizational_mining\\roles\\variants\\log.py'>
PANDAS = <module 'pm4py.algo.organizational_mining.roles.variants.pandas' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\algo\\organizational_mining\\roles\\variants\\pandas.py'>
pm4py.algo.organizational_mining.roles.algorithm.apply(log: Union[pm4py.objects.log.obj.EventLog, pm4py.objects.log.obj.EventStream, pandas.core.frame.DataFrame], variant=None, parameters: Optional[Dict[Any, Any]] = None) List[Any][source]

Gets the roles (group of different activities done by similar resources) out of the log.

The roles detection is introduced by Burattin, Andrea, Alessandro Sperduti, and Marco Veluscek. “Business models enhancement through discovery of roles.” 2013 IEEE Symposium on Computational Intelligence and Data Mining (CIDM). IEEE, 2013.

Parameters
• log – Log object (also Pandas dataframe)

• variant

Variant of the algorithm to apply. Possible values:
• Variants.LOG

• Variants.PANDAS

• parameters – Possible parameters of the algorithm

Returns

List of different roles inside the log, including: roles_threshold_parameter => threshold to use with the algorithm

Return type

roles

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