automl
diff --git a/‎.github/workflows/docs.yml
Lines changed: 15 additions & 77 deletions b/‎.github/workflows/docs.yml
Lines changed: 15 additions & 77 deletions
diff --git a/‎.github/workflows/pre-commit-update.yml
Lines changed: 1 addition & 1 deletion b/‎.github/workflows/pre-commit-update.yml
Lines changed: 1 addition & 1 deletion
diff --git a/‎.github/workflows/recent_reminder.yml
Lines changed: 1 addition & 1 deletion b/‎.github/workflows/recent_reminder.yml
Lines changed: 1 addition & 1 deletion
diff --git a/‎.gitignore
Lines changed: 4 additions & 1 deletion b/‎.gitignore
Lines changed: 4 additions & 1 deletion
diff --git a/‎CHANGELOG.md
Lines changed: 30 additions & 3 deletions b/‎CHANGELOG.md
Lines changed: 30 additions & 3 deletions
diff --git a/‎CITATION.cff
Lines changed: 1 addition & 1 deletion b/‎CITATION.cff
Lines changed: 1 addition & 1 deletion
diff --git a/‎LICENSE.txt
Lines changed: 1 addition & 1 deletion b/‎LICENSE.txt
Lines changed: 1 addition & 1 deletion
diff --git a/‎Makefile
Lines changed: 24 additions & 14 deletions b/‎Makefile
Lines changed: 24 additions & 14 deletions
diff --git a/‎README.md
Lines changed: 2 additions & 2 deletions b/‎README.md
Lines changed: 2 additions & 2 deletions
diff --git a/‎docs/10_experimental.rst renamed to ‎docs/10_experimental.md
Lines changed: 22 additions & 21 deletions b/‎docs/10_experimental.rst renamed to ‎docs/10_experimental.md
Lines changed: 22 additions & 21 deletions
@@ -1,89 +1,27 @@
+# This workflow is just to test that the docs build successfully.
 name: docs
-
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
 on:
-  # 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
   push:
     branches:
       - main
-      - development
-
-  # Trigger on open/push to a PR targeting one of these branches
   pull_request:
-    types:
-      - opened
-      - synchronize
-      - reopened
-      - ready_for_review
     branches:
       - main
-      - development
-
-env:
-  name: SMAC3
-
+permissions:
+  contents: write
 jobs:
-  build-and-deploy:
-    if: ${{ !github.event.pull_request.draft }}
+  build:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout
-      uses: actions/checkout@v4
-
-    - name: Setup Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: "3.10"
-
-    - name: Install dependencies
-      id: install
-      run: |
-        pip install ".[gpytorch,dev]"
-
-        # Getting the version
-        SMAC_VERSION=$(python -c "import smac; print('v' + str(smac.version));")
-
-        # Make it a global variable
-        echo "SMAC_VERSION=$SMAC_VERSION" >> $GITHUB_ENV
-
-    - name: Make docs
-      run: |
-        make clean
-        make docs
-
-    - name: Pull latest gh-pages
-      if: (contains(github.ref, 'develop') || contains(github.ref, 'main')) && github.event_name == 'push'
-      run: |
-        cd ..
-        git clone https://github.com/${{ github.repository }}.git --branch gh-pages --single-branch gh-pages
-
-    - name: Copy new docs into gh-pages
-      if: (contains(github.ref, 'develop') || contains(github.ref, 'main')) && github.event_name == 'push'
-      run: |
-        branch_name=${GITHUB_REF##*/}
-        cd ../gh-pages
-        rm -rf $branch_name
-        cp -r ../${{ env.name }}/docs/build/html $branch_name
-
-        # we also copy the current SMAC_VERSION
-        rm -rf $SMAC_VERSION
-        cp -r ../${{ env.name }}/docs/build/html $SMAC_VERSION
-
-
-    - name: Push to gh-pages
-      if: (contains(github.ref, 'develop') || contains(github.ref, 'main')) && github.event_name == 'push'
-      run: |
-        last_commit=$(git log --pretty=format:"%an: %s")
-        cd ../gh-pages
-        branch_name=${GITHUB_REF##*/}
-        git add $branch_name/
-        git add $SMAC_VERSION/
-        git config --global user.name 'Github Actions'
-        git config --global user.email '[email protected]'
-        git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
-        git commit -am "$last_commit"
-        git push
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: "Install dependancies"
+        run: python -m pip install -e ".[dev]"
+      - name: "Build Docs"
+        run: mkdocs build --clean --strict
@@ -21,7 +21,7 @@ jobs:
         run: |
             pre-commit run --all-files
 
-      - uses: peter-evans/create-pull-request@v6
+      - uses: peter-evans/create-pull-request@v7
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           branch: update/pre-commit-hooks
 
@@ -32,7 +32,7 @@ jobs:
         echo "$(<recent_issues.md) <br />" >> mail.html
     - name: Send mail
       id: mail
-      uses: dawidd6/action-send-mail@v3
+      uses: dawidd6/action-send-mail@v4
       with:
         server_address: ${{secrets.MAIL_SERVER_ADDRESS}}
         server_port: ${{secrets.MAIL_SERVER_PORT}}
 
@@ -147,4 +147,7 @@ src
 
 # Pycharm
 .idea
-.vscode
+.vscode
+
+projects
+_api
@@ -1,10 +1,37 @@
+# 2.3.0
+
+## Documentation
+- Update windows install guide (#952)
+- Correct intensifier for Algorithm Configuration Facade (#1162, #1165)
+- Migrate sphinx docs to mkdocs (#1155)
+
+## Bugfixes
+- Fix bug in differential evolution acquisition maximizer in case the search space contains categorical hyperparameters (#1150)
+- Fix wrong attr query in the target function runner (crash cost) (#1176)
+- Fix kwargs for DifferentialEvolution (#1187)
+- Fix PiBo implementation (#1076)
+- Add fix for local search running forever (#1194)
+
+## Improvements
+- Add logger information on handling of stopIteration error (#960)
+- Replace deprecated ConfigSpace methods (#1139)
+- Separated Wallclock time measurements from CPU time measurements and storing them under new 'cpu_time' variable (#1173)
+- Adapt RunHistory to be human readable (# 1174)
+
+## Dependencies
+- Allow numpy >= 2.x (#1146)
+
+# Examples
+- Add warmstarting example (#1120)
+
 # 2.2.0
 
-## Features
+## Examples
 - Add example to specify total budget (fidelity units) instead of n_trials for multi-fidelity/Hyperband (#1121)
+- Add example for warmstarting (#1120)
 
 ## Dependencies
-- Update numpy NaN (#1122) and restrict numpy version
+- Update numpy NaN (#1122) and restrict numpy
 - Upgrade to ConfigSpace 1.x.x (#1124)
 
 # 2.1.0
@@ -675,7 +702,7 @@ Since many urgent features were already taken care of in 0.14.0, this release ma
   conditions when starting multiple runs on a cluster.
 * MAINT #209: adds the seed or a pseudo-seed to the output directory name for
   better identifiability of the output directories.
-* FIX #216: replace broken call to in EIPS acqusition function.
+* FIX #216: replace broken call to in EIPS acquisition function.
 * MAINT: use codecov.io instead of coveralls.io.
 * MAINT: increase minimal required version of the ConfigSpace package to 0.3.2.
 
 
@@ -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.2.0"
+version: "2.3.0"
 
 type: "software"
 keywords:
 
@@ -4,7 +4,7 @@ SMAC License
 
 BSD 3-Clause License
 
-Copyright (c) 2016-2018, Ml4AAD Group (http://www.ml4aad.org/)
+Copyright (c) 2025, Leibniz University Hannover - Institute of AI (https://www.ai.uni-hannover.de/)
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 
@@ -5,7 +5,7 @@ SHELL := /bin/bash
 
 NAME := SMAC3
 PACKAGE_NAME := smac
-VERSION := 2.2.0
+VERSION := 2.3.0
 
 DIR := "${CURDIR}"
 SOURCE_DIR := ${PACKAGE_NAME}
@@ -86,27 +86,37 @@ format: format-black format-isort
 tests:
 	$(PYTEST) ${TESTS_DIR}
 
+# Launch the docs, executing code blocks and examples
+docs-full:
+	$(PYTHON) -m webbrowser -t "http://127.0.0.1:8000/"
+	SMAC_DOC_RENDER_EXAMPLES=all \
+		SMAC_DOCS_OFFLINE=true \
+		SMAC_EXEC_DOCS=true \
+		mkdocs serve --watch-theme
+
+# Launch the docs and execute code blocks
+docs-code:
+	$(PYTHON) -m webbrowser -t "http://127.0.0.1:8000/"
+	SMAC_DOCS_OFFLINE=true \
+		SMAC_EXEC_DOCS=true \
+		SMAC_DOC_RENDER_EXAMPLES=false \
+		mkdocs serve --watch-theme
+
+# Launch the docs but dont run code examples
 docs:
-	$(MAKE) -C ${DOCDIR} docs
-	@echo
-	@echo "View docs at:"
-	@echo ${INDEX_HTML}
-
-examples:
-	$(MAKE) -C ${DOCDIR} examples
-	@echo
-	@echo "View docs at:"
-	@echo ${INDEX_HTML}
+	$(PYTHON) -m webbrowser -t "http://127.0.0.1:8000/"
+	SMAC_DOCS_OFFLINE=true \
+		SMAC_EXEC_DOCS=false \
+		SMAC_DOC_RENDER_EXAMPLES=false \
+		mkdocs serve --watch-theme
+	# https://github.com/pawamoy/markdown-exec/issues/19
 
 # Build a distribution in ./dist
 build:
 	$(PYTHON) setup.py sdist
 
 clean: clean-build clean-docs clean-data
 
-clean-docs:
-	$(MAKE) -C ${DOCDIR} clean
-
 clean-build:
 	$(PYTHON) setup.py clean
 	rm -rf ${DIST}
 
@@ -12,7 +12,7 @@ SMAC offers a robust and flexible framework for Bayesian Optimization to support
 hyperparameter configurations for their (Machine Learning) algorithms, datasets and applications at hand. The main core 
 consists of Bayesian Optimization in combination with an aggressive racing mechanism to efficiently decide which of two configurations performs better.
 
-SMAC3 is written in Python3 and continuously tested with Python 3.8, 3.9, and 3.10. Its Random
+SMAC3 is written in Python3 and continuously tested with Python 3.8, 3.9, and 3.10 (and works with newer python versions). Its Random
 Forest is written in C++. In further texts, SMAC is representatively mentioned for SMAC3.
 
 > [Documentation](https://automl.github.io/SMAC3)
@@ -144,4 +144,4 @@ If you use SMAC in one of your research projects, please cite our
 }
 ```
 
-Copyright (C) 2016-2022  [AutoML Group](http://www.automl.org).
+Copyright (c) 2025, [Leibniz University Hannover - Institute of AI](https://www.ai.uni-hannover.de/)
@@ -1,12 +1,10 @@
-Experimental
-============
+# Experimental
 
-.. warning::
+!!! 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
-------------------------------
+## Installation in Windows via WSL
 
 SMAC can be installed in a WSL (Windows Subsystem for Linux) under Windows.
 
@@ -21,28 +19,31 @@ Download an Anaconda Linux version to drive D under Windows, e.g. D:\\Anaconda3-
 
 In the WSL, Windows resources are mounted under /mnt:
 
-.. code:: bash
-
-    cd /mnt/d
-    bash Anaconda3-2023.03-1-Linux-x86_64
+```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
+```bash
+export PATH="$PATH:/home/${USER}/anaconda3/bin
+```
 
-Input 'python' to check if the installation was successful.
+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
+```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
+```
+
+## Installation in Pure Windows
+Please refer to this [issue](https://github.com/automl/SMAC3/issues/952) for installation instructions for SMAC3-1.4 and SMAC3-2.x.