0.9.8

Author: bartzbeielstein

notebooks/testKriging.ipynb

@@ -2019,9 +2019,24 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 1,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "Seed set to 123\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "fun_control: {'CHECKPOINT_PATH': 'runs/saved_models/', 'DATASET_PATH': 'data/', 'RESULTS_PATH': 'results/', 'TENSORBOARD_PATH': 'runs/', '_L_in': None, '_L_out': None, 'data': None, 'data_dir': './data', 'data_module': None, 'data_set': None, 'device': None, 'enable_progress_bar': False, 'eval': None, 'fun_evals': inf, 'k_folds': 3, 'log_level': 10, 'loss_function': None, 'max_time': 1, 'metric_river': None, 'metric_sklearn': None, 'metric_torch': None, 'metric_params': {}, 'model_dict': {}, 'n_samples': None, 'num_workers': 0, 'optimizer': None, 'path': None, 'prep_model': None, 'save_model': False, 'seed': 123, 'show_batch_interval': 1000000, 'show_progress': False, 'shuffle': None, 'sigma': 0.0, 'target_column': None, 'tolerance_x': 0, 'train': None, 'test': None, 'task': 'classification', 'spot_tensorboard_path': None, 'var_name': None, 'var_type': None, 'weights': 1.0, 'spot_writer': None}\n"
+     ]
+    }
+   ],
    "source": [
     "import numpy as np\n",
     "from spotPython.fun.objectivefunctions import analytical\n",

pyproject.toml

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

src/spotPython/hyperparameters/values.py

@@ -1022,7 +1022,7 @@ def create_model(config, fun_control, **kwargs) -> object:
     return fun_control["core_model"](**config, **kwargs)
 
 
-def set_fun_control_key_value(fun_control, key, value, replace=False) -> None:
+def set_control_key_value(fun_control, key, value, replace=False) -> None:
     """
     This function sets the key value pair in the fun_control dictionary.
 
@@ -1042,9 +1042,9 @@ def set_fun_control_key_value(fun_control, key, value, replace=False) -> None:
 
     Examples:
         >>> from spotPython.utils.init import fun_control_init
-            from spotPython.hyperparameters.values import set_fun_control_key_value
+            from spotPython.hyperparameters.values import set_control_key_value
             fun_control = fun_control_init()
-            set_fun_control_key_value(fun_control=fun_control,
+            set_control_key_value(fun_control=fun_control,
                           key="key",
                           value="value")
             fun_control["key"]
@@ -1057,7 +1057,7 @@ def set_fun_control_key_value(fun_control, key, value, replace=False) -> None:
             fun_control.update({key: value})
 
 
-def get_fun_control_key_value(fun_control=None, key=None) -> Any:
+def get_control_key_value(fun_control=None, key=None) -> Any:
     """
     This function gets the key value pair from the fun_control dictionary.
     If the key does not exist, return None.
@@ -1074,9 +1074,9 @@ def get_fun_control_key_value(fun_control=None, key=None) -> Any:
 
     Examples:
         >>> from spotPython.utils.init import fun_control_init
-            from spotPython.hyperparameters.values import get_fun_control_key_value
+            from spotPython.hyperparameters.values import get_control_key_value
             fun_control = fun_control_init()
-            get_fun_control_key_value(fun_control=fun_control,
+            get_control_key_value(fun_control=fun_control,
                             key="key")
             "value"
     """

src/spotPython/spot/spot.py

@@ -32,8 +32,8 @@
 from spotPython.utils.convert import find_indices
 from spotPython.hyperparameters.values import (
     get_bound_values,
-    set_fun_control_key_value,
-    get_fun_control_key_value,
+    set_control_key_value,
+    get_control_key_value,
 )
 import plotly.graph_objects as go
 from typing import Union, Callable, Dict
@@ -240,8 +240,8 @@ def __init__(
         # key "sigma" and the value sigma amd the key "seed" and the value seed.
         # This is a mimimum requirement for the fun_control dictionary to call
         # objective functions from the spotPython.fun.objectivefunctions module.
-        set_fun_control_key_value(fun_control=self.fun_control, key="sigma", value=sigma)
-        set_fun_control_key_value(fun_control=self.fun_control, key="seed", value=seed)
+        set_control_key_value(fun_control=self.fun_control, key="sigma", value=sigma)
+        set_control_key_value(fun_control=self.fun_control, key="seed", value=seed)
         # Random number generator:
         self.rng = default_rng(self.fun_control["seed"])
 
@@ -400,8 +400,8 @@ def set_self_attribute(self, attribute, value, dict):
             dict (dict): the dictionary to check for the key
         """
         setattr(self, attribute, value)
-        if get_fun_control_key_value(fun_control=dict, key=attribute) is not None:
-            setattr(self, attribute, get_fun_control_key_value(fun_control=dict, key=attribute))
+        if get_control_key_value(fun_control=dict, key=attribute) is not None:
+            setattr(self, attribute, get_control_key_value(fun_control=dict, key=attribute))
 
     def get_spot_attributes_as_df(self) -> pd.DataFrame:
         """Get all attributes of the spot object as a pandas dataframe.

src/spotPython/utils/init.py

@@ -1,7 +1,7 @@
 import os
 import lightning as L
 import datetime
-from math import inf
+
 
 # PyTorch TensorBoard support
 from torch.utils.tensorboard import SummaryWriter
@@ -13,7 +13,7 @@ def fun_control_init(
     TENSORBOARD_CLEAN=False,
     device=None,
     enable_progress_bar=False,
-    fun_evals=inf,
+    fun_evals=15,
     log_level=10,
     max_time=1,
     num_workers=0,

test/test_values.py

@@ -2,7 +2,7 @@
 import numpy as np
 from spotPython.utils.init import fun_control_init
 from spotPython.hyperparameters.values import get_bound_values
-from spotPython.hyperparameters.values import get_fun_control_key_value, set_fun_control_key_value
+from spotPython.hyperparameters.values import get_control_key_value, set_control_key_value
 
 
 def test_get_bound_values():
@@ -29,35 +29,35 @@ def test_get_bound_values():
         get_bound_values(fun_control, "invalid", as_list=True)
 
 
-def test_set_fun_control_key_value():
+def test_set_control_key_value():
     fun_control = fun_control_init()
 
     # Test when key is not in fun_control and replace is False
-    set_fun_control_key_value(fun_control, "key1", "value1")
+    set_control_key_value(fun_control, "key1", "value1")
     assert fun_control["key1"] == "value1"
 
     # Test when key is in fun_control and replace is False
-    set_fun_control_key_value(fun_control, "key1", "value2")
+    set_control_key_value(fun_control, "key1", "value2")
     assert fun_control["key1"] == "value1"
 
     # Test when key is in fun_control and replace is True
-    set_fun_control_key_value(fun_control, "key1", "value2", replace=True)
+    set_control_key_value(fun_control, "key1", "value2", replace=True)
     assert fun_control["key1"] == "value2"
 
     # Test when key is not in fun_control and replace is True
-    set_fun_control_key_value(fun_control, "key2", "value3", replace=True)
+    set_control_key_value(fun_control, "key2", "value3", replace=True)
     assert fun_control["key2"] == "value3"
 
-def test_get_fun_control_key_value():
+def test_get_control_key_value():
     fun_control = fun_control_init()
 
     # Test when key is not in fun_control
-    assert get_fun_control_key_value(fun_control, "key1") is None
+    assert get_control_key_value(fun_control, "key1") is None
 
     # Test when fun_control is None
-    assert get_fun_control_key_value() is None
+    assert get_control_key_value() is None
 
     # Test when key is in fun_control
-    set_fun_control_key_value(fun_control, "key1", "value1")
-    assert get_fun_control_key_value(fun_control, "key1") == "value1"
+    set_control_key_value(fun_control, "key1", "value1")
+    assert get_control_key_value(fun_control, "key1") == "value1"