bci_essentials.classification.null_classifier

 1"""**Null classifier**
 2
 3No model is used.
 4No fitting is done.
 5The classifier always predicts 0.
 6
 7"""
 8
 9# Import bci_essentials modules and methods
10from ..classification.generic_classifier import GenericClassifier, Prediction
11from ..utils.logger import Logger  # Logger wrapper
12
13# Instantiate a logger for the module at the default level of logging.INFO
14# Logs to bci_essentials.__module__) where __module__ is the name of the module
15logger = Logger(name=__name__)
16
17
18class NullClassifier(GenericClassifier):
19    """NullClassifier class (*inherits from GenericClassifier*)."""
20
21    def fit(self):
22        """Fit the classifier to the data.
23
24        No fitting is done.
25
26        Returns
27        -------
28        `None`
29
30        """
31        logger.warning("This is a null classifier, there is no fitting")
32
33    def predict(self, X):
34        """Predict the class of the data.
35
36        Parameters
37        ----------
38        X : numpy.ndarray
39            3D array where shape = (trials, channels, samples)
40
41
42        Returns
43        -------
44        prediction : Prediction
45            Prediction object with labels = [0]
46
47        """
48        logger.warning("This is a null classifier, there is no return value")
49        logger.warning("Returning 0")
50        return Prediction(labels=[0])