Skip to content

learner

The base learner class.

This base class defines a base learner template. It can be used to define several learning algorithms that can be applied to train the RPN model in the tinyBIG toolkit.

Attributes:

Name Type Description
name str, default = 'base_learner'

Name of the base learner class.

Methods:

Name Description
__init__

The base learner initialization method
train

The training method of the base learner on the training set.
test

The testing method of the base learner on the testing set.
Source code in tinybig/learner/base_learner.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
class learner:
    """
    The base learner class.

    This base class defines a base learner template. It can be used to define several learning algorithms that can be
    applied to train the RPN model in the tinyBIG toolkit.

    Attributes
    ----------
    name: str, default = 'base_learner'
        Name of the base learner class.

    Methods
    ----------
    __init__
        The base learner initialization method

    train
        The training method of the base learner on the training set.

    test
        The testing method of the base learner on the testing set.
    """
    def __init__(self, name='base_learner', *args, **kwargs):
        self.name = name

    @abstractmethod
    def train(self, *args, **kwargs):
        pass

    @abstractmethod
    def test(self, *args, **kwargs):
        pass