Skip to content

Commit c037fbd

Browse files
docs
1 parent a549f78 commit c037fbd

3 files changed

Lines changed: 16 additions & 6 deletions

File tree

docs/examples.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
## Simple spotPython run
44

5+
```python
56
import numpy as np
67
from spotPython.fun.objectivefunctions import analytical
78
from spotPython.spot import spot
@@ -23,4 +24,9 @@ spot_1 = spot.Spot(fun=fun,
2324
fun_evals = n,
2425
show_progress=True,
2526
design_control=design_control,)
26-
spot_1.run()
27+
spot_1.run()
28+
```
29+
30+
## Further Examples
31+
32+
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).

img/favicon.png

11.3 KB
Loading

mkdocs.yml

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,10 @@ nav:
1010
- About: about.md
1111
theme:
1212
name: material
13-
favicon: img/favicon.png
14-
logo: img/spotLogo.png
13+
favicon:
14+
- img/favicon.png
15+
logo:
16+
- img/spotLogo.png
1517
plugins:
1618
- search:
1719
- gen-files:
@@ -20,10 +22,12 @@ plugins:
2022
- literate-nav:
2123
nav_file: SUMMARY.md
2224
- section-index
23-
watch:
24-
- src/spotPython
25+
- mkdocstrings:
2526
markdown_extensions:
2627
- smarty
2728
- toc:
2829
permalink: True
29-
- sane_lists
30+
- sane_lists
31+
use_directory_urls: true
32+
watch:
33+
- src/spotPython

0 commit comments

Comments
 (0)