Version 1.3.4 (#857)

* Added reference to JMLR paper.
* Typos in documentations.
* Code more readable since all typings are imported at the beginning of the file.
* Updated stale bot options.

Co-authored-by: eddiebergman <[email protected]>
Co-authored-by: Carolin Benjamins <[email protected]>
Co-authored-by: Matthias Feurer <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Author: 5 people

.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+
+updates:
+  # This will check for updates to github actions every day
+  # https://docs.github.com/en/[email protected]/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/stale.yml

@@ -6,11 +6,16 @@ daysUntilClose: 7
 
 # Issues with these labels will never be considered stale
 exemptLabels:
-  - pinned
-  - security
+  - bug
+  - dependency
+  - documentation
+  - enhancement
+  - feature
+  - test
+  - example
 
 # Label to use when marking an issue as stale
-staleLabel: wontfix
+staleLabel: stale
 
 # Comment to post when marking an issue as stale. Set to `false` to disable
 markComment: >

.github/workflows/citation.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out a copy of the repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Check whether the citation metadata from CITATION.cff is valid
         uses: citation-file-format/[email protected]

.github/workflows/dist.yml

@@ -22,10 +22,10 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Setup Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: "3.9"
 

.github/workflows/docs.yml

@@ -26,10 +26,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Setup Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: "3.9"
 

.github/workflows/examples.yml

@@ -26,9 +26,9 @@ jobs:
       fail-fast:  false
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Setup Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 

.github/workflows/pre-commit.yml

@@ -21,12 +21,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         submodules: recursive
 
     - name: Setup Python 3.9
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: 3.9
 

.github/workflows/pytest.yml

@@ -48,10 +48,10 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Setup Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -101,7 +101,7 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Conda install
       uses: conda-incubator/setup-miniconda@v2
@@ -137,10 +137,10 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Setup Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 

README.md

@@ -66,20 +66,10 @@ X_val, y_val = np.random.randint(2, size=(5, 2)), np.random.randint(2, size=5)
 
 
 def train_random_forest(config):
-    """ 
-    Trains a random forest on the given hyperparameters, defined by config, and returns the accuracy
-    on the validation data.
-
-    Input:
-        config (Configuration): Configuration object derived from ConfigurationSpace.
-
-    Return:
-        cost (float): Performance measure on the validation data.
-    """
     model = RandomForestClassifier(max_depth=config["depth"])
     model.fit(X_train, y_train)
 
-    # define the evaluation metric as return
+    # Define the evaluation metric as return
     return 1 - model.score(X_val, y_val)
 
 
@@ -125,16 +115,18 @@ Freiburg](http://www.automl.org/).
 If you have found a bug, please report to [issues](https://github.com/automl/SMAC3/issues). Moreover, we are appreciating any kind of help.
 Find our guidlines for contributing to this package [here](https://github.com/automl/SMAC3/blob/master/.github/CONTRIBUTING.md).
 
-If you use SMAC in one of your research projects, please cite us:
+If you use SMAC in one of your research projects, please cite our [JMLR paper](https://jmlr.org/papers/v23/21-0888.html):
 ```
-@misc{lindauer2021smac3,
-      title={SMAC3: A Versatile Bayesian Optimization Package for Hyperparameter Optimization}, 
-      author={Marius Lindauer and Katharina Eggensperger and Matthias Feurer and André Biedenkapp and Difan Deng and Carolin Benjamins and Tim Ruhkopf and René Sass and Frank Hutter},
-      year={2021},
-      eprint={2109.09831},
-      archivePrefix={arXiv},
-      primaryClass={cs.LG}
+@article{JMLR:v23:21-0888,
+  author  = {Marius Lindauer and Katharina Eggensperger and Matthias Feurer and André Biedenkapp and Difan Deng and Carolin Benjamins and Tim Ruhkopf and René Sass and Frank Hutter},
+  title   = {SMAC3: A Versatile Bayesian Optimization Package for Hyperparameter Optimization},
+  journal = {Journal of Machine Learning Research},
+  year    = {2022},
+  volume  = {23},
+  number  = {54},
+  pages   = {1--9},
+  url     = {http://jmlr.org/papers/v23/21-0888.html}
 }
 ```
 
-Copyright (C) 2016-2021  [AutoML Group](http://www.automl.org/).
+Copyright (C) 2016-2022  [AutoML Group](http://www.automl.org/).

changelog.md

@@ -1,3 +1,10 @@
+# 1.3.4
+* Added reference to JMLR paper.
+* Typos in documentations.
+* Code more readable since all typings are imported at the beginning of the file.
+* Updated stale bot options.
+
+
 # 1.3.3
 * Hotfix: Since multi-objective implementation depends on normalized costs, it now is ensured that the
 cached costs are updated everytime a new entry is added.