Base

The physlearn.base module provides a base class and mixin class for the estimator dictionary and regressor amalgamation, respectively.

class physlearn.base.AbstractEstimatorDictionaryInterface[source]

Bases: ABC

Abstract base class for the estimator dictionary interface.

Notes

All estimators should be retrieved from the estimator dictionary, thereby enabling a case-insensitive estimator API.

abstract set_params()[source]

Set the (hyper)parameters.

class physlearn.base.AdditionalRegressorMixin[source]

Bases: ABC

Mixin class to include with sklearn.base.RegressorMixin.

Notes

The Scikit-learn regressor mixin includes a score method.

abstract dump(value, filename)[source]

Serializes the value.

abstract load(filename)[source]

Deserializes the file object.

abstract fit(X, y, sample_weight=None)[source]

Fit a model in supervised fashion.

abstract predict(X)[source]

Generate predictions with a model.