Skip to content

chronulus.estimator.base

Estimator

Base class for implementing estimators that process data through the API.

This class provides the foundation for creating specific estimators by handling session management and input type validation. Subclasses should implement specific estimation logic while inheriting the base functionality.

Attributes:

Name Type Description
estimator_name str

Name identifier for the estimator. Default is "EstimatorBase".
estimator_version str

Version string for the estimator. Default is "1".
prediction_version str

Version string for the prediction. Set to "1".
estimator_id None

Identifier for a specific estimator instance, initialized as None.
session Session

Session instance used for API communication.
input_type Type[BaseModelSubclass]

Pydantic model class used for input validation.
Notes

The BaseModelSubclass type variable ensures that input_type must be a subclass of pydantic.BaseModel, enabling automatic input validation.

Source code in src/chronulus/estimator/base.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
class Estimator:
    """
    Base class for implementing estimators that process data through the API.

    This class provides the foundation for creating specific estimators by handling
    session management and input type validation. Subclasses should implement
    specific estimation logic while inheriting the base functionality.

    Attributes
    ----------
    estimator_name : str
        Name identifier for the estimator. Default is "EstimatorBase".
    estimator_version : str
        Version string for the estimator. Default is "1".
    prediction_version : str
        Version string for the prediction. Set to "1".
    estimator_id : None
        Identifier for a specific estimator instance, initialized as None.
    session : Session
        Session instance used for API communication.
    input_type : Type[BaseModelSubclass]
        Pydantic model class used for input validation.

    Notes
    -----
    The BaseModelSubclass type variable ensures that input_type must be
    a subclass of pydantic.BaseModel, enabling automatic input validation.
    """

    estimator_name = "EstimatorBase"
    estimator_version = "1"
    prediction_version = "1"

    def __init__(self, session: Session, input_type: Type[BaseModelSubclass]):
        """

        Parameters
        ----------
        session : Session
            Active session instance for API communication.
        input_type : Type[BaseModelSubclass]
            Pydantic model class that defines the expected input data structure.
        """
        self.estimator_id = None
        self.session = session
        self.input_type = input_type

    def get_route_prefix(self):
        return f"{self.estimator_name}/{self.estimator_version}"

__init__(session, input_type)

Parameters:

Name Type Description Default
session Session

Active session instance for API communication.

 required
input_type Type[BaseModelSubclass]

Pydantic model class that defines the expected input data structure.

 required
Source code in src/chronulus/estimator/base.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
def __init__(self, session: Session, input_type: Type[BaseModelSubclass]):
    """

    Parameters
    ----------
    session : Session
        Active session instance for API communication.
    input_type : Type[BaseModelSubclass]
        Pydantic model class that defines the expected input data structure.
    """
    self.estimator_id = None
    self.session = session
    self.input_type = input_type