Code documentation

Subpackages

• subgroups.core package
• subgroups.quality_measures package
• subgroups.data_structures package
• subgroups.algorithms package
• subgroups.datasets package
• subgroups.utils package
• subgroups.tests package

Submodules

subgroups.exceptions module

This file contains new exceptions used by the library.

exception subgroups.exceptions.DatasetAttributeTypeError

Bases: TypeError

This exception is raised when the type of an attribute in a dataset is not supported by a Subgroup Discovery (SD) algorithm.

exception subgroups.exceptions.DuplicateFpTreeNodeError

Bases: RuntimeError

This exception is raised when attempting to add a FPTreeNode which already exists.

exception subgroups.exceptions.InconsistentMethodParametersError

Bases: RuntimeError

This exception is raised when a method has not been called with the appropriate parameters.

exception subgroups.exceptions.OperatorNotSupportedError

Bases: NotImplementedError

This exception is raised when an operator is not correctly implemented in the Operator class.

exception subgroups.exceptions.ParameterNotFoundError

Bases: KeyError

This exception is raised when a needed parameter is not found in the quality measure computing process.

exception subgroups.exceptions.SubgroupParameterNotFoundError

Bases: ParameterNotFoundError

This exception is raised when a subgroup parameter (i.e., tp, fp, TP or FP) is not found in the quality measure computing process.

exception subgroups.exceptions.VerticalListSizeError

Bases: ValueError

This exception is raised when comparing Vertical Lists with different dataset sizes.