*****
Oríon
*****
|pypi| |py_versions| |license| |doi|
|rtfd| |codecov| |github-actions|
.. |pypi| image:: https://img.shields.io/pypi/v/orion.svg
:target: https://pypi.python.org/pypi/orion
:alt: Current PyPi Version
.. |py_versions| image:: https://img.shields.io/pypi/pyversions/orion.svg
:target: https://pypi.python.org/pypi/orion
:alt: Supported Python Versions
.. |license| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
:target: https://opensource.org/licenses/BSD-3-Clause
:alt: BSD 3-clause license
.. |doi| image:: https://zenodo.org/badge/102697867.svg
:target: https://zenodo.org/badge/latestdoi/102697867
:alt: DOI
.. |rtfd| image:: https://readthedocs.org/projects/orion/badge/?version=stable
:target: https://orion.readthedocs.io/en/stable/?badge=stable
:alt: Documentation Status
.. |codecov| image:: https://codecov.io/gh/Epistimio/orion/branch/master/graph/badge.svg
:target: https://codecov.io/gh/Epistimio/orion
:alt: Codecov Report
.. |github-actions| image:: https://github.com/Epistimio/orion/workflows/build/badge.svg?branch=master&event=pull_request
:target: https://github.com/Epistimio/orion/actions?query=workflow:build+branch:master+event:schedule
:alt: Github actions tests
Oríon is an asynchronous framework for black-box function optimization.
Its purpose is to serve as a meta-optimizer for machine learning models
and training, as well as a flexible experimentation
platform for large scale asynchronous optimization procedures.
Core design value is the minimum disruption of a researcher's workflow.
It allows fast and efficient tuning, providing minimum simple non-intrusive
(not even necessary!) helper *client* interface for a user's script.
So if ``./run.py --mini-batch=50`` looks like what you execute normally,
now what you have to do looks like this:
``orion -n experiment_name ./run.py --mini-batch~'randint(32, 256)'``
Check out our `getting started guide`_ or `this presentation
<https://bluejeans.com/playback/s/4WUezzFCmb9StHzYgB0RjVbTUCKnRcptBvzBMP7t2UpLyKuAq7Emieo911BqEMnI>`_
for an overview, or our `scikit-learn example`_ for a more hands-on experience. Finally we
encourage you to browse our `documentation`_.
.. _getting started guide: https://orion.readthedocs.io/en/stable/install/gettingstarted.html
.. _documentation: https://orion.readthedocs.io/
.. _scikit-learn example: https://orion.readthedocs.io/en/stable/tutorials/scikit-learn.html
Why Oríon?
==========
*Effortless to adopt, deeply customizable*
- `Adopt it <https://orion.readthedocs.io/en/stable/user/script.html>`_ with a single line of code
- `Natively asynchronous <https://orion.readthedocs.io/en/stable/code/core.html>`_, thus resilient and easy to parallelize
- Offers the latest established hyperparameter `algorithms <https://orion.readthedocs.io/en/stable/user/algorithms.html>`_
- Elegant and rich `search-space definitions <https://orion.readthedocs.io/en/stable/user/searchspace.html>`_
- Comprehensive `configuration <https://orion.readthedocs.io/en/stable/user/config.html>`_ system with smart defaults
- Transparent persistence in local or remote `database <https://orion.readthedocs.io/en/stable/install/database.html>`_
- `Integrate seamlessly <https://orion.readthedocs.io/en/stable/plugins/base.html>`_ your own
hyper-optimization algorithms
- `Language <https://orion.readthedocs.io/en/stable/user/script.html#language-compatibility>`_
and `configuration file <https://orion.readthedocs.io/en/stable/user/searchspace.html#configuration-file>`_ agnostic
Installation
============
Install Oríon by running ``$ pip install orion``. For more information consult the `installation
guide`_.
.. _installation guide: https://orion.readthedocs.io/en/stable/install/core.html
Presentations
=============
- 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>`__)
(`Slides
<https://docs.google.com/presentation/d/1Tq3KrWcp66wdlZJtCFaxfq1m5ydyhcPiDCGCOuh_REg/edit?usp=sharing>`__)
- 2019-11-28 - Tech-talk @ Mila
(`Video
<https:/bluejeans.com/playback/s/4WUezzFCmb9StHzYgB0RjVbTUCKnRcptBvzBMP7t2UpLyKuAq7Emieo911BqEMnI>`__)
(`Slides
<https://docs.google.com/presentation/d/18g7Q4xRuhMtcVbwmFwDfH7v9gKS252-laOi9HrEQ7a4/edit?usp=sharing>`__)
Contribute or Ask
=================
Do you have a question or issues?
Do you want to report a bug or suggest a feature? Name it!
Please contact us by opening an issue in our repository below and checkout our `contribution guidelines <https://github.com/Epistimio/orion/blob/develop/CONTRIBUTING.md>`_:
- Issue Tracker: `<https://github.com/epistimio/orion/issues>`_
- Source Code: `<https://github.com/epistimio/orion>`_
Start by starring and forking our Github repo!
Thanks for the support!
Citation
========
If you use Oríon for published work, please cite our work using the following bibtex entry.
.. code-block:: bibtex
@software{xavier_bouthillier_2022_0_2_6,
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 = august,
year = 2022,
publisher = {Zenodo},
version = {v0.2.6,
doi = {10.5281/zenodo.3478592},
url = {https://doi.org/10.5281/zenodo.3478592}
}
Roadmap
=======
See `ROADMAP.md <https://github.com/Epistimio/orion/blob/master/ROADMAP.md>`_.
License
=======
The project is licensed under the `BSD license <https://github.com/Epistimio/orion/blob/master/LICENSE>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/epistimio/orion",
"name": "orion",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Machine Learning,Deep Learning,Distributed,Optimization",
"author": "Epist\u00edmio",
"author_email": "xavier.bouthillier@umontreal.ca",
"download_url": "https://files.pythonhosted.org/packages/47/0a/48bc10e7c22b3d7cb87243c4c110aa894f745ebbe7f72b21bde2a406b785/orion-0.2.6.tar.gz",
"platform": "Linux",
"description": "*****\nOr\u00edon\n*****\n\n|pypi| |py_versions| |license| |doi|\n|rtfd| |codecov| |github-actions|\n\n.. |pypi| image:: https://img.shields.io/pypi/v/orion.svg\n :target: https://pypi.python.org/pypi/orion\n :alt: Current PyPi Version\n\n.. |py_versions| image:: https://img.shields.io/pypi/pyversions/orion.svg\n :target: https://pypi.python.org/pypi/orion\n :alt: Supported Python Versions\n\n.. |license| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg\n :target: https://opensource.org/licenses/BSD-3-Clause\n :alt: BSD 3-clause license\n\n.. |doi| image:: https://zenodo.org/badge/102697867.svg\n :target: https://zenodo.org/badge/latestdoi/102697867\n :alt: DOI\n\n.. |rtfd| image:: https://readthedocs.org/projects/orion/badge/?version=stable\n :target: https://orion.readthedocs.io/en/stable/?badge=stable\n :alt: Documentation Status\n\n.. |codecov| image:: https://codecov.io/gh/Epistimio/orion/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/Epistimio/orion\n :alt: Codecov Report\n\n.. |github-actions| image:: https://github.com/Epistimio/orion/workflows/build/badge.svg?branch=master&event=pull_request\n :target: https://github.com/Epistimio/orion/actions?query=workflow:build+branch:master+event:schedule\n :alt: Github actions tests\n\nOr\u00edon is an asynchronous framework for black-box function optimization.\n\nIts purpose is to serve as a meta-optimizer for machine learning models\nand training, as well as a flexible experimentation\nplatform for large scale asynchronous optimization procedures.\n\nCore design value is the minimum disruption of a researcher's workflow.\nIt allows fast and efficient tuning, providing minimum simple non-intrusive\n(not even necessary!) helper *client* interface for a user's script.\n\nSo if ``./run.py --mini-batch=50`` looks like what you execute normally,\nnow what you have to do looks like this:\n\n``orion -n experiment_name ./run.py --mini-batch~'randint(32, 256)'``\n\nCheck out our `getting started guide`_ or `this presentation\n<https://bluejeans.com/playback/s/4WUezzFCmb9StHzYgB0RjVbTUCKnRcptBvzBMP7t2UpLyKuAq7Emieo911BqEMnI>`_\nfor an overview, or our `scikit-learn example`_ for a more hands-on experience. Finally we\nencourage you to browse our `documentation`_.\n\n.. _getting started guide: https://orion.readthedocs.io/en/stable/install/gettingstarted.html\n.. _documentation: https://orion.readthedocs.io/\n.. _scikit-learn example: https://orion.readthedocs.io/en/stable/tutorials/scikit-learn.html\n\nWhy Or\u00edon?\n==========\n\n*Effortless to adopt, deeply customizable*\n\n- `Adopt it <https://orion.readthedocs.io/en/stable/user/script.html>`_ with a single line of code\n- `Natively asynchronous <https://orion.readthedocs.io/en/stable/code/core.html>`_, thus resilient and easy to parallelize\n- Offers the latest established hyperparameter `algorithms <https://orion.readthedocs.io/en/stable/user/algorithms.html>`_\n- Elegant and rich `search-space definitions <https://orion.readthedocs.io/en/stable/user/searchspace.html>`_\n- Comprehensive `configuration <https://orion.readthedocs.io/en/stable/user/config.html>`_ system with smart defaults\n- Transparent persistence in local or remote `database <https://orion.readthedocs.io/en/stable/install/database.html>`_\n- `Integrate seamlessly <https://orion.readthedocs.io/en/stable/plugins/base.html>`_ your own\n hyper-optimization algorithms\n- `Language <https://orion.readthedocs.io/en/stable/user/script.html#language-compatibility>`_\n and `configuration file <https://orion.readthedocs.io/en/stable/user/searchspace.html#configuration-file>`_ agnostic\n\nInstallation\n============\n\nInstall Or\u00edon by running ``$ pip install orion``. For more information consult the `installation\nguide`_.\n\n.. _installation guide: https://orion.readthedocs.io/en/stable/install/core.html\n\nPresentations\n=============\n\n- 2021-07-14 - SciPy 2021 (`Video <https://youtu.be/H1jQBQIbQmA>`__) (`Slides <https://docs.google.com/presentation/d/1Aekt1hKtiT1y7pyvWeRRoVND4cDUYFj53xAzk8Zb8z0/edit?usp=sharing>`__)\n- 2021-05-19 - Dask Summit 2021 (`Video <https://youtu.be/W5oWdRiSSr8>`__) (`Slides <https://docs.google.com/presentation/d/1MBy0gjWNV-8GjtEXVLCThN8JddK7znHSg7puycwkBZ4/edit?usp=sharing>`__)\n- 2021-03-16 - AICamp\n (`Video\n <https://www.youtube.com/watch?v=QQ69vxF3LTI>`__)\n (`Slides\n <https://docs.google.com/presentation/d/1Tq3KrWcp66wdlZJtCFaxfq1m5ydyhcPiDCGCOuh_REg/edit?usp=sharing>`__)\n- 2019-11-28 - Tech-talk @ Mila\n (`Video\n <https:/bluejeans.com/playback/s/4WUezzFCmb9StHzYgB0RjVbTUCKnRcptBvzBMP7t2UpLyKuAq7Emieo911BqEMnI>`__)\n (`Slides\n <https://docs.google.com/presentation/d/18g7Q4xRuhMtcVbwmFwDfH7v9gKS252-laOi9HrEQ7a4/edit?usp=sharing>`__)\n\nContribute or Ask\n=================\n\nDo you have a question or issues?\nDo you want to report a bug or suggest a feature? Name it!\nPlease contact us by opening an issue in our repository below and checkout our `contribution guidelines <https://github.com/Epistimio/orion/blob/develop/CONTRIBUTING.md>`_:\n\n- Issue Tracker: `<https://github.com/epistimio/orion/issues>`_\n- Source Code: `<https://github.com/epistimio/orion>`_\n\nStart by starring and forking our Github repo!\n\nThanks for the support!\n\nCitation\n========\n\nIf you use Or\u00edon for published work, please cite our work using the following bibtex entry.\n\n.. code-block:: bibtex\n\n @software{xavier_bouthillier_2022_0_2_6,\n author = {Xavier Bouthillier and\n Christos Tsirigotis and\n Fran\u00e7ois Corneau-Tremblay and\n Thomas Schweizer and\n Lin Dong and\n Pierre Delaunay and\n Fabrice Normandin and\n Mirko Bronzi and\n Dendi Suhubdy and\n Reyhane Askari and\n Michael Noukhovitch and\n Chao Xue and\n Satya Ortiz-Gagn\u00e9 and\n Olivier Breuleux and\n Arnaud Bergeron and\n Olexa Bilaniuk and\n Steven Bocco and\n Hadrien Bertrand and\n Guillaume Alain and\n Dmitriy Serdyuk and\n Peter Henderson and\n Pascal Lamblin and\n Christopher Beckham},\n title = {{Epistimio/orion: Asynchronous Distributed Hyperparameter Optimization}},\n month = august,\n year = 2022,\n publisher = {Zenodo},\n version = {v0.2.6,\n doi = {10.5281/zenodo.3478592},\n url = {https://doi.org/10.5281/zenodo.3478592}\n }\n\nRoadmap\n=======\n\nSee `ROADMAP.md <https://github.com/Epistimio/orion/blob/master/ROADMAP.md>`_.\n\nLicense\n=======\n\nThe project is licensed under the `BSD license <https://github.com/Epistimio/orion/blob/master/LICENSE>`_.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Asynchronous [black-box] Optimization",
"version": "0.2.6",
"split_keywords": [
"machine learning",
"deep learning",
"distributed",
"optimization"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "35e7f122885d2157bdfe6dc269b0fc34",
"sha256": "105d1c4d6144fbf1cf62b0fce38e4b1f5e7433699c0a1586e83f78f30cbd798c"
},
"downloads": -1,
"filename": "orion-0.2.6.tar.gz",
"has_sig": false,
"md5_digest": "35e7f122885d2157bdfe6dc269b0fc34",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 27278782,
"upload_time": "2022-08-22T17:09:12",
"upload_time_iso_8601": "2022-08-22T17:09:12.640694Z",
"url": "https://files.pythonhosted.org/packages/47/0a/48bc10e7c22b3d7cb87243c4c110aa894f745ebbe7f72b21bde2a406b785/orion-0.2.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-08-22 17:09:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "epistimio",
"github_project": "orion",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "orion"
}
JSON
