Merging with master

automl · Nov 2, 2023 · c94dffe · c94dffe
2 parents e91f0c8 + 88a3b96
commit c94dffe
Show file tree

Hide file tree

Showing 41 changed files with 1,925 additions and 339 deletions.
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -12,12 +12,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
         os: [ubuntu-latest, macos-latest, windows-latest]
         exclude:
           - os: macos-latest  # Segmentation fault on github actions that we can not reproduce in the wild
-            python-version: '3.7'
-          - os: macos-latest
             python-version: '3.8'
 
     runs-on: ${{ matrix.os }}

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -30,7 +30,7 @@ repos:
     rev: v3.3.1
     hooks:
       - id: pyupgrade
-        args: [--py37-plus]
+        args: [--py38-plus]
 
   - repo: https://github.com/executablebooks/mdformat
     rev: 0.7.16

diff --git a/CITATION.cff b/CITATION.cff
@@ -3,27 +3,29 @@ message: "If you use this software, please cite it as below."
 authors:
   - family-names: Stoll
     given-names: Danny
+  - family-names: Mallik
+    given-names: Neeratyoy
   - family-names: Schrodi
     given-names: Simon
   - family-names: Janowski
     given-names: Maciej
-  - family-names: Mallik
-    given-names: Neeratyoy
+  - family-names: Garibov
+    given-names: Samir
+  - family-names: Abou Chakra
+    given-names: Tarek
   - family-names: Hvarfner
     given-names: Carl
+  - family-names: Bergman
+    given-names: Eddie
   - family-names: Binxin
     given-names: Ru
-  - family-names: Garibov
-    given-names: Samir
   - family-names: Kober
     given-names: Nils
-  - family-names: Bergman
-    given-names: Eddie
   - family-names: Vallaeys
     given-names: Théophane
   - family-names: Hutter
     given-names: Frank
 title: "Neural Pipeline Search (NePS)"
-version: 0.8.4
-date-released: 2023-05-04
+version: 0.9.0
+date-released: 2023-10-25
 url: "https://github.com/automl/neps"
diff --git a/docs/contributing/installation.md b/docs/contributing/installation.md
@@ -24,7 +24,7 @@ Consider running `~/.conda/bin/conda init` or `~/.conda/bin/conda init zsh` .
 Then finally create the environment and activate it
 
 ```bash
-conda create -n neps python=3.7.5
+conda create -n neps python=3.10
 conda activate neps
 ```
 
@@ -46,7 +46,14 @@ to your `.zshrc` / `.bashrc` or alternatively simply running the export manually
 
 ## 3. Install the neps Package Using poetry
 
-Inside the main directory of neps run
+Clone the repository, e.g.,
+
+```bash
+git clone https://github.com/automl/neps.git
+cd neps
+```
+
+Then, inside the main directory of neps run
 
 ```bash
 poetry install

diff --git a/docs/contributing/metahyper/README.md b/docs/contributing/metahyper/README.md
diff --git a/docs/contributing/metahyper/api.md b/docs/contributing/metahyper/api.md
diff --git a/docs/contributing/metahyper/evaluation_fn.md b/docs/contributing/metahyper/evaluation_fn.md
diff --git a/docs/contributing/metahyper/getting_started.md b/docs/contributing/metahyper/getting_started.md
diff --git a/docs/contributing/metahyper/parallelization.md b/docs/contributing/metahyper/parallelization.md
diff --git a/docs/contributing/metahyper/sampler.md b/docs/contributing/metahyper/sampler.md
diff --git a/docs/contributing/releasing.md b/docs/contributing/releasing.md
@@ -15,7 +15,7 @@ We follow the [semantic versioning](https://semver.org) scheme.
 ## 1. Update the Package Version and CITATION.cff
 
 ```bash
-poetry version v0.4.10
+poetry version v0.9.0
 ```
 
 and manually change the version specified in `CITATION.cff`.
@@ -26,14 +26,14 @@ First commit and test
 
 ```bash
 git add pyproject.toml
-git commit -m "Bump version from v0.4.9 to v0.4.10"
+git commit -m "Bump version from v0.8.4 to v0.9.0"
 pytest
 ```
 
 Then tag and push
 
 ```bash
-git tag v0.4.10
+git tag v0.9.0
 git push --tags
 git push
 ```
@@ -43,7 +43,7 @@ git push
 First check if the documentation has any issues via
 
 ```bash
-mike deploy 0.4.10 latest -u
+mike deploy 0.9.0 latest -u
 mike serve
 ```
 
@@ -52,7 +52,7 @@ and then looking at it.
 Afterwards, publish it via
 
 ```bash
-mike deploy 0.4.10 latest -up
+mike deploy 0.9.0 latest -up
 ```
 
 ## 4. Publish on PyPI

diff --git a/docs/contributing/roadmap.md b/docs/contributing/roadmap.md
@@ -1,6 +1,6 @@
 # Roadmap
 
-## Before 0.9.0
+## Before 0.10.0
 
 ### Features
 
@@ -15,7 +15,7 @@
 
 - Fill up the core documentation pages
 
-## Before 0.10.0
+## Before 0.11.0
 
 ### Features
 

diff --git a/neps_examples/README.md b/neps_examples/README.md
@@ -2,8 +2,10 @@
 
 1. Examples for the [basic usage](basic_usage) showing how to perform HPO / NAS / JAHS and how to analyse runs.
 
-1. Examples for how to [boost efficiency](efficiency) with expert_priors and/or multi fidelity and/or parallelization.
+2. Examples for how to [boost efficiency](efficiency) with expert_priors and/or multi fidelity and/or parallelization.
 
-1. Examples showcasing some [utilities for your convenience](convenience).
+3. Examples showcasing some [utilities for your convenience](convenience).
 
-1. [Experimental examples](experimental) which are mostly useful for NePS contributors.
+4. [Experimental examples](experimental) which are mostly useful for NePS contributors.
+
+5. [template](template) which is a template for creating a neps program.