v0.40.0

Author: bartzbeielstein

notebooks/00_spot_doc.ipynb

@@ -1492,6 +1492,46 @@
     "return_conf_list_from_var_dict(var_dict, fun_control)[0]"
    ]
   },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Test Designs"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "array([[0.66352963, 0.5892358 ],\n",
+       "       [0.66352963, 0.5892358 ],\n",
+       "       [0.55592803, 0.96312564],\n",
+       "       [0.55592803, 0.96312564],\n",
+       "       [0.16481882, 0.0375811 ],\n",
+       "       [0.16481882, 0.0375811 ],\n",
+       "       [0.215331  , 0.34468512],\n",
+       "       [0.215331  , 0.34468512],\n",
+       "       [0.83604909, 0.62202146],\n",
+       "       [0.83604909, 0.62202146]])"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "import numpy as np\n",
+    "from spotPython.design.spacefilling import spacefilling\n",
+    "lhd = spacefilling(k=2, seed=123)\n",
+    "lhd.scipy_lhd(n=5, repeats=2, lower=np.array([0,0]), upper=np.array([1,1]))"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,

pyproject.toml

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

src/spotPython/design/spacefilling.py

@@ -38,6 +38,21 @@ def scipy_lhd(
 
         Returns:
             (numpy.ndarray): Latin hypercube design.
+        Examples:
+            >>> from spotPython.design.spacefilling import spacefilling
+                import numpy as np
+                lhd = spacefilling(k=2, seed=123)
+                lhd.scipy_lhd(n=5, repeats=2, lower=np.array([0,0]), upper=np.array([1,1]))
+                array([[0.66352963, 0.5892358 ],
+                [0.66352963, 0.5892358 ],
+                [0.55592803, 0.96312564],
+                [0.55592803, 0.96312564],
+                [0.16481882, 0.0375811 ],
+                [0.16481882, 0.0375811 ],
+                [0.215331  , 0.34468512],
+                [0.215331  , 0.34468512],
+                [0.83604909, 0.62202146],
+                [0.83604909, 0.62202146]])
         """
         if lower is None:
             lower = zeros(self.k)

src/spotPython/spot/spot.py

@@ -316,8 +316,8 @@ def append_X_ocba(self, X_ocba, X0):
         else:
             return X0
 
-    def run(self):
-        self.initialize_design()
+    def run(self, X_start=None):
+        self.initialize_design(X_start)
         # (S-5) Calling the spotLoop Function
         # and
         # (S-9) Termination Criteria, Conditions:
@@ -334,14 +334,19 @@ def run(self):
             self.show_progress_if_needed(timeout_start)
         return self
 
-    def initialize_design(self):
+    def initialize_design(self, X_start=None):
         # (S-2) Initial Design:
         X0 = self.generate_design(
             size=self.design_control["init_size"],
             repeats=self.design_control["repeats"],
             lower=self.lower,
             upper=self.upper,
         )
+        if X_start is not None:
+            try:
+                X0 = append(X_start, X0, axis=0)
+            except ValueError:
+                logger.warning("X_start has wrong shape. Ignoring it.")
         X0 = repair_non_numeric(X0, self.var_type)
         self.X = X0
         # (S-3): Eval initial design:

src/spotPython/utils/eda.py

@@ -78,3 +78,13 @@ def gen_design_table(fun_control: dict, spot: object = None, tablefmt="github")
             tablefmt=tablefmt,
         )
     return tab
+
+
+def compare_two_tree_models(model1, model2, headers=["Parameter", "Default", "Spot"]):
+    keys = model1[1].summary.keys()
+    values1 = model1[1].summary.values()
+    values2 = model2[1].summary.values()
+    tbl = []
+    for key, value1, value2 in zip(keys, values1, values2):
+        tbl.append([key, value1, value2])
+    return tabulate(tbl, headers=headers, numalign="right", tablefmt="github")