Skip to content

Commit

Permalink
Version 2.0.2 (#1060)
Browse files Browse the repository at this point in the history
* maint

* fix wrongly imported func name in tests

* Add reference for pSMAC #609

* Rename example file

* Added roadmap to readme

* Prettification

* Add result merger

* Reformat with black

* Delete unnecessary import

* Fix typing

* Inject first trajectory entry from file from first rundir

* Add test for ResultMerger

* Fix docstring

* Get runhistory and trajectory from pSMAC run

Via the result merger. Searchers rundirs and
merges found runhistories and calculates a
new trajectory.

* Get trajectory

* Add regex to requirements

* Fixed MO cache problem

* Fix MO tests

* Fixing MO in AbstractRacer

* Accepting ints

* Hacking in the sum cost for MO

* Fix mypi

* Bugfix

* Make mypi happy

* Fix tests

* Make format

* Remove num_obj in MO optimizer

* A lot of restructuring

* Solve importings

* Solve importings

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Updated changelog

* Still fixing :)

* fix docstrings

* Change directory of tests

* Fix ambiguous variable

* Del newlines

* fix mypy

* mypy and doc fix

* Removed int type checking

* fix tests

* Always return List of incs

* fix path issue in example

* maint boing facade

* Better docstring

* Return values if no bounds passed

* Removed import

* Return only one incumbent

* Rename n_optimizers -> n_workers

* Update example

* Update docstring

* Remove legacy function

* Update to new signature

* Update changelog.md

* Format black

* Update test

* Please pre-commit

* Merge development

* Fix tests

* Fix typos

* Format black

* Updated text

* Increased version

* Improved readme

* SMAC logo 50%

* SMAC logo 50%

* Removed dev-2.0

* Added doc workflow for latest tag

* Fixing docs latest tag

* Fixing docs latest tag

* First steps new intensifier

* Make it work again

* MOVE random weight initialization to smbo ask method

* ADD enable parego in unittests

* Test issues

* FIX formatting

* Link to old documentation

* MOVE random weight initialization to smbo ask method

* ADD enable parego in unittests

* FIX formatting

* Fix unit tests

* Add annotation

* corrected log prob for tophat prior

* Removed configurations from callback

* Fixed tests

* Fix mypy

* Save docs as latest version too

* Enabled all tests again

* Make version an env

* Added last version to docs

* Global variable fix

* Added v before version number

* New Intensifier Implementation (#888)

- Completely reimplemented the intensifiers (including Successive Halving and Hyperband): All intensifiers support multi-fidelity, multi-objective and multi-threading by nature now.
- Expected behaviour for ask-and-tell interface ensured (also for Successive Halving).
- Continuing a run is now fully supported.
- Added more examples.
- Updated documentation based on new implementation.

* First benchmark steps

* Added a warning

* Set xi to 0.01

* Incorporated walltime in trajectory

* Working version of benchmark

* Changed requirements

* Changed xi back to 0.0 again

* No duplicate budgets

* Fixed bug which updated tracker wrongly

* Bugfix: Delete correct bracket+stage

* Fixed tests

* Added costs to the trajectory

* Changed initial design max ratio to 0.25

* Make format

* Added more details to intensifier

* Finished benchmark

* Added benchmark source files

* Fixed tests because of initial design changes

* Improved runhistory API

* Fixed typo (#894)

* Merge doc fixes

* Doc fixes (#893)

Co-authored-by: timruhkopf <timruhkopf@gmail.com>
Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>
Co-authored-by: dengdifan <difandeng@gmail.com>
Co-authored-by: Alexander Tornede <tornede@tnt.uni-hannover.de>
Co-authored-by: Sarah Krebs <s.krebs@ai.uni-hannover.de>

* Make format

* Satisfied mypy

* Enabled more tests

* Increased version

* Mypy

* Mypy

* Mypy

* Fixed critical bug when using highest budget for inc selection

* Added SH+HB comparison

* Stuff

* Updated report

* Fixed docstring

* Fixed image path

* Removed vscode folder

* Bugfixes

* Doc fixes

* Updated changelog

* Make isort

* Fix typos

* Removed new line

* Added alpha2 to docs selection

* update description

* Fix 531 correctly create integers in initial design

This PR fixes a bug in which integer hyperparameters would not
be created correctly in the initial design. This went
unnoticed, except in the case where it was part of a condition
and the function deactivate_inactive_hyperparameters was
called.

This PR fixes this bug by mapping the random float that was
sampled by, for example and LHD or Sobol sequence, to the
float representation of an integer by calling _transform and
_inverse_transform of the integer hyperparameter.

* Add contact paragraph to README.

* Increase days until stale issues are closed by stalebot (#904)

* Edit changelog

* Add issue number

* Closes #907

* Clarify origin of configurations (#908)

* Random forest speed up (#903)

Co-authored-by: René Sass <mail@renesass.de>

* Add: workflow to update pre-commit versions (#874)

Co-authored-by: René Sass <mail@renesass.de>

* Add Git-Flow Workflow Specification

* [DOC] acquisition function maximizers

* Add stale reminder email action

* Increase version number of ConfigSpace

* Add guideline for updating copyright notice years to CONTRIBUTING.md

* Update requirement for pyrfr (#920)

* Update pre-commit: isort,flake8 version numbers

* Format black

* Fix mypy

* Ac bench (#929)

* Add Branin AC Task

* Add ac optimization type

* Nicer plotting

* Add ac mode

* Update ac task

* Make new smac env name adjustable

* Increase python version for smac 1.4

* Update benchmark

* Update plotting

* Goodby comments

* Fix path

* Fix 1.4 wrapper

* Update benchmark results

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* [DOC] added documentation on the incumbent update

* Feature/add version to make publish (#931)

* Add version, correct package name and use bash in makefile

* Increase version

* Increase version in makefile, add places with versions to make publish

* Fix typo

* Transform integer feature names to strings (#930)

* Transform int features to str

* Fix pre-commit

* Update version to 2.0.0

* Update version to 2.0.0

* Update CHANGELOG.md

* Add information on deepcave to the readme

* Correct doc version

* fix(runhistory): set id of the sampled config (#951)

* fix: Set config_id of config in runhistory

* ci: Set dependabot to target development branch (#963)

* feat: Option preventing SMAC setting up logging (#947)

* Version 2.0.0 (#898)

* Update runhistory2epm.py

* pre_commit

* Updated changelog

* Fixed comment

* Updated changelog

* Some small improvements

* Removed trailing space

* Updated changelog

* Restricted pynisher

* Updated changelog

* Link JMLR paper

* Update bibtex entry

Before: arxiv paper, now journal article.

* Fixed citation in docs

* Fixed callback typos

* BOinG for mixed hyperparameter search space

* fix format

* maint

* maint documentation

* maint pre-commit

* fix workflow

* maint

* Add dependabot for workflow files

* Bump actions/setup-python from 2 to 4 (#849)

Bumps [actions/setup-python](https://github.com/actions/setup-python) from 2 to 4.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](https://github.com/actions/setup-python/compare/v2...v4)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump actions/checkout from 2 to 3 (#850)

Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v2...v3)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* maint

* Updated stale bot

* Updated stale options again

* Fixed typing

* Increased version

* rename check_point_in_ss to check_subspace_point

* Make format

* Uncomment test procedure

* docstrings for boing facade

* avoid typing namespace everywhere in epm_configuration_chooser

* fix docstring in rh2epm_boing

* Limit on dask

* Trying to fix tests

* Replaced typing in all files

* docstring for boing subspace

* Changed feature requests to feature

* allow acq_optimizer_local_kwargs to be passed to boing subspace without acq_optimizer_local

* fix pre-commit

* Added any

* Update facade

* Fix typing
* Match arguments from pSMAC with SMAC4AC signature
* Add description of pSMAC to docstring
* Add option to pass facade class to pSMAC

* Add example for pSMAC

* Removed docstring in readme's example

* Corrected text

* move construct_gp_kernels to smac.epm_gpytorch.boing_kernels

* maint

* fix wrongly imported func name in tests

* Add reference for pSMAC #609

* Rename example file

* Added roadmap to readme

* Prettification

* Add result merger

* Reformat with black

* Delete unnecessary import

* Fix typing

* Inject first trajectory entry from file from first rundir

* Add test for ResultMerger

* Fix docstring

* Get runhistory and trajectory from pSMAC run

Via the result merger. Searchers rundirs and
merges found runhistories and calculates a
new trajectory.

* Get trajectory

* Add regex to requirements

* Fixed MO cache problem

* Fix MO tests

* Fixing MO in AbstractRacer

* Accepting ints

* Hacking in the sum cost for MO

* Fix mypi

* Bugfix

* Make mypi happy

* Fix tests

* Make format

* Remove num_obj in MO optimizer

* A lot of restructuring

* Solve importings

* Solve importings

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Updated changelog

* Still fixing :)

* fix docstrings

* Change directory of tests

* Fix ambiguous variable

* Del newlines

* fix mypy

* mypy and doc fix

* Removed int type checking

* fix tests

* Always return List of incs

* fix path issue in example

* maint boing facade

* Better docstring

* Return values if no bounds passed

* Removed import

* Return only one incumbent

* Rename n_optimizers -> n_workers

* Update example

* Update docstring

* Remove legacy function

* Update to new signature

* Update changelog.md

* Format black

* Update test

* Please pre-commit

* Merge development

* Fix tests

* Fix typos

* Format black

* Updated text

* Increased version

* Improved readme

* SMAC logo 50%

* SMAC logo 50%

* Removed dev-2.0

* Added doc workflow for latest tag

* Fixing docs latest tag

* Fixing docs latest tag

* First steps new intensifier

* Make it work again

* MOVE random weight initialization to smbo ask method

* ADD enable parego in unittests

* Test issues

* FIX formatting

* Link to old documentation

* MOVE random weight initialization to smbo ask method

* ADD enable parego in unittests

* FIX formatting

* Fix unit tests

* Add annotation

* corrected log prob for tophat prior

* Removed configurations from callback

* Fixed tests

* Fix mypy

* Save docs as latest version too

* Enabled all tests again

* Make version an env

* Added last version to docs

* Global variable fix

* Added v before version number

* New Intensifier Implementation (#888)

- Completely reimplemented the intensifiers (including Successive Halving and Hyperband): All intensifiers support multi-fidelity, multi-objective and multi-threading by nature now.
- Expected behaviour for ask-and-tell interface ensured (also for Successive Halving).
- Continuing a run is now fully supported.
- Added more examples.
- Updated documentation based on new implementation.

* First benchmark steps

* Added a warning

* Set xi to 0.01

* Incorporated walltime in trajectory

* Working version of benchmark

* Changed requirements

* Changed xi back to 0.0 again

* No duplicate budgets

* Fixed bug which updated tracker wrongly

* Bugfix: Delete correct bracket+stage

* Fixed tests

* Added costs to the trajectory

* Changed initial design max ratio to 0.25

* Make format

* Added more details to intensifier

* Finished benchmark

* Added benchmark source files

* Fixed tests because of initial design changes

* Improved runhistory API

* Fixed typo (#894)

* Merge doc fixes

* Doc fixes (#893)

Co-authored-by: timruhkopf <timruhkopf@gmail.com>
Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>
Co-authored-by: dengdifan <difandeng@gmail.com>
Co-authored-by: Alexander Tornede <tornede@tnt.uni-hannover.de>
Co-authored-by: Sarah Krebs <s.krebs@ai.uni-hannover.de>

* Make format

* Satisfied mypy

* Enabled more tests

* Increased version

* Mypy

* Mypy

* Mypy

* Fixed critical bug when using highest budget for inc selection

* Added SH+HB comparison

* Stuff

* Updated report

* Fixed docstring

* Fixed image path

* Removed vscode folder

* Bugfixes

* Doc fixes

* Updated changelog

* Make isort

* Fix typos

* Removed new line

* Added alpha2 to docs selection

* update description

* Fix 531 correctly create integers in initial design

This PR fixes a bug in which integer hyperparameters would not
be created correctly in the initial design. This went
unnoticed, except in the case where it was part of a condition
and the function deactivate_inactive_hyperparameters was
called.

This PR fixes this bug by mapping the random float that was
sampled by, for example and LHD or Sobol sequence, to the
float representation of an integer by calling _transform and
_inverse_transform of the integer hyperparameter.

* Add contact paragraph to README.

* Increase days until stale issues are closed by stalebot (#904)

* Edit changelog

* Add issue number

* Closes #907

* Clarify origin of configurations (#908)

* Random forest speed up (#903)

Co-authored-by: René Sass <mail@renesass.de>

* Add: workflow to update pre-commit versions (#874)

Co-authored-by: René Sass <mail@renesass.de>

* Add Git-Flow Workflow Specification

* [DOC] acquisition function maximizers

* Add stale reminder email action

* Increase version number of ConfigSpace

* Add guideline for updating copyright notice years to CONTRIBUTING.md

* Update requirement for pyrfr (#920)

* Update pre-commit: isort,flake8 version numbers

* Format black

* Fix mypy

* Ac bench (#929)

* Add Branin AC Task

* Add ac optimization type

* Nicer plotting

* Add ac mode

* Update ac task

* Make new smac env name adjustable

* Increase python version for smac 1.4

* Update benchmark

* Update plotting

* Goodby comments

* Fix path

* Fix 1.4 wrapper

* Update benchmark results

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* [DOC] added documentation on the incumbent update

* Feature/add version to make publish (#931)

* Add version, correct package name and use bash in makefile

* Increase version

* Increase version in makefile, add places with versions to make publish

* Fix typo

* Transform integer feature names to strings (#930)

* Transform int features to str

* Fix pre-commit

* Update version to 2.0.0

* Update version to 2.0.0

* Update CHANGELOG.md

* Add information on deepcave to the readme

* Correct doc version

---------

Co-authored-by: dengdifan <33290713+dengdifan@users.noreply.github.com>
Co-authored-by: dengdifan <difandeng@gmail.com>
Co-authored-by: Matthias Feurer <feurerm@informatik.uni-freiburg.de>
Co-authored-by: Carolin Benjamins <benjamin@tnt.uni-hannover.de>
Co-authored-by: eddiebergman <eddiebergmanhs@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>
Co-authored-by: C. Benjamins <75323339+benjamc@users.noreply.github.com>
Co-authored-by: Katharina Eggensperger <eggenspk@informatik.uni-freiburg.de>
Co-authored-by: Eric Kalosa-Kenyon <ekquasar@appdynamics.com>
Co-authored-by: Pascal <66594767+PascalIversen@users.noreply.github.com>
Co-authored-by: helegraf <Graf.Helena@web.de>
Co-authored-by: timruhkopf <timruhkopf@gmail.com>
Co-authored-by: Alexander Tornede <tornede@tnt.uni-hannover.de>
Co-authored-by: Sarah Krebs <s.krebs@ai.uni-hannover.de>
Co-authored-by: Alexander Tornede <a.tornede@ai.uni-hannover.de>
Co-authored-by: Alexander Tornede <44395781+alexandertornede@users.noreply.github.com>
Co-authored-by: Sarah Krebs <30651149+sarah-krebs@users.noreply.github.com>
Co-authored-by: helegraf <h.graf@ai.uni-hannover.de>
Co-authored-by: Jeroen Rook <jrook94@gmail.com>
Co-authored-by: Tim Ruhkopf <timruhkopf@googlemail.com>

* feat: Option preventing SMAC setting up logging

* fix: Run isort

* Bump peter-evans/create-pull-request from 3 to 5 (#958)

Bumps [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) from 3 to 5.
- [Release notes](https://github.com/peter-evans/create-pull-request/releases)
- [Commits](https://github.com/peter-evans/create-pull-request/compare/v3...v5)

---
updated-dependencies:
- dependency-name: peter-evans/create-pull-request
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump actions/setup-python from 2 to 4 (#945)

Bumps [actions/setup-python](https://github.com/actions/setup-python) from 2 to 4.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](https://github.com/actions/setup-python/compare/v2...v4)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat: Option preventing SMAC setting up logging

* fix: Run isort

* fix: Add to changelog

* feat: Option preventing SMAC setting up logging

* fix: Run isort

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: René Sass <mail@renesass.de>
Co-authored-by: dengdifan <33290713+dengdifan@users.noreply.github.com>
Co-authored-by: dengdifan <difandeng@gmail.com>
Co-authored-by: Matthias Feurer <feurerm@informatik.uni-freiburg.de>
Co-authored-by: Carolin Benjamins <benjamin@tnt.uni-hannover.de>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>
Co-authored-by: C. Benjamins <75323339+benjamc@users.noreply.github.com>
Co-authored-by: Katharina Eggensperger <eggenspk@informatik.uni-freiburg.de>
Co-authored-by: Eric Kalosa-Kenyon <ekquasar@appdynamics.com>
Co-authored-by: Pascal <66594767+PascalIversen@users.noreply.github.com>
Co-authored-by: helegraf <Graf.Helena@web.de>
Co-authored-by: timruhkopf <timruhkopf@gmail.com>
Co-authored-by: Alexander Tornede <tornede@tnt.uni-hannover.de>
Co-authored-by: Sarah Krebs <s.krebs@ai.uni-hannover.de>
Co-authored-by: Alexander Tornede <a.tornede@ai.uni-hannover.de>
Co-authored-by: Alexander Tornede <44395781+alexandertornede@users.noreply.github.com>
Co-authored-by: Sarah Krebs <30651149+sarah-krebs@users.noreply.github.com>
Co-authored-by: helegraf <h.graf@ai.uni-hannover.de>
Co-authored-by: Jeroen Rook <jrook94@gmail.com>
Co-authored-by: Tim Ruhkopf <timruhkopf@googlemail.com>

* Citation update (#961)

* update CITATION.cff

* update order in CITATION.cff

* fix citation date

* fix citation

* maint

* Adjust hyperband configuration distribution across brackets

* Compute the actual differences between the isb keys. (#957)

* Compute the actual differences between the isb keys.

* Added change to CHANGELOG.md

* Adjust schedule for stale reminder

* fix(logging): Prevent automatic logging setup at init (#970)

* fix(logging): Prevent automatic logging setup at init

* fix(logging): Rely on `setup_logging` to handle arg

* Fix validate method of smbo, update docstring.

* Allow callbacks to be added to a specific index, make callback registering public

* Update CHANGELOG.md

* Fix broken references (#988)

* Adapt developer install instructions to include pre-commit installation (#994)

* [Feature] Initial Design now supports executing the default config provided by the user by means of the configspace he generated. (and is no longer ignored)

* Pipe dask_client through facade for exec on hpc (#983)

* Pipe dask_client through facade for exec on hpc

* Handle pynisher's memory arg

Before: Could only pass int via SMAC with the default unit B, but now tuple/list is possible

* Update CHANGELOG.md

* Make format

* No printi

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* [Bug-fix] Pr was failing due to mutable additional configs default

* [doc-fix] the count of initial design configs is computed slightly differently

* Feature/metadata callback (#999)

* Add example for using a callback to log run metadata to a file

* Add issue number in changelog

* Changelog formatting

* Simplify metadata example

* Simplify metadata example

* Put callback in smac directory to allow importing it in custom repos

* Move callback files to callback directory

* Edit changelog

* Correct metadata callback argument types

* Additional metadata arguments in example

* Set metadata default values in callback

* Edit comment to fix PR

* Documentation/dask client example (#1001)

* Update requirements (dask_jobqueue)

* Fix broken link

* Ignore parallel example

* Add parallelization example

* Remove imports, add comment abt dask client

* Add E's information

* Update docs

* Add comment about n_workers

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* Documentation/dask client example (#1001)

* Update requirements (dask_jobqueue)

* Fix broken link

* Ignore parallel example

* Add parallelization example

* Remove imports, add comment abt dask client

* Add E's information

* Update docs

* Add comment about n_workers

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* Feature/dask client (#1002)

* Add info message that scenario.n_workers is ignored

When passing a dask client,
directly set n_workers in client.

* Change info to warning

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* Update smac version (#1003)

* Update smac version

* Add hint on github release in make publish

* Update copyright year

* check if config in rh when storing state (#997)

* check if config in rh when storing state

* maint

* remove unnecessary changes

* Adapt developer install instructions to include pre-commit installation (#994)

* Pipe dask_client through facade for exec on hpc (#983)

* Pipe dask_client through facade for exec on hpc

* Handle pynisher's memory arg

Before: Could only pass int via SMAC with the default unit B, but now tuple/list is possible

* Update CHANGELOG.md

* Make format

* No printi

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* update changelog

* Increase tolerance for runhistory restoration test

---------

Co-authored-by: Sarah Segel <30651149+sarah-segel@users.noreply.github.com>
Co-authored-by: C. Benjamins <75323339+benjamc@users.noreply.github.com>
Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>
Co-authored-by: Helena Graf <h.graf@ai.uni-hannover.de>

* Add a workaround to be able to pass a dataset via dask.scatter (#993)

* [feat] Support dask.scatter

* [fix] Add shared_data arg in abstract_facade

* Address the comments by Eddie

* [fix] Fix errors raised by Eddie

* [format] Apply black locally

* [fix] Get retries back to 16 as it was a mistake

* [doc] Update CHANGELOG

---------

Co-authored-by: helegraf <h.graf@ai.uni-hannover.de>
Co-authored-by: C. Benjamins <75323339+benjamc@users.noreply.github.com>

* Adding Binder links for example (#976)

* binder

* maint

* fix dependencies

* maint docs

* Revert "maint docs"

This reverts commit 4fa1a0fae8dfa0b646e43273d50f72ddd76bf191.

* add requirement

---------

Co-authored-by: Difan Deng <deng@dengster.tnt.uni-hannover.de>

* Remove commit message from dependabot PRs (#1009)

* Bugfix/fix broken link (#1012)

* Remove commit message from dependabot PRs (#1010)

* rename check_point_in_ss to check_subspace_point

* Make format

* Uncomment test procedure

* docstrings for boing facade

* avoid typing namespace everywhere in epm_configuration_chooser

* fix docstring in rh2epm_boing

* Limit on dask

* Trying to fix tests

* Replaced typing in all files

* docstring for boing subspace

* Changed feature requests to feature

* allow acq_optimizer_local_kwargs to be passed to boing subspace without acq_optimizer_local

* fix pre-commit

* Added any

* Update facade

* Fix typing
* Match arguments from pSMAC with SMAC4AC signature
* Add description of pSMAC to docstring
* Add option to pass facade class to pSMAC

* Add example for pSMAC

* Removed docstring in readme's example

* Corrected text

* move construct_gp_kernels to smac.epm_gpytorch.boing_kernels

* maint

* fix wrongly imported func name in tests

* Add reference for pSMAC #609

* Rename example file

* Added roadmap to readme

* Prettification

* Add result merger

* Reformat with black

* Delete unnecessary import

* Fix typing

* Inject first trajectory entry from file from first rundir

* Add test for ResultMerger

* Fix docstring

* Get runhistory and trajectory from pSMAC run

Via the result merger. Searchers rundirs and
merges found runhistories and calculates a
new trajectory.

* Get trajectory

* Add regex to requirements

* Fixed MO cache problem

* Fix MO tests

* Fixing MO in AbstractRacer

* Accepting ints

* Hacking in the sum cost for MO

* Fix mypi

* Bugfix

* Make mypi happy

* Fix tests

* Make format

* Remove num_obj in MO optimizer

* A lot of restructuring

* Solve importings

* Solve importings

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Updated changelog

* Still fixing :)

* fix docstrings

* Change directory of tests

* Fix ambiguous variable

* Del newlines

* fix mypy

* mypy and doc fix

* Removed int type checking

* fix tests

* Always return List of incs

* fix path issue in example

* maint boing facade

* Better docstring

* Return values if no bounds passed

* Removed import

* Return only one incumbent

* Rename n_optimizers -> n_workers

* Update example

* Update docstring

* Remove legacy function

* Update to new signature

* Update changelog.md

* Format black

* Update test

* Please pre-commit

* Merge development

* Fix tests

* Fix typos

* Format black

* Updated text

* Increased version

* Improved readme

* SMAC logo 50%

* SMAC logo 50%

* Removed dev-2.0

* Added doc workflow for latest tag

* Fixing docs latest tag

* Fixing docs latest tag

* First steps new intensifier

* Make it work again

* MOVE random weight initialization to smbo ask method

* ADD enable parego in unittests

* Test issues

* FIX formatting

* Link to old documentation

* MOVE random weight initialization to smbo ask method

* ADD enable parego in unittests

* FIX formatting

* Fix unit tests

* Add annotation

* corrected log prob for tophat prior

* Removed configurations from callback

* Fixed tests

* Fix mypy

* Save docs as latest version too

* Enabled all tests again

* Make version an env

* Added last version to docs

* Global variable fix

* Added v before version number

* New Intensifier Implementation (#888)

- Completely reimplemented the intensifiers (including Successive Halving and Hyperband): All intensifiers support multi-fidelity, multi-objective and multi-threading by nature now.
- Expected behaviour for ask-and-tell interface ensured (also for Successive Halving).
- Continuing a run is now fully supported.
- Added more examples.
- Updated documentation based on new implementation.

* First benchmark steps

* Added a warning

* Set xi to 0.01

* Incorporated walltime in trajectory

* Working version of benchmark

* Changed requirements

* Changed xi back to 0.0 again

* No duplicate budgets

* Fixed bug which updated tracker wrongly

* Bugfix: Delete correct bracket+stage

* Fixed tests

* Added costs to the trajectory

* Changed initial design max ratio to 0.25

* Make format

* Added more details to intensifier

* Finished benchmark

* Added benchmark source files

* Fixed tests because of initial design changes

* Improved runhistory API

* Fixed typo (#894)

* Merge doc fixes

* Doc fixes (#893)

Co-authored-by: timruhkopf <timruhkopf@gmail.com>
Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>
Co-authored-by: dengdifan <difandeng@gmail.com>
Co-authored-by: Alexander Tornede <tornede@tnt.uni-hannover.de>
Co-authored-by: Sarah Krebs <s.krebs@ai.uni-hannover.de>

* Make format

* Satisfied mypy

* Enabled more tests

* Increased version

* Mypy

* Mypy

* Mypy

* Fixed critical bug when using highest budget for inc selection

* Added SH+HB comparison

* Stuff

* Updated report

* Fixed docstring

* Fixed image path

* Removed vscode folder

* Bugfixes

* Doc fixes

* Updated changelog

* Make isort

* Fix typos

* Removed new line

* Added alpha2 to docs selection

* update description

* Fix 531 correctly create integers in initial design

This PR fixes a bug in which integer hyperparameters would not
be created correctly in the initial design. This went
unnoticed, except in the case where it was part of a condition
and the function deactivate_inactive_hyperparameters was
called.

This PR fixes this bug by mapping the random float that was
sampled by, for example and LHD or Sobol sequence, to the
float representation of an integer by calling _transform and
_inverse_transform of the integer hyperparameter.

* Add contact paragraph to README.

* Increase days until stale issues are closed by stalebot (#904)

* Edit changelog

* Add issue number

* Closes #907

* Clarify origin of configurations (#908)

* Random forest speed up (#903)

Co-authored-by: René Sass <mail@renesass.de>

* Add: workflow to update pre-commit versions (#874)

Co-authored-by: René Sass <mail@renesass.de>

* Add Git-Flow Workflow Specification

* [DOC] acquisition function maximizers

* Add stale reminder email action

* Increase version number of ConfigSpace

* Add guideline for updating copyright notice years to CONTRIBUTING.md

* Update requirement for pyrfr (#920)

* Update pre-commit: isort,flake8 version numbers

* Format black

* Fix mypy

* Ac bench (#929)

* Add Branin AC Task

* Add ac optimization type

* Nicer plotting

* Add ac mode

* Update ac task

* Make new smac env name adjustable

* Increase python version for smac 1.4

* Update benchmark

* Update plotting

* Goodby comments

* Fix path

* Fix 1.4 wrapper

* Update benchmark results

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* [DOC] added documentation on the incumbent update

* Feature/add version to make publish (#931)

* Add version, correct package name and use bash in makefile

* Increase version

* Increase version in makefile, add places with versions to make publish

* Fix typo

* Transform integer feature names to strings (#930)

* Transform int features to str

* Fix pre-commit

* Update version to 2.0.0

* Update version to 2.0.0

* Update CHANGELOG.md

* Add information on deepcave to the readme

* Correct doc version

* fix(runhistory): set id of the sampled config (#951)

* fix: Set config_id of config in runhistory

* ci: Set dependabot to target development branch (#963)

* feat: Option preventing SMAC setting up logging (#947)

* Version 2.0.0 (#898)

* Update runhistory2epm.py

* pre_commit

* Updated changelog

* Fixed comment

* Updated changelog

* Some small improvements

* Removed trailing space

* Updated changelog

* Restricted pynisher

* Updated changelog

* Link JMLR paper

* Update bibtex entry

Before: arxiv paper, now journal article.

* Fixed citation in docs

* Fixed callback typos

* BOinG for mixed hyperparameter search space

* fix format

* maint

* maint documentation

* maint pre-commit

* fix workflow

* maint

* Add dependabot for workflow files

* Bump actions/setup-python from 2 to 4 (#849)

Bumps [actions/setup-python](https://github.com/actions/setup-python) from 2 to 4.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](https://github.com/actions/setup-python/compare/v2...v4)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump actions/checkout from 2 to 3 (#850)

Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v2...v3)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* maint

* Updated stale bot

* Updated stale options again

* Fixed typing

* Increased version

* rename check_point_in_ss to check_subspace_point

* Make format

* Uncomment test procedure

* docstrings for boing facade

* avoid typing namespace everywhere in epm_configuration_chooser

* fix docstring in rh2epm_boing

* Limit on dask

* Trying to fix tests

* Replaced typing in all files

* docstring for boing subspace

* Changed feature requests to feature

* allow acq_optimizer_local_kwargs to be passed to boing subspace without acq_optimizer_local

* fix pre-commit

* Added any

* Update facade

* Fix typing
* Match arguments from pSMAC with SMAC4AC signature
* Add description of pSMAC to docstring
* Add option to pass facade class to pSMAC

* Add example for pSMAC

* Removed docstring in readme's example

* Corrected text

* move construct_gp_kernels to smac.epm_gpytorch.boing_kernels

* maint

* fix wrongly imported func name in tests

* Add reference for pSMAC #609

* Rename example file

* Added roadmap to readme

* Prettification

* Add result merger

* Reformat with black

* Delete unnecessary import

* Fix typing

* Inject first trajectory entry from file from first rundir

* Add test for ResultMerger

* Fix docstring

* Get runhistory and trajectory from pSMAC run

Via the result merger. Searchers rundirs and
merges found runhistories and calculates a
new trajectory.

* Get trajectory

* Add regex to requirements

* Fixed MO cache problem

* Fix MO tests

* Fixing MO in AbstractRacer

* Accepting ints

* Hacking in the sum cost for MO

* Fix mypi

* Bugfix

* Make mypi happy

* Fix tests

* Make format

* Remove num_obj in MO optimizer

* A lot of restructuring

* Solve importings

* Solve importings

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Fixing, fixing, fixing, ...

* Updated changelog

* Still fixing :)

* fix docstrings

* Change directory of tests

* Fix ambiguous variable

* Del newlines

* fix mypy

* mypy and doc fix

* Removed int type checking

* fix tests

* Always return List of incs

* fix path issue in example

* maint boing facade

* Better docstring

* Return values if no bounds passed

* Removed import

* Return only one incumbent

* Rename n_optimizers -> n_workers

* Update example

* Update docstring

* Remove legacy function

* Update to new signature

* Update changelog.md

* Format black

* Update test

* Please pre-commit

* Merge development

* Fix tests

* Fix typos

* Format black

* Updated text

* Increased version

* Improved readme

* SMAC logo 50%

* SMAC logo 50%

* Removed dev-2.0

* Added doc workflow for latest tag

* Fixing docs latest tag

* Fixing docs latest tag

* First steps new intensifier

* Make it work again

* MOVE random weight initialization to smbo ask method

* ADD enable parego in unittests

* Test issues

* FIX formatting

* Link to old documentation

* MOVE random weight initialization to smbo ask method

* ADD enable parego in unittests

* FIX formatting

* Fix unit tests

* Add annotation

* corrected log prob for tophat prior

* Removed configurations from callback

* Fixed tests

* Fix mypy

* Save docs as latest version too

* Enabled all tests again

* Make version an env

* Added last version to docs

* Global variable fix

* Added v before version number

* New Intensifier Implementation (#888)

- Completely reimplemented the intensifiers (including Successive Halving and Hyperband): All intensifiers support multi-fidelity, multi-objective and multi-threading by nature now.
- Expected behaviour for ask-and-tell interface ensured (also for Successive Halving).
- Continuing a run is now fully supported.
- Added more examples.
- Updated documentation based on new implementation.

* First benchmark steps

* Added a warning

* Set xi to 0.01

* Incorporated walltime in trajectory

* Working version of benchmark

* Changed requirements

* Changed xi back to 0.0 again

* No duplicate budgets

* Fixed bug which updated tracker wrongly

* Bugfix: Delete correct bracket+stage

* Fixed tests

* Added costs to the trajectory

* Changed initial design max ratio to 0.25

* Make format

* Added more details to intensifier

* Finished benchmark

* Added benchmark source files

* Fixed tests because of initial design changes

* Improved runhistory API

* Fixed typo (#894)

* Merge doc fixes

* Doc fixes (#893)

Co-authored-by: timruhkopf <timruhkopf@gmail.com>
Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>
Co-authored-by: dengdifan <difandeng@gmail.com>
Co-authored-by: Alexander Tornede <tornede@tnt.uni-hannover.de>
Co-authored-by: Sarah Krebs <s.krebs@ai.uni-hannover.de>

* Make format

* Satisfied mypy

* Enabled more tests

* Increased version

* Mypy

* Mypy

* Mypy

* Fixed critical bug when using highest budget for inc selection

* Added SH+HB comparison

* Stuff

* Updated report

* Fixed docstring

* Fixed image path

* Removed vscode folder

* Bugfixes

* Doc fixes

* Updated changelog

* Make isort

* Fix typos

* Removed new line

* Added alpha2 to docs selection

* update description

* Fix 531 correctly create integers in initial design

This PR fixes a bug in which integer hyperparameters would not
be created correctly in the initial design. This went
unnoticed, except in the case where it was part of a condition
and the function deactivate_inactive_hyperparameters was
called.

This PR fixes this bug by mapping the random float that was
sampled by, for example and LHD or Sobol sequence, to the
float representation of an integer by calling _transform and
_inverse_transform of the integer hyperparameter.

* Add contact paragraph to README.

* Increase days until stale issues are closed by stalebot (#904)

* Edit changelog

* Add issue number

* Closes #907

* Clarify origin of configurations (#908)

* Random forest speed up (#903)

Co-authored-by: René Sass <mail@renesass.de>

* Add: workflow to update pre-commit versions (#874)

Co-authored-by: René Sass <mail@renesass.de>

* Add Git-Flow Workflow Specification

* [DOC] acquisition function maximizers

* Add stale reminder email action

* Increase version number of ConfigSpace

* Add guideline for updating copyright notice years to CONTRIBUTING.md

* Update requirement for pyrfr (#920)

* Update pre-commit: isort,flake8 version numbers

* Format black

* Fix mypy

* Ac bench (#929)

* Add Branin AC Task

* Add ac optimization type

* Nicer plotting

* Add ac mode

* Update ac task

* Make new smac env name adjustable

* Increase python version for smac 1.4

* Update benchmark

* Update plotting

* Goodby comments

* Fix path

* Fix 1.4 wrapper

* Update benchmark results

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* [DOC] added documentation on the incumbent update

* Feature/add version to make publish (#931)

* Add version, correct package name and use bash in makefile

* Increase version

* Increase version in makefile, add places with versions to make publish

* Fix typo

* Transform integer feature names to strings (#930)

* Transform int features to str

* Fix pre-commit

* Update version to 2.0.0

* Update version to 2.0.0

* Update CHANGELOG.md

* Add information on deepcave to the readme

* Correct doc version

---------

Co-authored-by: dengdifan <33290713+dengdifan@users.noreply.github.com>
Co-authored-by: dengdifan <difandeng@gmail.com>
Co-authored-by: Matthias Feurer <feurerm@informatik.uni-freiburg.de>
Co-authored-by: Carolin Benjamins <benjamin@tnt.uni-hannover.de>
Co-authored-by: eddiebergman <eddiebergmanhs@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>
Co-authored-by: C. Benjamins <75323339+benjamc@users.noreply.github.com>
Co-authored-by: Katharina Eggensperger <eggenspk@informatik.uni-freiburg.de>
Co-authored-by: Eric Kalosa-Kenyon <ekquasar@appdynamics.com>
Co-authored-by: Pascal <66594767+PascalIversen@users.noreply.github.com>
Co-authored-by: helegraf <Graf.Helena@web.de>
Co-authored-by: timruhkopf <timruhkopf@gmail.com>
Co-authored-by: Alexander Tornede <tornede@tnt.uni-hannover.de>
Co-authored-by: Sarah Krebs <s.krebs@ai.uni-hannover.de>
Co-authored-by: Alexander Tornede <a.tornede@ai.uni-hannover.de>
Co-authored-by: Alexander Tornede <44395781+alexandertornede@users.noreply.github.com>
Co-authored-by: Sarah Krebs <30651149+sarah-krebs@users.noreply.github.com>
Co-authored-by: helegraf <h.graf@ai.uni-hannover.de>
Co-authored-by: Jeroen Rook <jrook94@gmail.com>
Co-authored-by: Tim Ruhkopf <timruhkopf@googlemail.com>

* feat: Option preventing SMAC setting up logging

* fix: Run isort

* Bump peter-evans/create-pull-request from 3 to 5 (#958)

Bumps [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) from 3 to 5.
- [Release notes](https://github.com/peter-evans/create-pull-request/releases)
- [Commits](https://github.com/peter-evans/create-pull-request/compare/v3...v5)

---
updated-dependencies:
- dependency-name: peter-evans/create-pull-request
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump actions/setup-python from 2 to 4 (#945)

Bumps [actions/setup-python](https://github.com/actions/setup-python) from 2 to 4.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](https://github.com/actions/setup-python/compare/v2...v4)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat: Option preventing SMAC setting up logging

* fix: Run isort

* fix: Add to changelog

* feat: Option preventing SMAC setting up logging

* fix: Run isort

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: René Sass <mail@renesass.de>
Co-authored-by: dengdifan <33290713+dengdifan@users.noreply.github.com>
Co-authored-by: dengdifan <difandeng@gmail.com>
Co-authored-by: Matthias Feurer <feurerm@informatik.uni-freiburg.de>
Co-authored-by: Carolin Benjamins <benjamin@tnt.uni-hannover.de>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>
Co-authored-by: C. Benjamins <75323339+benjamc@users.noreply.github.com>
Co-authored-by: Katharina Eggensperger <eggenspk@informatik.uni-freiburg.de>
Co-authored-by: Eric Kalosa-Kenyon <ekquasar@appdynamics.com>
Co-authored-by: Pascal <66594767+PascalIversen@users.noreply.github.com>
Co-authored-by: helegraf <Graf.Helena@web.de>
Co-authored-by: timruhkopf <timruhkopf@gmail.com>
Co-authored-by: Alexander Tornede <tornede@tnt.uni-hannover.de>
Co-authored-by: Sarah Krebs <s.krebs@ai.uni-hannover.de>
Co-authored-by: Alexander Tornede <a.tornede@ai.uni-hannover.de>
Co-authored-by: Alexander Tornede <44395781+alexandertornede@users.noreply.github.com>
Co-authored-by: Sarah Krebs <30651149+sarah-krebs@users.noreply.github.com>
Co-authored-by: helegraf <h.graf@ai.uni-hannover.de>
Co-authored-by: Jeroen Rook <jrook94@gmail.com>
Co-authored-by: Tim Ruhkopf <timruhkopf@googlemail.com>

* Citation update (#961)

* update CITATION.cff

* update order in CITATION.cff

* fix citation date

* fix citation

* maint

* Adjust hyperband configuration distribution across brackets

* Compute the actual differences between the isb keys. (#957)

* Compute the actual differences between the isb keys.

* Added change to CHANGELOG.md

* Adjust schedule for stale reminder

* fix(logging): Prevent automatic logging setup at init (#970)

* fix(logging): Prevent automatic logging setup at init

* fix(logging): Rely on `setup_logging` to handle arg

* Fix validate method of smbo, update docstring.

* Allow callbacks to be added to a specific index, make callback registering public

* Update CHANGELOG.md

* Fix broken references (#988)

* Adapt developer install instructions to include pre-commit installation (#994)

* [Feature] Initial Design now supports executing the default config provided by the user by means of the configspace he generated. (and is no longer ignored)

* Pipe dask_client through facade for exec on hpc (#983)

* Pipe dask_client through facade for exec on hpc

* Handle pynisher's memory arg

Before: Could only pass int via SMAC with the default unit B, but now tuple/list is possible

* Update CHANGELOG.md

* Make format

* No printi

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* [Bug-fix] Pr was failing due to mutable additional configs default

* [doc-fix] the count of initial design configs is computed slightly differently

* Feature/metadata callback (#999)

* Add example for using a callback to log run metadata to a file

* Add issue number in changelog

* Changelog formatting

* Simplify metadata example

* Simplify metadata example

* Put callback in smac directory to allow importing it in custom repos

* Move callback files to callback directory

* Edit changelog

* Correct metadata callback argument types

* Additional metadata arguments in example

* Set metadata default values in callback

* Edit comment to fix PR

* Documentation/dask client example (#1001)

* Update requirements (dask_jobqueue)

* Fix broken link

* Ignore parallel example

* Add parallelization example

* Remove imports, add comment abt dask client

* Add E's information

* Update docs

* Add comment about n_workers

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* Documentation/dask client example (#1001)

* Update requirements (dask_jobqueue)

* Fix broken link

* Ignore parallel example

* Add parallelization example

* Remove imports, add comment abt dask client

* Add E's information

* Update docs

* Add comment about n_workers

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* Feature/dask client (#1002)

* Add info message that scenario.n_workers is ignored

When passing a dask client,
directly set n_workers in client.

* Change info to warning

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* Update smac version (#1003)

* Update smac version

* Add hint on github release in make publish

* Update copyright year

* check if config in rh when storing state (#997)

* check if config in rh when storing state

* maint

* remove unnecessary changes

* Adapt developer install instructions to include pre-commit installation (#994)

* Pipe dask_client through facade for exec on hpc (#983)

* Pipe dask_client through facade for exec on hpc

* Handle pynisher's memory arg

Before: Could only pass int via SMAC with the default unit B, but now tuple/list is possible

* Update CHANGELOG.md

* Make format

* No printi

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* update changelog

* Increase tolerance for runhistory restoration test

---------

Co-authored-by: Sarah Segel <30651149+sarah-segel@users.noreply.github.com>
Co-authored-by: C. Benjamins <75323339+benjamc@users.noreply.github.com>
Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>
Co-authored-by: Helena Graf <h.graf@ai.uni-hannover.de>

* Add a workaround to be able to pass a dataset via dask.scatter (#993)

* [feat] Support dask.scatter

* [fix] Add shared_data arg in abstract_facade

* Address the comments by Eddie

* [fix] Fix errors raised by Eddie

* [format] Apply black locally

* [fix] Get retries back to 16 as it was a mistake

* [doc] Update CHANGELOG

---------

Co-authored-by: helegraf <h.graf@ai.uni-hannover.de>
Co-authored-by: C. Benjamins <75323339+benjamc@users.noreply.github.com>

* Adding Binder links for example (#976)

* binder

* maint

* fix dependencies

* maint docs

* Revert "maint docs"

This reverts commit 4fa1a0fae8dfa0b646e43273d50f72ddd76bf191.

* add requirement

---------

Co-authored-by: Difan Deng <deng@dengster.tnt.uni-hannover.de>

* Remove commit message from dependabot PRs (#1009)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dengdifan <difandeng@gmail.com>
Co-authored-by: René Sass <mail@renesass.de>
Co-authored-by: Carolin Benjamins <benjamin@tnt.uni-hannover.de>
Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>
Co-authored-by: C. Benjamins <75323339+benjamc@users.noreply.github.com>
Co-authored-by: Katharina Eggensperger <eggenspk@informatik.uni-freiburg.de>
Co-authored-by: Matthias Feurer <feurerm@informatik.uni-freiburg.de>
Co-authored-by: Eric Kalosa-Kenyon <ekquasar@appdynamics.com>
Co-authored-by: Pascal <66594767+PascalIversen@users.noreply.github.com>
Co-authored-by: helegraf <Graf.Helena@web.de>
Co-authored-by: timruhkopf <timruhkopf@gmail.com>
Co-authored-by: Alexander Tornede <tornede@tnt.uni-hannover.de>
Co-authored-by: Alexander Tornede <a.tornede@ai.uni-hannover.de>
Co-authored-by: Alexander Tornede <44395781+alexandertornede@users.noreply.github.com>
Co-authored-by: Sarah Krebs <30651149+sarah-krebs@users.noreply.github.com>
Co-authored-by: helegraf <h.graf@ai.uni-hannover.de>
Co-authored-by: Jeroen Rook <jrook94@gmail.com>
Co-authored-by: Eddie Bergman <eddiebergmanhs@gmail.com>
Co-authored-by: Tim Ruhkopf <timruhkopf@googlemail.com>
Co-authored-by: Difan Deng <33290713+dengdifan@users.noreply.github.com>
Co-authored-by: Aron Bahram <aron.bahram@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Shuhei Watanabe <47781922+nabenabe0928@users.noreply.github.com>
Co-authored-by: Difan Deng <deng@dengster.tnt.uni-hannover.de>

* Fix broken link

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dengdifan <difandeng@gmail.com>
Co-authored-by: René Sass <mail@renesass.de>
Co-authored-by: Carolin Benjamins <benjamin@tnt.uni-hannover.de>
Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>
Co-authored-by: C. Benjamins <75323339+benjamc@users.noreply.github.com>
Co-authored-by: Katharina Eggensperger <eggenspk@informatik.uni-freiburg.de>
Co-authored-by: Matthias Feurer <feurerm@informatik.uni-freiburg.de>
Co-authored-by: Eric Kalosa-Kenyon <ekquasar@appdynamics.com>
Co-authored-by: Pascal <66594767+PascalIversen@users.noreply.github.com>
Co-authored-by: helegraf <Graf.Helena@web.de>
Co-authored-by: timruhkopf <timruhkopf@gmail.com>
Co-authored-by: Alexander Tornede <tornede@tnt.uni-hannover.de>
Co-authored-by: Alexander Tornede <a.tornede@ai.uni-hannover.de>
Co-authored-by: Alexander Tornede <44395781+alexandertornede@users.noreply.github.com>
Co-authored-by: Sarah Krebs <30651149+sarah-krebs@users.noreply.github.com>
Co-authored-by: helegraf <h.graf@ai.uni-hannover.de>
Co-authored-by: Jeroen Rook <jrook94@gmail.com>
Co-authored-by: Eddie Bergman <eddiebergmanhs@gmail.com>
Co-authored-by: Tim Ruhkopf <timruhkopf@googlemail.com>
Co-authored-by: Difan Deng <33290713+dengdifan@users.noreply.github.com>
Co-authored-by: Aron Bahram <aron.bahram@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Shuhei Watanabe <47781922+nabenabe0928@users.noreply.github.com>
Co-authored-by: Difan Deng <deng@dengster.tnt.uni-hannover.de>

* Drop torch requirements (#1015)

* Remove torch requirements

* Fix format

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* Remove leftover CLI entry points (#1014)

* Fix incumbent selection in case of SH+MO

* Update CHANGELOG.md

* Feature/GitHub actions pr draft (#1008)

Update the workflows only to trigger extensive tests for PRs that are not in the draft stage

---------

Co-authored-by: timruhkopf <timruhkopf@gmail.com>
Co-authored-by: Helena Graf <h.graf@ai.uni-hannover.de>

* Update stale report to include issues with recent interactions (#1025)

* Add recently updated issues to list of reminders.

* Add recently updated issues to list of reminders.

* Add recently updated issues to list of reminders.

* Raise error if resource limitation and parallelization is requested (#1023)

* Add warnings for parallelism doc

* Check for parallelization + pynisher

Does not work together, throw error.
Does not work bc Dask pickles jobs and
pynisher runs the target function in a process.

* Fix whitespaces

---------

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* Raise an error for invalid scatter data (#1018)

* [enhance] Add an error for scatter data

* Update ChangeLog

---------

Co-authored-by: C. Benjamins <75323339+benjamc@users.noreply.github.com>

* fix(configspace): shows all keys in print (#1043)

* Fix callback order (#1040)

Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>

* fix: dtypes (#1044)

* Fix(config_selector): Budget checking (#1039)

* Fix: target runner with partial func (#1045)

* Feature/improve documentation (#1028)

* Experimental instruction for installing SMAC in windows via WSL

* More detailed documentation regarding continuing runs

* Fixes

* Fixes

* Fixes

* Update docs/10_experimental.rst

Co-authored-by: Difan Deng <33290713+dengdifan@users.noreply.github.com>

* Fixes from PR

* Fixes from PR

* Fixes from PR

* Fixes from PR

* Fixes from PR

---------

Co-authored-by: Difan Deng <33290713+dengdifan@users.noreply.github.com>

* Handle configspace as dictionary in mlp example (#1057)

* Handle configspace as dictionary in mlp example

* Adapt sgd loss to newest scikit-learn version

* Add change to changelog

* Handle configspace as dictionary in parego example

* Correct get usage

* Raise version number

* Add missing period in docs.

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dengdifan <difandeng@gmail.com>
Co-authored-by: Carolin Benjamins <benjamin@tnt.uni-hannover.de>
Co-authored-by: René Sass <mail@renesass.de>
Co-authored-by: Carolin Benjamins <benjamins@tnt.uni-hannover.de>
Co-authored-by: C. Benjamins <75323339+benjamc@users.noreply.github.com>
Co-authored-by: Katharina Eggensperger <eggenspk@informatik.uni-freiburg.de>
Co-authored-by: Matthias Feurer <feurerm@informatik.uni-freiburg.de>
Co-authored-by: Eric Kalosa-Kenyon <ekquasar@appdynamics.com>
Co-authored-by: Pascal <66594767+PascalIversen@users.noreply.github.com>
Co-authored-by: helegraf <Graf.Helena@web.de>
Co-authored-by: timruhkopf <timruhkopf@gmail.com>
Co-authored-by: Alexander Tornede <tornede@tnt.uni-hannover.de>
Co-authored-by: Alexander Tornede <a.tornede@ai.uni-hannover.de>
Co-authored-by: Alexander Tornede <44395781+alexandertornede@users.noreply.github.com>
Co-authored-by: Sarah Krebs <30651149+sarah-krebs@users.noreply.github.com>
Co-authored-by: helegraf <h.graf@ai.uni-hannover.de>
Co-authored-by: Jeroen Rook <jrook94@gmail.com>
Co-authored-by: Eddie Bergman <eddiebergmanhs@gmail.com>
Co-authored-by: Tim Ruhkopf <timruhkopf@googlemail.com>
Co-authored-by: Difan Deng <33290713+dengdifan@users.noreply.github.com>
Co-authored-by: Aron Bahram <aron.bahram@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Shuhei Watanabe <47781922+nabenabe0928@users.noreply.github.com>
Co-authored-by: Difan Deng <deng@dengster.tnt.uni-hannover.de>
Co-authored-by: Bastian Zimmermann <10774221+BastianZim@users.noreply.github.com>
  • Loading branch information
26 people authored Aug 1, 2023
1 parent e64e191 commit 541ee7e
Show file tree
Hide file tree
Showing 32 changed files with 254 additions and 74 deletions.
10 changes: 8 additions & 2 deletions .github/workflows/dist.yml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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:
Expand Down
14 changes: 10 additions & 4 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand All @@ -23,6 +28,7 @@ env:

jobs:
build-and-deploy:
if: ${{ !github.event.pull_request.draft }}
runs-on: ubuntu-latest
steps:
- name: Checkout
Expand Down
8 changes: 7 additions & 1 deletion .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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:
Expand Down
27 changes: 18 additions & 9 deletions .github/workflows/pytest.yml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand All @@ -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:
Expand All @@ -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:
Expand All @@ -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: |
Expand All @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand All @@ -161,4 +169,5 @@ jobs:
- name: Tests
run: |
echo "Running all tests..."
pytest ${{ env.pytest-args }} ${{ env.test-dir }}
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
2 changes: 1 addition & 1 deletion benchmark/src/wrappers/v20.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
48 changes: 48 additions & 0 deletions docs/10_experimental.rst
Original file line number Diff line number Diff line change
@@ -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
8 changes: 8 additions & 0 deletions docs/1_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
19 changes: 14 additions & 5 deletions docs/advanced_usage/10_continue.rst
Original file line number Diff line number Diff line change
@@ -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>`.
33 changes: 33 additions & 0 deletions docs/advanced_usage/9_parallelism.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,39 @@ SMAC supports multiple workers natively via Dask. Just specify ``n_workers`` in
When using multiple workers, SMAC is not reproducible anymore.
.. warning ::
You cannot use resource limitation (pynisher, via the `scenario` arguments `trail_walltime_limit` and `trial_memory_limit`).
This is because pynisher works by running your function inside of a subprocess.
Once in the subprocess, the resources will be limited for that process before running your function.
This does not work together with pickling - which is required by dask to schedule jobs on the cluster, even on a local one.
.. warning ::
Start/run SMAC inside ``if __name__ == "__main__"`` in your script otherwise Dask is not able to correctly
spawn jobs and probably this runtime error will be raised:
.. code-block ::
RuntimeError:
An attempt has been made to start a new process before the
current process has finished its bootstrapping phase.
This probably means that you are not using fork to start your
child processes and you have forgotten to use the proper idiom
in the main module:
if __name__ == '__main__':
freeze_support()
...
The "freeze_support()" line can be omitted if the program
is not going to be frozen to produce an executable.
Running on a Cluster
--------------------
You can also pass a custom dask client, e.g. to run on a slurm cluster.
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"version": version,
"versions": {
f"v{version}": "#",
"v2.0.1": "https://automl.github.io/SMAC3/v2.0.1/",
"v2.0.0": "https://automl.github.io/SMAC3/v2.0.0/",
"v2.0.0b1": "https://automl.github.io/SMAC3/v2.0.0b1/",
"v2.0.0a2": "https://automl.github.io/SMAC3/v2.0.0a2/",
Expand Down
12 changes: 10 additions & 2 deletions examples/1_basics/5_continue.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,16 @@
Continue an Optimization
^^^^^^^^^^^^^^^^^^^^^^^^
SMAC can also be continued. In this example, an optimization of a simple quadratic
function is continued. We use a custom callback, to artificially stop the first optimization.
SMAC can also be continued from a previous run. To do so, it reads in old files (derived from scenario's name,
output_directory and seed) and sets the corresponding components. In this example, an optimization of a simple quadratic
function is continued.
First, after creating a scenario with 50 trials, we run SMAC with overwrite=True. This will
overwrite any previous runs (in case the example was called before). We use a custom callback to artificially stop
this first optimization after 10 trials.
Second, we again run the SMAC optimization using the same scenario, but this time with overwrite=False. As
there already is a previous run with the same meta data, this run will be continued until the 50 trials are reached.
"""

from __future__ import annotations
Expand Down
Loading

0 comments on commit 541ee7e

Please sign in to comment.