fairscoring.utils
=================

.. py:module:: fairscoring.utils

.. autoapi-nested-parse::

   Helpful function when dealing with fairness-related data



Functions
---------

.. autoapisummary::

   fairscoring.utils.split_groups


Module Contents
---------------

.. py:function:: split_groups(attribute, groups)

   Split the dataset into groups.

   :param attribute: The protected attribute.
   :type attribute: ArrayLike
   :param groups: A list of groups. Each group is given by a value of the protected attribute.
                  A value of `None` is used to define a group with all elements that are not in another group.
   :type groups: List

   :returns: **filter** -- Returns for each group an array binary filter, that is 'True' for those elements that belong to the group.
   :rtype: List of ArrayLike