Skip to content

Simple, but essential Bayesian optimization package

License

Notifications You must be signed in to change notification settings

jungtaekkim/bayeso

Repository files navigation

BayesO: A Bayesian Optimization Framework in Python

DOI Build Status Coverage Status PyPI - Python Version License: MIT Documentation Status

Simple, but essential Bayesian optimization package.

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.

$ pip install bayeso
  • Using source code (for developer installation)

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

pip install .
  • Using source code (for editable development mode)

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

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.

$ 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 and a list of tests.

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