0.22.6

PKL_NAME -> filename

Author: bartzbeielstein

notebooks/00_spotMinimal.ipynb

@@ -75,7 +75,7 @@
    "outputs": [],
    "source": [
     "PREFIX=\"RELEVANTE_AERO_VARIABLEN_3551a_04a\" # Prefix unbedingt ändern!\n",
-    "DATA_PKL_NAME = \"RELEVANTE_AERO_VARIABLEN_DATA.pickle\"\n",
+    "DATA_filename = \"RELEVANTE_AERO_VARIABLEN_DATA.pickle\"\n",
     "MAX_TIME = 300\n",
     "FUN_EVALS = inf\n",
     "FUN_REPEATS = 2\n",
@@ -132,7 +132,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "filename = DATA_PKL_NAME\n",
+    "filename = DATA_filename\n",
     "dataset = loadFeaturesFromPkl(param_list=param_list, filename=filename, return_X_y=False)"
    ]
   },
@@ -212,7 +212,7 @@
     "                       surrogate_control=surrogate_control)\n",
     "spot_tuner.run()\n",
     "\n",
-    "SPOT_PKL_NAME = save_experiment(spot_tuner, fun_control)\n",
+    "SPOT_filename = save_experiment(spot_tuner, fun_control)\n",
     "\n",
     "# tensorboard --logdir=\"runs/\""
    ]
@@ -301,7 +301,7 @@
     "# Prefix unbedingt anpassen, wenn ein altes Experiment geladen wird!\n",
     "# Ansonsten wird das oben für das Tuning erstellte PREFIX verwendet.\n",
     "# PREFIX=\"033allbartz09d\" \n",
-    "spot_tuner, fun_control = load_experiment(SPOT_PKL_NAME)"
+    "spot_tuner, fun_control = load_experiment(SPOT_filename)"
    ]
   },
   {

notebooks/00_spotPython_tests.ipynb

@@ -3119,7 +3119,7 @@
     "                surrogate_control=surrogate_control,\n",
     "                optimizer_control=optimizer_control)\n",
     "    # Call the save_experiment function\n",
-    "    pkl_name = save_experiment(\n",
+    "    filename = save_experiment(\n",
     "        spot_tuner=spot_tuner,\n",
     "        fun_control=fun_control,\n",
     "        design_control=None,\n",
@@ -3128,16 +3128,16 @@
     "    )\n",
     "\n",
     "    # Verify that the pickle file is created\n",
-    "    assert os.path.exists(pkl_name)\n",
+    "    assert os.path.exists(filename)\n",
     "\n",
     "    # Call the load_experiment function\n",
-    "    spot_tuner_1, fun_control_1, design_control_1, surrogate_control_1, optimizer_control_1 = load_experiment(pkl_name)\n",
+    "    spot_tuner_1, fun_control_1, design_control_1, surrogate_control_1, optimizer_control_1 = load_experiment(filename)\n",
     "\n",
     "    # Verify the name of the pickle file\n",
-    "    assert pkl_name == f\"spot_{fun_control['PREFIX']}experiment.pickle\"\n",
+    "    assert filename == f\"spot_{fun_control['PREFIX']}experiment.pickle\"\n",
     "\n",
     "    # Clean up the temporary directory\n",
-    "    os.remove(pkl_name)\n"
+    "    os.remove(filename)\n"
    ]
   },
   {

pyproject.toml

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

src/spotpython/utils/file.py

@@ -141,22 +141,22 @@ def load_result(PREFIX) -> tuple:
     if PREFIX is None:
         raise ValueError("No PREFIX provided.")
     filename = get_result_filename(PREFIX)
-    spot_tuner, fun_control, design_control, surrogate_control, optimizer_control = load_experiment(PKL_NAME=filename)
+    spot_tuner, fun_control, design_control, surrogate_control, optimizer_control = load_experiment(filename=filename)
     return spot_tuner, fun_control, design_control, surrogate_control, optimizer_control
 
 
-def load_experiment(PREFIX=None, PKL_NAME=None):
+def load_experiment(PREFIX=None, filename=None):
     """
     Loads the experiment from a pickle file.
-    If PKL_NAME is None and PREFIX is not None, the experiment is loaded based on the PREFIX
+    If filename is None and PREFIX is not None, the experiment is loaded based on the PREFIX
     using the get_experiment_filename function.
     If the spot tuner object and the fun control dictionary do not exist, an error is thrown.
     If the design control, surrogate control, and optimizer control dictionaries do not exist, a warning is issued
     and `None` is assigned to the corresponding variables.
 
     Args:
         PREFIX (str, optional): Prefix of the experiment. Defaults to None.
-        PKL_NAME (str): Name of the pickle file. Defaults to None.
+        filename (str): Name of the pickle file. Defaults to None.
 
     Returns:
         spot_tuner (object): The spot tuner object.
@@ -170,14 +170,14 @@ def load_experiment(PREFIX=None, PKL_NAME=None):
 
     Examples:
         >>> from spotpython.utils.file import load_experiment
-        >>> spot_tuner, fun_control, design_control, _, _ = load_experiment(PKL_NAME="RUN_0.pkl")
+        >>> spot_tuner, fun_control, design_control, _, _ = load_experiment(filename="RUN_0.pkl")
 
     """
-    if PKL_NAME is None and PREFIX is not None:
-        PKL_NAME = get_experiment_filename(PREFIX)
-    with open(PKL_NAME, "rb") as handle:
+    if filename is None and PREFIX is not None:
+        filename = get_experiment_filename(PREFIX)
+    with open(filename, "rb") as handle:
         experiment = pickle.load(handle)
-        print(f"Loaded experiment from {PKL_NAME}")
+        print(f"Loaded experiment from {filename}")
     # assign spot_tuner and fun_control only if they exist otherwise throw an error
     if "spot_tuner" not in experiment:
         raise ValueError("The spot tuner object does not exist in the pickle file.")
@@ -283,11 +283,11 @@ def get_experiment_from_PREFIX(PREFIX, return_dict=True) -> dict:
         return config, fun_control, design_control, surrogate_control, optimizer_control
 
 
-def load_and_run_spot_python_experiment(spot_pkl_name) -> tuple:
+def load_and_run_spot_python_experiment(spot_filename) -> tuple:
     """Loads and runs a spot experiment.
 
     Args:
-        spot_pkl_name (str):
+        spot_filename (str):
             The name of the spot experiment file.
 
     Returns:
@@ -305,7 +305,7 @@ def load_and_run_spot_python_experiment(spot_pkl_name) -> tuple:
 
     """
     p_open = None
-    (spot_tuner, fun_control, design_control, surrogate_control, optimizer_control) = load_experiment(spot_pkl_name)
+    (spot_tuner, fun_control, design_control, surrogate_control, optimizer_control) = load_experiment(spot_filename)
     print("\nLoaded fun_control in spotRun():")
     # pprint.pprint(fun_control)
     print(gen_design_table(fun_control))

test/test_load_experiment.py

@@ -58,7 +58,7 @@ def test_save_and_load_experiment(tmp_path):
     assert os.path.exists(filepath), f"File {filepath} should exist."
 
     # Load the experiment
-    spot_tuner, loaded_fun_control, loaded_design_control, loaded_surrogate_control, loaded_optimizer_control = load_experiment(PKL_NAME=filepath)
+    spot_tuner, loaded_fun_control, loaded_design_control, loaded_surrogate_control, loaded_optimizer_control = load_experiment(filename=filepath)
 
     # Check if the loaded data matches the original data
     assert compare_dicts(loaded_fun_control, fun_control), "Loaded fun_control should match the original fun_control."