Merge pull request #932 from Epistimio/release-v0.2.4rc2

Release candidate v0.2.4

.github/workflows/build.yml

@@ -21,15 +21,15 @@ jobs:
 
     steps:
     - uses: actions/checkout@v1
-    - name: Set up Python 3.7
+    - name: Set up Python 3.9
       uses: actions/setup-python@v2
       with:
-        python-version: 3.7
+        python-version: 3.9
     - name: Install dependencies
       run: |
           python -m pip install --upgrade pip
           pip install tox tox-gh-actions
-    - name: Test with tox
+    - name: Run pre-tests with Tox
       run: tox -e ${{ matrix.toxenv }}
   test:
     needs: pretest
@@ -38,7 +38,7 @@ jobs:
       max-parallel: 4
       matrix:
         platform: [ubuntu-latest]
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: [3.7, 3.8, 3.9]
     env:
       PLATFORM: ${{ matrix.platform }}
     steps:
@@ -51,6 +51,64 @@ jobs:
       run: |
           python -m pip install --upgrade pip
           pip install tox tox-gh-actions
+    - name: Test with tox (and all extra dependencies)
+      run: tox -e py-all
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v1
+      with:
+        file: ./coverage.xml
+        flags: unittests
+        env_vars: PLATFORM,PYTHON
+        name: codecov-umbrella
+        fail_ci_if_error: false
+
+  test-long-algos:
+    needs: pretest
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      matrix:
+        platform: [ubuntu-latest]
+        python-version: [3.7, 3.8, 3.9]
+        algo: [nevergrad, hebo, ax]
+    env:
+      PLATFORM: ${{ matrix.platform }}
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+          python -m pip install --upgrade pip
+          pip install tox tox-gh-actions
+
+    - name: Test long algorithms with tox
+      run: tox -e algo -- tests/unittests/algo/long/${{ matrix.algo }}
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v1
+      with:
+        file: ./coverage.xml
+        flags: unittests
+        env_vars: PLATFORM,PYTHON
+        name: codecov-umbrella
+        fail_ci_if_error: false
+
+  test_no_extras:
+    needs: pretest
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+    - name: Install dependencies
+      run: |
+          python -m pip install --upgrade pip
+          pip install tox tox-gh-actions
     - name: Test with tox
       run: tox -e py
     - name: Upload coverage to Codecov
@@ -66,10 +124,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
-      - name: Set up Python 3.7
+      - name: Set up Python 3.9
         uses: actions/setup-python@v2
         with:
-          python-version: 3.7
+          python-version: 3.9
       - name: Setup MongoDB
         uses: supercharge/mongodb-github-action@1.3.0
         with:
@@ -101,10 +159,10 @@ jobs:
       ORION_DB_TYPE: ${{ matrix.orion_db_type }}
     steps:
     - uses: actions/checkout@v1
-    - name: Set up Python 3.7
+    - name: Set up Python 3.9
       uses: actions/setup-python@v2
       with:
-        python-version: 3.7
+        python-version: 3.9
     - name: Setup MongoDB
       uses: supercharge/mongodb-github-action@1.3.0
       with:
@@ -126,14 +184,14 @@ jobs:
         name: codecov-umbrella
         fail_ci_if_error: false
   pypi:
-    needs: [test, backward-compatibility]
+    needs: [test, backward-compatibility, test-long-algos]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
-    - name: Set up Python 3.7
+    - name: Set up Python 3.9
       uses: actions/setup-python@v2
       with:
-        python-version: 3.7
+        python-version: 3.9
     - name: Install dependencies
       run: |
           python -m pip install --upgrade pip
@@ -156,16 +214,16 @@ jobs:
         user: __token__
         password: ${{ secrets.pypi_password }}
   conda:
-    needs: [test, backward-compatibility]
+    needs: [test, backward-compatibility, test-long-algos]
     runs-on: ubuntu-latest
     env:
         ANACONDA_TOKEN: ${{ secrets.anaconda_token }}
     steps:
     - uses: actions/checkout@v1
-    - name: Set up Python 3.7
+    - name: Set up Python 3.9
       uses: actions/setup-python@v2
       with:
-        python-version: 3.7
+        python-version: 3.9
     - name: Build conda
       run: ./conda/ci_build.sh
     - name: Publish distribution 📦 to Conda

.github/workflows/dashboard-build.yml

@@ -0,0 +1,57 @@
+name: Dashboard Build PR
+
+on:
+  push:
+    branches: [ develop ]
+
+defaults:
+  run:
+    working-directory: dashboard/src
+
+jobs:
+  build_dashboard:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+      - name: Compile Dashboard
+        run: |
+            # NB: We are in directory dashboard/src
+            yarn
+            yarn build
+            # If previous build folder exists and is same as new one, do not update.
+            # In any other case, we must update.
+            if ( [ -d "../build" ] && diff -qr build ../build ); then UPDATE_BUILD=0; else UPDATE_BUILD=1; fi
+            echo "update_build=${UPDATE_BUILD}" >> $GITHUB_ENV
+            echo Build changes ? ${UPDATE_BUILD}
+      - name: Update compiled Dashboard
+        if: ${{ env.update_build == '1' }}
+        run: |
+            rm -rf ../build
+            mv build ..
+      - name: Create Pull Request
+        if: ${{ env.update_build == '1' }}
+        id: cpr
+        uses: peter-evans/create-pull-request@v3
+        with:
+          commit-message: 'Compile Dashboard'
+          branch: ci/build-dashboard
+          base: develop
+          delete-branch: true
+          title: 'Compile Dashboard'
+          body: |
+            Auto-generated by [create-pull-request][1]
+
+            [1]: https://github.com/peter-evans/create-pull-request
+          labels: |
+            automated pr
+      - name: Check outputs
+        if: ${{ env.update_build == '1' }}
+        run: |
+          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
+          echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"

.github/workflows/orion/orion_config.yaml

@@ -0,0 +1,9 @@
+storage:
+  database:
+      host: '../../.github/workflows/orion/db_dashboard_full.pkl'
+      type: 'pickleddb'
+
+gunicorn:
+   bind: '127.0.0.1:8000'
+   workers: 4
+   threads: 2

.gitignore

@@ -9,6 +9,7 @@
 *.log
 *.pkl
 *.lock
+!.github/workflows/orion/*.pkl
 
 # OS generated files
 .DS_Store
@@ -45,6 +46,7 @@ var/
 *.egg[s]
 MANIFEST
 .pytest_cache
+!dashboard/build
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+---
+repos:
+  - repo: https://github.com/python/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.1.0
+    hooks:
+      - id: codespell
+        args:
+          - --ignore-words-list=nd,reacher,thist,ths,hist
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
+      - id: flake8
+        args:
+          - --ignore=E203,E402,E712,E722,E731,E741,F401,F403,F405,F524,F841,W503,E302,E704
+          - --max-complexity=30
+          - --max-line-length=456
+          - --show-source
+          - --statistics
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        args: ["--profile", "black"]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.31.0
+    hooks:
+      - id: pyupgrade
+        args: ["--py37-plus"]
+  - repo: https://github.com/PyCQA/autoflake
+    rev: v1.4
+    hooks:
+      - id: autoflake
+        args: ["--in-place", "--expand-star-imports", "--remove-all-unused-imports", "--ignore-init-module-imports"]
+
+  - repo: https://github.com/PyCQA/doc8
+    rev: 0.8.1
+    hooks:
+      - id: doc8
+        args: ["--max-line-length=100", "--file-encoding=utf-8"]

.pylintrc

@@ -52,7 +52,7 @@ confidence=
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
 disable=abstract-class-instantiated,useless-super-delegation,no-member,keyword-arg-before-vararg,unidiomatic-typecheck,redefined-outer-name,fixme,F0401,intern-builtin,wrong-import-position,wrong-import-order,no-self-use,
-        C0415, F0010, R0205, R1705, R1711, R1720, W0106, W0107, W0127, W0706, C0330, C0326, W1203
+        C0415, F0010, R0205, R1705, R1711, R1720, W0106, W0107, W0127, W0706, C0330, C0326, W1203, E1136
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

CITATION.bib

@@ -0,0 +1,32 @@
+@software{xavier_bouthillier_2022_0_2_3,
+  author    = {Xavier Bouthillier and
+               Christos Tsirigotis and
+               François Corneau-Tremblay and
+               Thomas Schweizer and
+               Lin Dong and
+               Pierre Delaunay and
+               Fabrice Normandin and
+               Mirko Bronzi and
+               Dendi Suhubdy and
+               Reyhane Askari and
+               Michael Noukhovitch and
+               Chao Xue and
+               Satya Ortiz-Gagné and
+               Olivier Breuleux and
+               Arnaud Bergeron and
+               Olexa Bilaniuk and
+               Steven Bocco and
+               Hadrien Bertrand and
+               Guillaume Alain and
+               Dmitriy Serdyuk and
+               Peter Henderson and
+               Pascal Lamblin and
+               Christopher Beckham},
+  title     = {{Epistimio/orion: Asynchronous Distributed Hyperparameter Optimization}},
+  month     = mar,
+  year      = 2022,
+  publisher = {Zenodo},
+  version   = {v0.2.3},
+  doi       = {10.5281/zenodo.3478592},
+  url       = {https://doi.org/10.5281/zenodo.3478592}
+}

MANIFEST.in

@@ -4,6 +4,7 @@ include *.rst
 include ROADMAP.md
 include CODE_OF_CONDUCT.md
 include CONTRIBUTING.md
+include CITATION.bib
 exclude RESEARCH.md
 
 # Control and setup helpers
@@ -28,6 +29,11 @@ prune docs/src/reference
 recursive-include src *.py
 recursive-include tests *.py *.yaml *.json *.txt *.yml *.in LICENSE
 include tests/requirements.txt
+include .pre-commit-config.yaml
+include CITATION.bib
 
 # Include examples
 recursive-include examples *.md *.py *.pkl *.yaml *.ipynb */requirements.txt
+
+# Exclude dashboard source code
+prune dashboard/src

README.rst

@@ -84,8 +84,8 @@ guide`_.
 Presentations
 =============
 
-- 2021-07-14 - SciPy 2021
-- 2021-05-19 - Dask Summit 2021
+- 2021-07-14 - SciPy 2021 (`Video <https://youtu.be/H1jQBQIbQmA>`__) (`Slides <https://docs.google.com/presentation/d/1Aekt1hKtiT1y7pyvWeRRoVND4cDUYFj53xAzk8Zb8z0/edit?usp=sharing>`__)
+- 2021-05-19 - Dask Summit 2021 (`Video <https://youtu.be/W5oWdRiSSr8>`__) (`Slides <https://docs.google.com/presentation/d/1MBy0gjWNV-8GjtEXVLCThN8JddK7znHSg7puycwkBZ4/edit?usp=sharing>`__)
 - 2021-03-16 - AICamp
   (`Video 
   <https://www.youtube.com/watch?v=QQ69vxF3LTI>`__)
@@ -118,7 +118,7 @@ If you use Oríon for published work, please cite our work using the following b
 
 .. code-block:: bibtex
 
-   @software{xavier_bouthillier_2022_0_2_3,
+   @software{xavier_bouthillier_2022_0_2_4,
      author       = {Xavier Bouthillier and
                      Christos Tsirigotis and
                      François Corneau-Tremblay and
@@ -143,10 +143,10 @@ If you use Oríon for published work, please cite our work using the following b
                      Pascal Lamblin and
                      Christopher Beckham},
      title        = {{Epistimio/orion: Asynchronous Distributed Hyperparameter Optimization}},
-     month        = mar,
+     month        = may,
      year         = 2022,
      publisher    = {Zenodo},
-     version      = {v0.2.3},
+     version      = {v0.2.4},
      doi          = {10.5281/zenodo.3478592},
      url          = {https://doi.org/10.5281/zenodo.3478592}
    }