An open API service indexing awesome lists of open source software.

https://github.com/jungtaekkim/bayeso

Simple, but essential Bayesian optimization package
https://github.com/jungtaekkim/bayeso

bayesian-optimization hyperparameter-optimization machine-learning

Last synced: about 1 year ago
JSON representation

Simple, but essential Bayesian optimization package

Awesome Lists containing this project

README

          



# BayesO: A Bayesian Optimization Framework in Python
[![DOI](https://joss.theoj.org/papers/10.21105/joss.05320/status.svg)](https://doi.org/10.21105/joss.05320)
[![Build Status](https://github.com/jungtaekkim/bayeso/actions/workflows/pytest.yml/badge.svg)](https://github.com/jungtaekkim/bayeso/actions/workflows/pytest.yml)
[![Coverage Status](https://coveralls.io/repos/github/jungtaekkim/bayeso/badge.svg?branch=main)](https://coveralls.io/github/jungtaekkim/bayeso?branch=main)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/bayeso)](https://pypi.org/project/bayeso/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Documentation Status](https://readthedocs.org/projects/bayeso/badge/?version=main)](https://bayeso.readthedocs.io/en/main/?badge=main)



Simple, but essential Bayesian optimization package.

* [https://bayeso.org](https://bayeso.org)
* [Online documentation](https://bayeso.readthedocs.io)

## Installation
We recommend installing it with `virtualenv`.
You can choose one of three installation options.

* Using PyPI repository (for user installation)

To install the released version in PyPI repository, command it.

```shell
$ pip install bayeso
```

* Using source code (for developer installation)

To install `bayeso` from source code, command the following in the `bayeso` root.

```shell
pip install .
```

* Using source code (for editable development mode)

To use editable development mode, command the following in the `bayeso` root.

```shell
pip install -e .
```

If you want to install the packages required for optional features, development, and examples, you can simply add `[optional]`, `[dev]`, and `[examples]`.
For example, `pip install .[dev]` or `pip install -e .[dev]`.

* Uninstallation

If you would like to uninstall `bayeso`, command it.

```shell
$ pip uninstall bayeso
```

## Supported Python Version
We test our package in the following versions.

* Python 3.7
* Python 3.8
* Python 3.9
* Python 3.10
* Python 3.11

## Examples and Tests
We provide a [list of examples](EXAMPLES.md) and a [list of tests](TESTS.md).

## Citation
```
@article{KimJ2023joss,
author={Kim, Jungtaek and Choi, Seungjin},
title={{BayesO}: A {Bayesian} optimization framework in {Python}},
journal={Journal of Open Source Software},
volume={8},
number={90},
pages={5320},
year={2023}
}
```

## License
[MIT License](LICENSE)