Merge branch 'development' into v2.4.0

Author: mwever

.github/workflows/citation.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out a copy of the repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Check whether the citation metadata from CITATION.cff is valid
         uses: citation-file-format/cffconvert-github-action@2.0.0

.github/workflows/dist.yml

@@ -28,7 +28,7 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
 
     - name: Setup Python
       uses: actions/setup-python@v6

.github/workflows/docs.yml

@@ -17,7 +17,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
           python-version: "3.10"

.github/workflows/pre-commit-update.yml

@@ -11,7 +11,7 @@ jobs:
   auto-update:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - uses: actions/setup-python@v6
 

.github/workflows/pre-commit.yml

@@ -27,7 +27,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
       with:
         submodules: recursive
 

.github/workflows/pytest.yml

@@ -54,7 +54,7 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
 
     - name: Setup Python
       uses: actions/setup-python@v6
@@ -108,7 +108,7 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
 
     - name: Conda install
       uses: conda-incubator/setup-miniconda@v3
@@ -148,7 +148,7 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
 
     - name: Setup Python
       uses: actions/setup-python@v6

.gitignore

@@ -133,9 +133,13 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
+# SMAC Logs
 *smac3-output_*
 *smac3_output*
 
+# Dask Logs
+tmp/smac_dask_slurm
+
 # macOS files
 .DS_Store
 
@@ -150,4 +154,5 @@ src
 .vscode
 
 projects
-_api
+_api
+branin.pkl

CHANGELOG.md

@@ -10,9 +10,11 @@
 - Ask and tell without initial design and warmstarting
 - Random forest replacement (sklearn instead of pyrfr)
 - Deterministic configuration of SMAC
+- Add a description of parallelization in the documentation (#1226)
 
 ## Examples
 - Add target function with additional arguments (#1134)
+- Adapt parallelization example (#1214)
 
 ## Bugfixes 
 - Ask and tell without initial design may no longer return a config from the initial design - if it is not "removed".

docs/advanced_usage/11_reproducibility.md

@@ -1,3 +1,6 @@
 # Reproducibility
 
-Reproducibility can only be ensured if one worker is used and no time (wallclock or CPU time) is involved.
+Reproducibility can only be ensured if one worker is used and no time (wallclock or CPU time) is involved.
+
+!!! warning
+    SMBO.reset() will not seed smac with the original seed. If you want to have a full reset, please set the seed again after calling reset.

docs/advanced_usage/1_components.md

@@ -96,15 +96,18 @@ The acquisition maximizer also incorporates the [Random Design][random-design].
 ## [Initial Design][smac.initial_design.abstract_initial_design]
 
 The surrogate model needs data to be trained. Therefore, the initial design is used to generate the initial data points.
-We provide random, latin hypercube, sobol, factorial and default initial designs. The default initial design uses
-the default configuration from the configuration space and with the factorial initial design, we generate corner
-points of the configuration space. The sobol sequences are an example of quasi-random low-discrepancy sequences and
-the latin hypercube design is a statistical method for generating a near-random sample of parameter values from
+We provide [random][smac.initial_design.random_design], [latin hypercube][smac.initial_design.latin_hypercube_design], [sobol][smac.initial_design.sobol_design], [factorial][smac.initial_design.factorial_design] and [default-based][smac.initial_design.default_design] initial designs. The [default-based][smac.initial_design.default_design] initial design uses
+the default configuration from the configuration space and with the [factorial initial design][smac.initial_design.factorial_design], we generate corner
+points of the configuration space. The [sobol initial design][smac.initial_design.sobol_design] uses quasi-random low-discrepancy sequences and
+the [latin hypercube initial design][smac.initial_design.latin_hypercube_design] is a statistical method for generating a near-random sample of parameter values from
 a multidimensional distribution.
 
 The initial design configurations are yielded by the config selector first. Moreover, the config selector keeps
 track of which configurations already have been returned to make sure a configuration is not returned twice.
 
+!!! warning
+    Distributions provided in the initial design are ignored. 
+
 [](){#random-design}
 ## [Random Design][smac.initial_design.random_design]