Skip to content

mlg-postech/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

$ pip install .

in the bayeso root.

  • Using source code (for editable development mode)

To use editable development mode, command

$ pip install -r requirements.txt
$ python setup.py develop

in the bayeso root.

  • Uninstallation

If you would like to uninstall bayeso, command it.

$ pip uninstall bayeso

Required Packages

Mandatory pacakges are inlcuded in requirements.txt. The following requirements files include the package list, the purpose of which is described as follows.

  • requirements-optional.txt: It is an optional package list, but it needs to be installed to execute some features of bayeso.
  • requirements-dev.txt: It is for developing the bayeso package.
  • requirements-examples.txt: It needs to be installed to execute the examples included in the bayeso repository.

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

About

Simple, but essential Bayesian optimization package

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%