Version 2.0.2

.github/workflows/dist.yml

@@ -1,7 +1,7 @@
 name: dist
 
 on:
-  # Manual trigger option in github
+  # Manual trigger option in GitHub
   workflow_dispatch:
 
   # Trigger on push to these branches
@@ -10,14 +10,20 @@ on:
       - main
       - development
 
-  # Trigger on a open/push to a PR targeting one of these branches
+  # Trigger on open/push to a PR targeting one of these branches
   pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
     branches:
       - main
       - development
 
 jobs:
   dist:
+    if: ${{ !github.event.pull_request.draft }}
     runs-on: ubuntu-latest
 
     steps:

.github/workflows/docs.yml

@@ -1,9 +1,9 @@
 name: docs
 
 on:
-  # Manual trigger option in github
-  # This won't push to github pages where docs are hosted due
-  # to the gaurded if statement in those steps
+  # Manual trigger option in GitHub
+  # This won't push to GitHub pages where docs are hosted due
+  # to the guarded if statement in those steps
   workflow_dispatch:
 
   # Trigger on push to these branches
@@ -12,8 +12,13 @@ on:
       - main
       - development
 
-  # Trigger on a open/push to a PR targeting one of these branches
+  # Trigger on open/push to a PR targeting one of these branches
   pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
     branches:
       - main
       - development
@@ -23,6 +28,7 @@ env:
 
 jobs:
   build-and-deploy:
+    if: ${{ !github.event.pull_request.draft }}
     runs-on: ubuntu-latest
     steps:
     - name: Checkout

.github/workflows/pre-commit.yml

@@ -1,7 +1,7 @@
 name: pre-commit
 
 on:
-  # Manually triggerable in github
+  # Manually triggerable in GitHub
   workflow_dispatch:
 
   # When a push occurs on either of these branches
@@ -12,12 +12,18 @@ on:
 
   # When a push occurs on a PR that targets these branches
   pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
     branches:
       - main
       - development
 
 jobs:
   run-all-files:
+    if : ${{ !github.event.pull_request.draft }}
     runs-on: ubuntu-latest
 
     steps:

.github/workflows/pytest.yml

@@ -1,7 +1,7 @@
 name: tests
 
 on:
-  # Allow to manually trigger through github API
+  # Allow to manually trigger through GitHub API
   workflow_dispatch:
 
   # Triggers with push to main
@@ -12,6 +12,11 @@ on:
 
   # Triggers with push to a pr aimed at main
   pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
     branches:
       - main
       - development
@@ -34,6 +39,7 @@ jobs:
   # General unit tests
   source-test:
     name: ${{ matrix.python-version }}-${{ matrix.os }}
+    if: ${{ !github.event.pull_request.draft }}
 
     runs-on: ${{ matrix.os }}
     defaults:
@@ -44,7 +50,6 @@ jobs:
       fail-fast: false
       matrix:
         python-version: ["3.8", "3.9", "3.10"]
-        # python-version: ["3.8"]
         os: ["ubuntu-latest"]
 
     steps:
@@ -70,10 +75,10 @@ jobs:
 
     - name: Tests
       run: |
-        pytest ${{ env.pytest-args }} ${{ env.test-dir }}
-
-        # Post-hoc clean-up
-        make clean
+          echo "Running all tests..."
+          pytest ${{ env.pytest-args }} ${{ env.test-dir }}
+          # Post-hoc clean-up
+          make clean
 
     - name: Check for files left behind by test
       run: |
@@ -89,6 +94,7 @@ jobs:
 # Testing with conda
   conda-tests:
     name: conda-${{ matrix.python-version }}-${{ matrix.os }}
+    if: ${{ !github.event.pull_request.draft }}
     runs-on: ${{ matrix.os }}
     defaults:
       run:
@@ -98,7 +104,6 @@ jobs:
       fail-fast: false
       matrix:
         python-version: ["3.8", "3.9", "3.10"]
-        # python-version: ["3.8"]
         os: ["ubuntu-latest"]
 
     steps:
@@ -120,11 +125,15 @@ jobs:
 
     - name: Tests
       run: |
-          pytest ${{ env.pytest-args }} ${{ env.test-dir }}
+        echo "Running all tests..."
+        pytest ${{ env.pytest-args }} ${{ env.test-dir }}
+
+
 
   # Testing a dist install
   dist-test:
     name: dist-${{ matrix.python-version }}-${{ matrix.os }}
+    if: ${{ !github.event.pull_request.draft }}
 
     runs-on: ${{ matrix.os }}
     defaults:
@@ -135,7 +144,6 @@ jobs:
       fail-fast: false
       matrix:
         python-version: ["3.8", "3.9", "3.10"]
-        # python-version: ["3.8"]
         os: ["ubuntu-latest"]
 
     steps:
@@ -161,4 +169,5 @@ jobs:
 
     - name: Tests
       run: |
+        echo "Running all tests..."
         pytest ${{ env.pytest-args }} ${{ env.test-dir }}

.github/workflows/stale_reminder.yml

@@ -9,10 +9,23 @@ jobs:
   stale-reminder:
     runs-on: ubuntu-latest
     steps:
-    - name: Get cutoff date for soon-to-be-stale issues
+    - name: Get cutoff dates
       id: date
       run: |
         echo "CUTOFF_DATE=$(date -d '-46 days' '+%Y-%m-%d')" >> $GITHUB_ENV
+        echo "RECENT_ISSUE_CUTOFF_DATE=$(date -d '-7 days' '+%Y-%m-%d')" >> $GITHUB_ENV
+    - name: Get list of issues that have had interactions in the last week
+      id: recent
+      uses: lee-dohm/select-matching-issues@v1
+      with:
+        format: list
+        path: "recent_issues.md"
+        token: ${{ github.token }}
+        query: >-
+          is:issue
+          is:open
+          updated:>=${{ env.RECENT_ISSUE_CUTOFF_DATE }}
+          sort:updated-asc
     - name: Collect issues that may become stale
       id: stale
       uses: lee-dohm/select-matching-issues@v1
@@ -21,6 +34,7 @@ jobs:
           path: "potentially_stale_issues.md"
           token: ${{ github.token }}
           query: >-
+            is:issue
             is:open
             -label:dependency,documentation,feature,enhancement,bug,test,example,discussion,duplicate,question
             updated:<${{ env.CUTOFF_DATE }}
@@ -33,14 +47,16 @@ jobs:
           path: "old_issues.md"
           token: ${{ github.token }}
           query: >-
+            is:issue
             is:open
             label:dependency,documentation,feature,enhancement,bug,test,example,discussion,duplicate,question
             updated:<${{ env.CUTOFF_DATE }}
             sort:updated-asc
     - name: Combine issues into mail content
       id: combine
       run: |
-        echo $date
+        echo "## Issues that have had interaction in the last 7 days <br />" >> mail.html
+        echo "$(<recent_issues.md) <br />" >> mail.html
         echo "## Issues that may become stale in <= 14 days <br />" >> mail.html
         echo "$(<potentially_stale_issues.md) <br />" >> mail.html
         echo "## Issues that have not had interaction in the last 46 days but will not go stale due to their labels<br />" >> mail.html

CHANGELOG.md

@@ -1,3 +1,16 @@
+# 2.0.2
+
+## Improvements
+- Add an error when we get an empty dict data_to_scatter so that we can avoid an internal error caused in Dask precautiously
+- Add experimental instruction for installing SMAC in Windows via a WSL.
+- More detailed documentation regarding continuing runs.
+
+## Bugfixes
+- Fix bug in the incumbent selection in the case that multi-fidelity is combined with multi-objective (#1019).
+- Fix callback order (#1040).
+- Handle configspace as dictionary in mlp and parego example.
+- Adapt sgd loss to newest scikit-learn version.
+
 # 2.0.1
 
 ## Improvements

CITATION.cff

@@ -9,7 +9,7 @@ date-released: "2016-08-17"
 url: "https://automl.github.io/SMAC3/master/index.html"
 repository-code: "https://github.com/automl/SMAC3"
 
-version: "2.0.1"
+version: "2.0.2"
 
 type: "software"
 keywords:

Makefile

@@ -5,7 +5,7 @@ SHELL := /bin/bash
 
 NAME := SMAC3
 PACKAGE_NAME := smac
-VERSION := 2.0.1
+VERSION := 2.0.2
 
 DIR := "${CURDIR}"
 SOURCE_DIR := ${PACKAGE_NAME}

benchmark/src/wrappers/v20.py

@@ -6,7 +6,7 @@
 
 
 class Version20(Wrapper):
-    supported_versions: list[str] = ["2.0.1"]
+    supported_versions: list[str] = ["2.0.2"]
 
     def __init__(self, task: Task, seed: int) -> None:
         super().__init__(task, seed)

docs/10_experimental.rst

@@ -0,0 +1,48 @@
+Experimental
+============
+
+.. warning::
+    This part is experimental and might not work in each case. If you would like to suggest any changes, please let us know. 
+
+
+Installation in Windows via WSL
+------------------------------
+
+SMAC can be installed in a WSL (Windows Subsystem for Linux) under Windows.
+
+**1) Install WSL under Windows**
+
+Install WSL under Windows. This SMAC installation workflow was tested with Ubuntu 18.04. For Ubuntu 20.04, 
+it has been observed that the SMAC installation results in a segmentation fault (core dumped).
+
+**2) Get Anaconda**
+
+Download an Anaconda Linux version to drive D under Windows, e.g. D:\\Anaconda3-2023.03-1-Linux-x86_64
+
+In the WSL, Windows resources are mounted under /mnt:
+
+.. code:: bash
+
+    cd /mnt/d
+    bash Anaconda3-2023.03-1-Linux-x86_64
+
+Enter this command to create the environment variable:
+
+.. code:: bash
+
+    export PATH="$PATH:/home/${USER}/anaconda3/bin
+
+Input 'python' to check if the installation was successful.
+
+**3) Install SMAC**
+
+Change to your home folder and install the general software there:
+
+.. code:: bash
+
+    cd /home/${USER}
+    sudo apt-get install software-properties-common
+    sudo apt-get update
+    sudo apt-get install build-essential swig
+    conda install gxx_linux-64 gcc_linux-64 swig
+    curl https://raw.githubusercontent.com/automl/smac3/master/requirements.txt | xargs -n 1 -L 1 pip install

docs/1_installation.rst

@@ -68,3 +68,11 @@ You must have `conda >= 4.9` installed. To update conda or check your current co
 
 
 Read `SMAC feedstock <https://github.com/conda-forge/smac-feedstock>`_ for more details.
+
+Windows via WSL (Experimental)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+SMAC can be installed under Windows in a WSL (Windows Subsystem for Linux). 
+You can find an instruction on how to do this here: :ref:`Experimental<Experimental>`.
+However, this is experimental and might not work in each case. 
+If you would like to suggest any changes, please let us know. 

docs/advanced_usage/10_continue.rst

@@ -1,14 +1,23 @@
 Continue
 ========
 
-SMAC automatically restores states where it left off if a run was interrupted or finished. To do so, it reads in old
-files (derived from scenario's name, output_directory and seed) and sets the components.
+SMAC can automatically restore states where it left off if a run was interrupted or prematurely finished. To do so, 
+it reads in old files (derived from scenario's name, output_directory and seed) and obtains the scenario information
+of the previous run from those to continue the run.
+
+The behavior can be controlled by setting the parameter ``overwrite`` in the facade to True or False, respectively:
+
+* If set to True, SMAC overwrites the run results if a previous run is found that is consistent in the meta data with the current setup.
+* If set to False and a previous run is found that
+
+  * is consistent in the meta data, the run is continued. 
+  * is not consistent in the meta data, the user is asked for the exact behaviour (overwrite completely or rename old run first).
 
 .. warning::
 
-    If you changed any code and specified a name, SMAC will ask you whether you still want to resume or
-    delete the old run completely. If you did not specify a name, SMAC generates a new name and the old run is
-    not affected.
+    If you changed any code affecting the run's meta data and specified a name, SMAC will ask you whether you still 
+    want to overwrite the old run or rename the old run first. If you did not specify a name, SMAC generates a new name 
+    and the old run is not affected.
 
 
 Please have a look at our :ref:`continue example<Continue an Optimization>`.