bci_essentials.session_saving

 1"""
 2This module contains functions for saving and loading sessions.
 3"""
 4
 5import os
 6import pickle
 7
 8from .utils.logger import Logger  # Logger wrapper
 9
10# Instantiate a logger for the module at the default level of logging.INFO
11# Logs to bci_essentials.__module__) where __module__ is the name of the module
12logger = Logger(name=__name__)
13
14# Define a module-level variable for the session save path
15# This is the local path to the session_saves directory in the package root
16session_save_path = os.path.join(
17    os.path.dirname(os.path.dirname(__file__)), "session_saves"
18)
19
20
21def save_classifier(classifier, filename):
22    """
23    Saves a classifier to a file.
24
25    Parameters
26    ----------
27    classifier : object
28        The classifier object to be saved.
29    filename : str
30        The name of the file to save the classifier to.
31    """
32
33    # Join filename to session_saves directory in package root
34    filepath = os.path.join(session_save_path, filename)
35
36    with open(filepath, "wb") as f:
37        pickle.dump(classifier, f)
38    logger.debug("Saved classifier to %s", filepath)
39
40
41def load_classifier(filename):
42    """
43    Loads a classifier from a file.
44
45    Parameters
46    ----------
47    filename : str
48        The name of the file to load the classifier from.
49
50    Returns
51    -------
52    classifier : object
53        The classifier object that was loaded.
54    """
55
56    # Join filename to session_saves directory in package root
57    filepath = os.path.join(session_save_path, filename)
58
59    with open(filepath, "rb") as f:
60        classifier = pickle.load(f)
61    logger.debug("Loaded classifier from %s", filepath)
62    return classifier