typehinting

Methods for additional custom type hinting.

Tip

Methods in this module are really just for typehinting; this code is never actually executed.

class hsr4hci.typehinting.BaseLinearModel

Define a base class for linear models from sklearn. Linear models are characterized by the fact that they have a coefficient vector coef_ and an intercept term intercept_.

__init__(*args, **kwargs)

class hsr4hci.typehinting.BaseLinearModelCV

Define a base class for cross-validated linear models from sklearn such as, e.g., RidgeCV. These models are characterized by the fact that they have an alpha_ attribute which stores the value of the regularization parameter chosen by the cross-validation.

__init__(*args, **kwargs)

class hsr4hci.typehinting.RegressorModel

Define a type hint for a generic regressor, that is, a class that follows the usual sklearn syntax (i.e., it provides a fit() and a predict() method) and can be used to learn a mapping from predictors X to targets y.

__init__(*args, **kwargs)