Merge pull request #794 from Epistimio/release-v0.2.2rc1

Release v0.2.2rc1
Epistimio · Feb 12, 2022 · 133a069 · 133a069
2 parents 5380bc6 + 72f3603
commit 133a069
Show file tree

Hide file tree

Showing 142 changed files with 8,924 additions and 2,748 deletions.
diff --git a/.gitignore b/.gitignore
@@ -80,3 +80,8 @@ target/
 
 # Notebooks
 tests/**.ipynb
+
+# Generated doc
+docs/src/auto_examples
+docs/src/auto_tutorials
+docs/src/gen_modules
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 Software License Agreement (BSD License)
 
- Copyright (c) 2017-2021, Epistímio.
+ Copyright (c) 2017-2022, Epistímio.
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without

diff --git a/README.rst b/README.rst
@@ -118,13 +118,14 @@ If you use Oríon for published work, please cite our work using the following b
 
 .. code-block:: bibtex
 
-   @software{xavier_bouthillier_2021_0_2_1,
+   @software{xavier_bouthillier_2022_0_2_2,
      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
@@ -142,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        = nov,
-     year         = 2021,
+     month        = feb,
+     year         = 2022,
      publisher    = {Zenodo},
-     version      = {v0.2.1},
+     version      = {v0.2.2},
      doi          = {10.5281/zenodo.3478592},
      url          = {https://doi.org/10.5281/zenodo.3478592}
    }

diff --git a/ROADMAP.md b/ROADMAP.md
@@ -1,25 +1,14 @@
 # Roadmap
-Last update Nov 23rd, 2021
+Last update Feb 11th, 2022
 
 ## Next releases - Short-Term
 
-### v0.2.2
-
-- New master process to enhance parallelisation efficiency.
-- [PBT](https://arxiv.org/abs/1711.09846)
-
 ### v0.2.3
 
-- Use shared algo serialization instead of replications to enhance parallelisation efficiency.
 - [DEBH](https://arxiv.org/abs/2105.09821)
-
-### v0.2.4
-
 - [HEBO](https://github.com/huawei-noah/HEBO/tree/master/HEBO/archived_submissions/hebo)
-
-### v0.2.5
-
 - [BOHB](https://ml.informatik.uni-freiburg.de/papers/18-ICML-BOHB.pdf)
+- Integration with Hydra
 
 ## Next releases - Mid-Term
 

diff --git a/conda/meta.yaml b/conda/meta.yaml
@@ -17,6 +17,8 @@ requirements:
     - pytest-runner
     - appdirs
   run:
+    - cloudpickle
+    - dataclasses
     - python
     - numpy
     - scipy

diff --git a/docs/src/code/algo.rst b/docs/src/code/algo.rst
@@ -2,8 +2,6 @@
 Algorithm modules
 *****************
 
-TODO
-
 .. automodule:: orion.algo
    :members:
 
@@ -17,4 +15,6 @@ TODO
    algo/gridsearch
    algo/hyperband
    algo/asha
+   algo/pbt
    algo/tpe
+   algo/parallel_strategy
diff --git a/docs/src/code/algo/asha.rst b/docs/src/code/algo/asha.rst
@@ -1,8 +1,5 @@
 Asynchronous Successive Halving Algorithm
 =========================================
 
-Can't build documentation because of import order.
-Sphinx is loading ``orion.algo.asha`` before ``orion.algo`` and therefore
-there is a cycle between the definition of ``BaseAlgorithm`` and
-``ASHA`` as the meta-class ``Factory`` is trying to import ``ASHA``.
-`PR #135 <https://github.com/Epistimio/orion/pull/135/files>`_ should get rid of this problem.
+.. automodule:: orion.algo.asha
+   :members:
diff --git a/docs/src/code/algo/base.rst b/docs/src/code/algo/base.rst
@@ -3,5 +3,3 @@ Base definition of algorithms
 
 .. autoclass:: orion.algo.base.BaseAlgorithm
    :members:
-
-
diff --git a/docs/src/code/algo/parallel_strategy.rst b/docs/src/code/algo/parallel_strategy.rst
@@ -0,0 +1,5 @@
+Parallel Strategy
+=================
+
+.. automodule:: orion.algo.parallel_strategy
+   :members:
diff --git a/docs/src/code/algo/pbt.rst b/docs/src/code/algo/pbt.rst
@@ -0,0 +1,89 @@
+Population Based Training
+=========================
+
+.. contents::
+   :depth: 3
+   :local:
+
+.. role:: hidden
+    :class: hidden-section
+
+Population Based Training
+-------------------------
+
+.. autoclass:: orion.algo.pbt.pbt.PBT
+   :members:
+
+LineageNode
+-----------
+
+.. autoclass:: orion.algo.pbt.pbt.LineageNode
+   :members:
+
+Lineages
+--------
+
+.. autoclass:: orion.algo.pbt.pbt.Lineages
+   :members:
+
+Exploit classes for Population Based Training
+---------------------------------------------
+
+BaseExploit
+~~~~~~~~~~~
+
+.. autoclass:: orion.algo.pbt.exploit.BaseExploit
+   :members:
+
+
+PipelineExploit
+~~~~~~~~~~~~~~~
+
+.. autoclass:: orion.algo.pbt.exploit.PipelineExploit
+   :members:
+
+
+TruncateExploit
+~~~~~~~~~~~~~~~
+
+.. autoclass:: orion.algo.pbt.exploit.TruncateExploit
+   :members:
+
+BacktrackExploit
+~~~~~~~~~~~~~~~~
+
+.. autoclass:: orion.algo.pbt.exploit.BacktrackExploit
+   :members:
+
+Explore classes for Population Based Training
+---------------------------------------------
+
+BaseExplore
+~~~~~~~~~~~
+
+.. autoclass:: orion.algo.pbt.explore.BaseExplore
+   :members:
+
+
+PipelineExplore
+~~~~~~~~~~~~~~~
+
+.. autoclass:: orion.algo.pbt.explore.PipelineExplore
+   :members:
+
+
+PerturbExplore
+~~~~~~~~~~~~~~
+
+.. autoclass:: orion.algo.pbt.explore.PerturbExplore
+   :members:
+
+ResampleExplore
+~~~~~~~~~~~~~~~
+
+.. autoclass:: orion.algo.pbt.explore.ResampleExplore
+   :members:
+
+
+
+
diff --git a/docs/src/code/core/cli/db.rst b/docs/src/code/core/cli/db.rst
@@ -8,5 +8,9 @@ db commands
    :maxdepth: 1
    :caption: DB command line modules
 
-   db/test
    db/setup
+   db/test
+   db/upgrade
+   db/rm
+   db/set
+   db/release
diff --git a/docs/src/code/core/cli/db/release.rst b/docs/src/code/core/cli/db/release.rst
@@ -0,0 +1,5 @@
+db release command
+==================
+
+.. automodule:: orion.core.cli.db.release
+   :members:
diff --git a/docs/src/code/core/cli/db/rm.rst b/docs/src/code/core/cli/db/rm.rst
@@ -0,0 +1,5 @@
+db rm command
+=============
+
+.. automodule:: orion.core.cli.db.rm
+   :members:
diff --git a/docs/src/code/core/cli/db/set.rst b/docs/src/code/core/cli/db/set.rst
@@ -0,0 +1,5 @@
+db set command
+==============
+
+.. automodule:: orion.core.cli.db.set
+   :members:
diff --git a/docs/src/code/core/cli/db/upgrade.rst b/docs/src/code/core/cli/db/upgrade.rst
@@ -0,0 +1,5 @@
+db upgrade command
+==================
+
+.. automodule:: orion.core.cli.db.upgrade
+   :members:
diff --git a/docs/src/code/core/evc.rst b/docs/src/code/core/evc.rst
@@ -8,7 +8,6 @@ Experiment Version Control
    :maxdepth: 1
    :caption: Modules
 
-   evc/tree
    evc/experiment
    evc/adapters
    evc/conflicts
diff --git a/docs/src/code/core/utils.rst b/docs/src/code/core/utils.rst
@@ -9,6 +9,7 @@ Utilities
    utils/format_trials
    utils/format_terminal
    utils/singleton
+   utils/tree
 
 .. automodule:: orion.core.utils
    :members:
diff --git a/docs/src/code/core/evc/tree.rst → docs/src/code/core/utils/tree.rst b/docs/src/code/core/evc/tree.rst → docs/src/code/core/utils/tree.rst
@@ -1,5 +1,5 @@
 Generic Tree
 ============
 
-.. automodule:: orion.core.evc.tree
+.. automodule:: orion.core.utils.tree
    :members:
diff --git a/docs/src/code/core/worker.rst b/docs/src/code/core/worker.rst
@@ -12,7 +12,6 @@ Worker and its components
    worker/experiment
    worker/primary_algo
    worker/producer
-   worker/strategy
    worker/transformer
    worker/trial
    worker/trial_pacemaker
diff --git a/docs/src/code/core/worker/strategy.rst b/docs/src/code/core/worker/strategy.rst
diff --git a/docs/src/conf.py b/docs/src/conf.py
@@ -293,6 +293,7 @@
     "orion.plotting.base.PlotAccessor.__call__",
     "orion.benchmark.task.BaseTask.__call__",
     "orion.benchmark.task.base.BaseTask.__call__",
+    "AlreadyReleased",
 ]
 
 nitpicky = True