# `base`

Base classes for CapyMOA learners.

This module defines the abstract interfaces that all CapyMOA learners implement,
including classifiers, regressors, anomaly detectors, clusterers, prediction
interval learners, and their semi-supervised and MOA-backed variants.

## Classes

| [`AnomalyDetector`](capymoa.base.AnomalyDetector.md#capymoa.base.AnomalyDetector)                           | Abstract base class for anomaly detector.                                                              |
|-------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| [`Batch`](capymoa.base.Batch.md#capymoa.base.Batch)                                               | Base class for batch processing in CapyMOA                                                             |
| [`BatchClassifier`](capymoa.base.BatchClassifier.md#capymoa.base.BatchClassifier)                           | Base class for classifiers that support mini-batches.                                                  |
| [`BatchRegressor`](capymoa.base.BatchRegressor.md#capymoa.base.BatchRegressor)                             | Base class for regressor that support mini-batches.                                                    |
| [`Classifier`](capymoa.base.Classifier.md#capymoa.base.Classifier)                                     | Base class for classifiers.                                                                            |
| [`ClassifierSSL`](capymoa.base.ClassifierSSL.md#capymoa.base.ClassifierSSL)                               | Base class for semi-supervised learning classifiers.                                                   |
| [`Clusterer`](capymoa.base.Clusterer.md#capymoa.base.Clusterer)                                       |                                                                                                        |
| [`ClusteringResult`](capymoa.base.ClusteringResult.md#capymoa.base.ClusteringResult)                         | Abstract clustering result class that has the structure of clusters: centers, weights, radii, and ids. |
| [`LearnerParamsMixin`](capymoa.base.LearnerParamsMixin.md#capymoa.base.LearnerParamsMixin)                     | Mixin enabling capturing and reconstructing learner hyper-parameters.                                  |
| [`LearnerSpec`](capymoa.base.LearnerSpec.md#capymoa.base.LearnerSpec)                                   | Serialized learner specification used for capturing and reconstructing learner hyper-parameters.       |
| [`MOAAnomalyDetector`](capymoa.base.MOAAnomalyDetector.md#capymoa.base.MOAAnomalyDetector)                     |                                                                                                        |
| [`MOAClassifier`](capymoa.base.MOAClassifier.md#capymoa.base.MOAClassifier)                               | A wrapper class for using MOA (Massive Online Analysis) classifiers in CapyMOA.                        |
| [`MOAClassifierSSL`](capymoa.base.MOAClassifierSSL.md#capymoa.base.MOAClassifierSSL)                         | Wrapper for using MOA semi-supervised learning classifiers.                                            |
| [`MOAClusterer`](capymoa.base.MOAClusterer.md#capymoa.base.MOAClusterer)                                 | A wrapper class for using MOA (Massive Online Analysis) clusterers in CapyMOA.                         |
| [`MOAPredictionIntervalLearner`](capymoa.base.MOAPredictionIntervalLearner.md#capymoa.base.MOAPredictionIntervalLearner) |                                                                                                        |
| [`MOARegressor`](capymoa.base.MOARegressor.md#capymoa.base.MOARegressor)                                 |                                                                                                        |
| [`PredictionIntervalLearner`](capymoa.base.PredictionIntervalLearner.md#capymoa.base.PredictionIntervalLearner)       |                                                                                                        |
| [`Regressor`](capymoa.base.Regressor.md#capymoa.base.Regressor)                                       |                                                                                                        |
| [`SKClassifier`](capymoa.base.SKClassifier.md#capymoa.base.SKClassifier)                                 | A wrapper class for using scikit-learn classifiers in CapyMOA.                                         |
| [`SKRegressor`](capymoa.base.SKRegressor.md#capymoa.base.SKRegressor)                                   | A wrapper class for using scikit-learn regressors in CapyMOA.                                          |

## Functions

| [`learner_from_params`](#capymoa.base.learner_from_params)   | Construct a learner from a serialized fully qualified learner spec.   |
|------------------------------------------------------------------------|-----------------------------------------------------------------------|

### capymoa.base.learner_from_params(spec: [LearnerSpec](capymoa.base.LearnerSpec.md#capymoa.base.LearnerSpec), schema: [Any](https://docs.python.org/3/library/typing.html#typing.Any), random_seed: [int](https://docs.python.org/3/builtins/functions.html#int) = 1) → [Any](https://docs.python.org/3/library/typing.html#typing.Any)[[source]](https://github.com/adaptive-machine-learning/CapyMOA/blob/3e255b1/src/capymoa/base/_learner_params.py#L141)

Construct a learner from a serialized fully qualified learner spec.

See [`LearnerParamsMixin`](capymoa.base.LearnerParamsMixin.md#capymoa.base.LearnerParamsMixin) for the parameter capture
and serialization support used by learners.