Skip to content

Reference Documentation

Auto-generated documentation will go here.

ml_verbs

Interfaces, or 'verbs', for machine learning.

IInvertable

Bases: Protocol[TInvertOut]

I am invertable.

Source code in src/ml_verbs/protocols/generic.py 
30
31
32
33
34
35
36
@runtime_checkable
class IInvertable(Protocol[TInvertOut]):
    """I am invertable."""

    @abstractmethod
    def invert(self) -> TInvertOut:
        """Return the inverse of this object."""

invert() -> TInvertOut abstractmethod

Return the inverse of this object.

Source code in src/ml_verbs/protocols/generic.py 
34
35
36
@abstractmethod
def invert(self) -> TInvertOut:
    """Return the inverse of this object."""

IPredict

Bases: Protocol[TDataIn, TDataOut]

I predict something based on data.

Source code in src/ml_verbs/protocols/xy.py 
10
11
12
13
14
15
16
@runtime_checkable
class IPredict(Protocol[TDataIn, TDataOut]):
    """I predict something based on data."""

    @abstractmethod
    def predict(self, data: TDataIn) -> TDataOut:
        """Predict an output based on the data."""

predict(data: TDataIn) -> TDataOut abstractmethod

Predict an output based on the data.

Source code in src/ml_verbs/protocols/xy.py 
14
15
16
@abstractmethod
def predict(self, data: TDataIn) -> TDataOut:
    """Predict an output based on the data."""

IPredictCategorical

Bases: IPredict[TDataIn, TDataOut], Protocol[TDataIn, TDataOut]

I predict categorical values based on data.

Source code in src/ml_verbs/protocols/xy.py 
19
20
21
22
23
24
25
26
27
28
29
@runtime_checkable
class IPredictCategorical(IPredict[TDataIn, TDataOut], Protocol[TDataIn, TDataOut]):
    """I predict categorical values based on data."""

    @abstractmethod
    def predict_categorical(self, data: TDataIn) -> TDataOut:
        """Predict a category based on the data."""

    def predict(self, data: TDataIn) -> TDataOut:
        """Predict a category based on the data."""
        return self.predict_categorical(data)

predict(data: TDataIn) -> TDataOut

Predict a category based on the data.

Source code in src/ml_verbs/protocols/xy.py 
27
28
29
def predict(self, data: TDataIn) -> TDataOut:
    """Predict a category based on the data."""
    return self.predict_categorical(data)

predict_categorical(data: TDataIn) -> TDataOut abstractmethod

Predict a category based on the data.

Source code in src/ml_verbs/protocols/xy.py 
23
24
25
@abstractmethod
def predict_categorical(self, data: TDataIn) -> TDataOut:
    """Predict a category based on the data."""

IPredictContinuous

Bases: IPredict[TDataIn, TDataOut], Protocol[TDataIn, TDataOut]

I predict continuous values based on data.

Source code in src/ml_verbs/protocols/xy.py 
32
33
34
35
36
37
38
39
40
41
42
@runtime_checkable
class IPredictContinuous(IPredict[TDataIn, TDataOut], Protocol[TDataIn, TDataOut]):
    """I predict continuous values based on data."""

    @abstractmethod
    def predict_continuous(self, data: TDataIn) -> TDataOut:
        """Predict a continuous value based on the data."""

    def predict(self, data: TDataIn) -> TDataOut:
        """Predict a continuous value based on the data."""
        return self.predict_continuous(data)

predict(data: TDataIn) -> TDataOut

Predict a continuous value based on the data.

Source code in src/ml_verbs/protocols/xy.py 
40
41
42
def predict(self, data: TDataIn) -> TDataOut:
    """Predict a continuous value based on the data."""
    return self.predict_continuous(data)

predict_continuous(data: TDataIn) -> TDataOut abstractmethod

Predict a continuous value based on the data.

Source code in src/ml_verbs/protocols/xy.py 
36
37
38
@abstractmethod
def predict_continuous(self, data: TDataIn) -> TDataOut:
    """Predict a continuous value based on the data."""

ITrain

Bases: Protocol[TDataIn, TTrainOut]

I train something based on data given to me.

Source code in src/ml_verbs/protocols/generic.py 
21
22
23
24
25
26
27
@runtime_checkable
class ITrain(Protocol[TDataIn, TTrainOut]):
    """I train something based on data given to me."""

    @abstractmethod
    def train(self, data: TDataIn) -> TTrainOut:
        """Train something based on the input data."""

train(data: TDataIn) -> TTrainOut abstractmethod

Train something based on the input data.

Source code in src/ml_verbs/protocols/generic.py 
25
26
27
@abstractmethod
def train(self, data: TDataIn) -> TTrainOut:
    """Train something based on the input data."""

ITransform

Bases: Protocol[TDataIn, TDataOut]

I transform data into some other data.

Source code in src/ml_verbs/protocols/generic.py 
12
13
14
15
16
17
18
@runtime_checkable
class ITransform(Protocol[TDataIn, TDataOut]):
    """I transform data into some other data."""

    @abstractmethod
    def transform(self, data: TDataIn) -> TDataOut:
        """Tranform input data into output data."""

transform(data: TDataIn) -> TDataOut abstractmethod

Tranform input data into output data.

Source code in src/ml_verbs/protocols/generic.py 
16
17
18
@abstractmethod
def transform(self, data: TDataIn) -> TDataOut:
    """Tranform input data into output data."""