diff --git a/CHANGELOG.md b/CHANGELOG.md index 9c2ce0534..36b2d614d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +# 2.3.1 + +## Misc +- New SMAC logo +- Fix doc link in README + # 2.3.0 ## Documentation diff --git a/CITATION.cff b/CITATION.cff index 949c6bbe9..35d457a01 100644 --- a/CITATION.cff +++ b/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.3.0" +version: "2.3.1" type: "software" keywords: diff --git a/Makefile b/Makefile index c1b56afd5..85283f60d 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,7 @@ SHELL := /bin/bash NAME := SMAC3 PACKAGE_NAME := smac -VERSION := 2.3.0 +VERSION := 2.3.1 DIR := "${CURDIR}" SOURCE_DIR := ${PACKAGE_NAME} diff --git a/README.md b/README.md index 65d2a8ed5..17e980ea6 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ consists of Bayesian Optimization in combination with an aggressive racing mecha 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) +> [Documentation](https://automl.github.io/SMAC3/latest/) > [Roadmap](https://github.com/orgs/automl/projects/5/views/2) @@ -36,7 +36,7 @@ We hope you enjoy this new user experience as much as we do. 🚀 ## Installation -This instruction is for the installation on a Linux system, for Windows and Mac and further information see the [documentation](https://automl.github.io/SMAC3/main/1_installation.html). +This instruction is for the installation on a Linux system, for Windows and Mac and further information see the [documentation](https://automl.github.io/SMAC3/latest/1_installation/). Create a new environment with python 3.10 and make sure swig is installed either on your system or inside the environment. We demonstrate the installation via anaconda in the following: @@ -94,7 +94,7 @@ smac = HyperparameterOptimizationFacade(scenario, train) incumbent = smac.optimize() ``` -More examples can be found in the [documentation](https://automl.github.io/SMAC3/main/examples/). +More examples can be found in the [documentation](https://automl.github.io/SMAC3/latest/examples/1%20Basics/1_quadratic_function/). ## Visualization via DeepCAVE diff --git a/docs/conf.py b/docs/conf.py index 7166d1df3..f929abc2e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,6 +12,7 @@ "version": version, "versions": { f"v{version}": "#", + "v2.3.1": "https://automl.github.io/SMAC3/v2.3.1/", "v2.3.0": "https://automl.github.io/SMAC3/v2.3.0/", "v2.2.0": "https://automl.github.io/SMAC3/v2.2.0/", "v2.1.0": "https://automl.github.io/SMAC3/v2.1.0/", diff --git a/docs/images/logo.png b/docs/images/logo.png index e5519c739..0c84a2971 100644 Binary files a/docs/images/logo.png and b/docs/images/logo.png differ diff --git a/docs/images/logo_old.png b/docs/images/logo_old.png new file mode 100644 index 000000000..e5519c739 Binary files /dev/null and b/docs/images/logo_old.png differ diff --git a/docs/images/smac_icon.png b/docs/images/smac_icon.png new file mode 100644 index 000000000..4f6d46a9b Binary files /dev/null and b/docs/images/smac_icon.png differ diff --git a/docs/index.md b/docs/index.md index 3d9427335..46d572189 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,8 @@ Home # SMAC3 Documentation +SMAC3 Logo + ## Introduction SMAC is a tool for algorithm configuration to optimize the parameters of arbitrary algorithms, including hyperparameter optimization of Machine Learning algorithms. The main core consists of Bayesian Optimization in combination with an aggressive racing mechanism to efficiently decide which of two configurations performs better. diff --git a/mkdocs.yaml b/mkdocs.yaml index 067518fd0..1cd2ff26c 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -19,7 +19,7 @@ repo_name: automl/SMAC3 theme: name: material logo: images/logo.png - favicon: images/logo.png + favicon: images/smac_icon.png icon: repo: fontawesome/brands/github features: diff --git a/smac/__init__.py b/smac/__init__.py index 162eccc73..881b8ea9d 100644 --- a/smac/__init__.py +++ b/smac/__init__.py @@ -20,7 +20,7 @@ "Matthias Feurer, André Biedenkapp, Difan Deng, Carolin Benjamins, Tim Ruhkopf, René Sass " "and Frank Hutter" ) -version = "2.3.0" +version = "2.3.1" try: