Skip to content

Base

sklego.base.ClustererMeta

Bases: type

Metaclass for Clusterer.

This metaclass is responsible for checking whether a class can be considered a Clusterer. A class is considered a Clusterer if it has a "fit_predict" method.

Source code in sklego/base.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
class ClustererMeta(type):
    """Metaclass for `Clusterer`.

    This metaclass is responsible for checking whether a class can be considered a `Clusterer`.
    A class is considered a `Clusterer` if it has a "fit_predict" method.
    """

    def __instancecheck__(self, other):
        """Checks if the provided object is a `Clusterer`.

        Parameters
        ----------
        self : ClustererMeta
            `ClustererMeta` class.
        other : object
            The object to check for `Clusterer` compatibility.

        Returns
        -------
        bool
            True if the object is a `Clusterer` (has a "fit_predict" method ), False otherwise.
        """
        return hasattr(other, "fit_predict")

sklego.base.Clusterer

Base class for Clusterer.

This base class defines the Clusterer interface, indicating that subclasses should have a "fit_predict" method.

Source code in sklego/base.py 
64
65
66
67
68
69
70
class Clusterer(metaclass=ClustererMeta):
    """Base class for `Clusterer`.

    This base class defines the `Clusterer` interface, indicating that subclasses should have a "fit_predict" method.
    """

    pass

sklego.base.OutlierModelMeta

Bases: type

Metaclass for OutlierModel.

This metaclass is responsible for checking whether a class can be considered an OutlierModel. A class is considered an OutlierModel if it is an instance of the sklearn.base.OutlierMixin class.

Source code in sklego/base.py 
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
class OutlierModelMeta(type):
    """Metaclass for `OutlierModel`.

    This metaclass is responsible for checking whether a class can be considered an `OutlierModel`.
    A class is considered an `OutlierModel` if it is an instance of the `sklearn.base.OutlierMixin` class.
    """

    def __instancecheck__(self, other):
        """
        Check if the provided object is an `OutlierModel`.

        Parameters
        ----------
        self : OutlierModelMeta
            The `OutlierModelMeta` class.
        other : object
            The object to check for `OutlierModel` compatibility.

        Returns
        -------
        bool
            True if the object is an `OutlierModel` (an instance of "OutlierMixin"), False otherwise.
        """
        return isinstance(other, OutlierMixin)

sklego.base.OutlierModel

Base class for OutlierModel.

This base class defines the OutlierModel interface, indicating that subclasses should be instances of the "OutlierMixin" class.

Source code in sklego/base.py 
 99
100
101
102
103
104
105
106
class OutlierModel(metaclass=OutlierModelMeta):
    """Base class for `OutlierModel`.

    This base class defines the `OutlierModel` interface, indicating that subclasses should be instances of the
    "OutlierMixin" class.
    """

    pass

sklego.base.ProbabilisticClassifierMeta

Bases: type

Metaclass for ProbabilisticClassifier.

This metaclass is responsible for checking whether a class can be considered a ProbabilisticClassifier. A class is considered a ProbabilisticClassifier if it has a "predict_proba" method.

Source code in sklego/base.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
class ProbabilisticClassifierMeta(type):
    """Metaclass for `ProbabilisticClassifier`.

    This metaclass is responsible for checking whether a class can be considered a `ProbabilisticClassifier`.
    A class is considered a `ProbabilisticClassifier` if it has a "predict_proba" method.
    """

    def __instancecheck__(self, other):
        """Checks if the provided object is a `ProbabilisticClassifier`.

        Parameters
        ----------
        self : ProbabilisticClassifierMeta
            `ProbabilisticClassifierMeta` class.
        other : object
            The object to check for `ProbabilisticClassifier` compatibility.

        Returns
        -------
        bool
            True if the object is a `ProbabilisticClassifier` (has a "predict_proba" method ), False otherwise.
        """
        return hasattr(other, "predict_proba")

sklego.base.ProbabilisticClassifier

Base class for ProbabilisticClassifier.

This base class defines the ProbabilisticClassifier interface, indicating that subclasses should have a "predict_proba" method.

Source code in sklego/base.py 
29
30
31
32
33
34
35
36
class ProbabilisticClassifier(metaclass=ProbabilisticClassifierMeta):
    """Base class for `ProbabilisticClassifier`.

    This base class defines the `ProbabilisticClassifier` interface, indicating that subclasses should have a
    "predict_proba" method.
    """

    pass