0.14.11

save_experiment

Author: bartzbeielstein

pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "spotpython"
-version = "0.14.10"
+version = "0.14.11"
 authors = [
   { name="T. Bartz-Beielstein", email="tbb@bartzundbartz.de" }
 ]

src/spotPython/utils/file.py

@@ -9,7 +9,7 @@
 # from torch.utils.tensorboard import SummaryWriter
 
 
-def load_data(data_dir="./data"):
+def load_cifar10_data(data_dir="./data"):
     """Loads the CIFAR10 dataset.
 
     Args:
@@ -19,16 +19,13 @@ def load_data(data_dir="./data"):
         trainset (torchvision.datasets.CIFAR10): Training dataset.
 
     Examples:
-        >>> from spotPython.utils.file import load_data
-        >>> trainset = load_data(data_dir="./data")
+        >>> from spotPython.utils.file import load_cifar10_data
+        >>> trainset = load_cifar10_data(data_dir="./data")
 
     """
     transform = transforms.Compose([transforms.ToTensor(), transforms.Normalize((0.5, 0.5, 0.5), (0.5, 0.5, 0.5))])
-
     trainset = torchvision.datasets.CIFAR10(root=data_dir, train=True, download=True, transform=transform)
-
     testset = torchvision.datasets.CIFAR10(root=data_dir, train=False, download=True, transform=transform)
-
     return trainset, testset
 
 
@@ -106,6 +103,9 @@ def load_experiment(PKL_NAME):
         surrogate_control (dict): The surrogate control dictionary.
         optimizer_control (dict): The optimizer control dictionary.
 
+    Notes:
+        The corresponding save_experiment function is part of the class spot.
+
     """
     with open(PKL_NAME, "rb") as handle:
         experiment = pickle.load(handle)

src/spotPython/utils/init.py

@@ -51,6 +51,7 @@ def fun_control_init(
     prep_model=None,
     prep_model_name=None,
     progress_file=None,
+    scenario=None,
     seed=123,
     show_models=False,
     show_progress=True,
@@ -175,6 +176,8 @@ def fun_control_init(
             The name of the preprocessing model. Default is None.
         progress_file (str):
             The name of the progress file. Default is None.
+        scenario (str):
+            The scenario to use. Default is None. Can be "river", "sklearn", or "lightning".
         seed (int):
             The seed to use for the random number generator. Default is 123.
         sigma (float):
@@ -275,8 +278,9 @@ def fun_control_init(
                 'optimizer': None,
                 'path': None,
                 'prep_model': None,
-                prep_model_name': None,
+                'prep_model_name': None,
                 'save_model': False,
+                'scenario': "lightning",
                 'seed': 1234,
                 'show_batch_interval': 1000000,
                 'shuffle': None,
@@ -383,6 +387,7 @@ def fun_control_init(
         "prep_model_name": prep_model_name,
         "progress_file": progress_file,
         "save_model": False,
+        "scenario": scenario,
         "seed": seed,
         "show_batch_interval": 1_000_000,
         "show_models": show_models,