SPOT Examples updated

Author: bartzbeielstein

docs/examples.md

@@ -2,30 +2,61 @@
 
 ## Simple spotPython run
 
-```python
+```{python}
 import numpy as np
-from math import inf
-from spotPython.fun.objectivefunctions import analytical
 from spotPython.spot import spot
-# number of initial points:
-ni = 7
-# number of points
-n = 10
-
-fun = analytical().fun_sphere
-lower = np.array([-1])
-upper = np.array([1])
-design_control={"init_size": ni}
-
-spot_1 = spot.Spot(fun=fun,
-            lower = lower,
-            upper= upper,
-            fun_evals = n,
-            show_progress=True,
-            design_control=design_control,)
-spot_1.run()
+from spotPython.fun.objectivefunctions import analytical
+from spotPython.utils.init import fun_control_init, design_control_init, surrogate_control_init
+
+fun = analytical().fun_branin
+fun_control = fun_control_init(lower = np.array([-5, 0]),
+                               upper = np.array([10, 15]),
+                               fun_evals=20)
+design_control = design_control_init(init_size=10)
+surrogate_control = surrogate_control_init(n_theta=2)
+S = spot.Spot(fun=fun, fun_control=fun_control, design_control=design_control)
+S.run()
+```
+
+```raw
+spotPython tuning: 3.146824136952164 [######----] 55.00% 
+spotPython tuning: 3.146824136952164 [######----] 60.00% 
+spotPython tuning: 3.146824136952164 [######----] 65.00% 
+spotPython tuning: 3.146824136952164 [#######---] 70.00% 
+spotPython tuning: 1.1487233101571483 [########--] 75.00% 
+spotPython tuning: 1.0236891516766402 [########--] 80.00% 
+spotPython tuning: 0.41994270072214057 [########--] 85.00% 
+spotPython tuning: 0.40193544341108023 [#########-] 90.00% 
+spotPython tuning: 0.3991519598268951 [##########] 95.00% 
+spotPython tuning: 0.3991519598268951 [##########] 100.00% Done...
 ```
 
+
+```python
+S.print_results()
+```
+
+```raw
+min y: 0.3991519598268951
+x0: 3.1546575195040987
+x1: 2.285931113926263
+```
+
+
+```{python}
+S.plot_progress(log_y=True)
+```
+
+![spotPython progress plot](./images/plot-progress.png)
+
+
+```{python}
+S.surrogate.plot()
+```
+
+![spotPython surrogate plot](./images/surrogate-plot.png)
+
+
 ## Further Examples
 
-Examples can be found in the Hyperparameter Tuning Cookbook, e.g., [Documentation of the Sequential Parameter Optimization](https://sequential-parameter-optimization.github.io/Hyperparameter-Tuning-Cookbook/99_spot_doc.html).
+Examples can be found in the Hyperparameter Tuning Cookbook, e.g., [Documentation of the Sequential Parameter Optimization](https://sequential-parameter-optimization.github.io/Hyperparameter-Tuning-Cookbook/a_04_spot_doc.html).

docs/images/plot-progress.png

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