Metadata-Version: 2.1
Name: feijoa
Version: 0.1.1
Summary: Hyperparameter's optimization framework
Home-page: https://github.com/qnbhd/feijoa
License: GPL-3.0
Keywords: hyperparameters,BBO,optimization,autotuning
Author: Konstantin Templin
Author-email: 1qnbhd@gmail.com
Requires-Python: >=3.8,<3.11
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: SQLAlchemy (>=1.4.35,<2.0.0)
Requires-Dist: click (>=8.1.2)
Requires-Dist: executor (>=23.2)
Requires-Dist: mabalgs (>=0.6.8,<0.7.0)
Requires-Dist: numba (>=0.55.2)
Requires-Dist: numpy (>=1.22.3)
Requires-Dist: pandas (>=1.4.2)
Requires-Dist: plotly (>=5.9.0,<6.0.0)
Requires-Dist: pydantic (>=1.9.0)
Requires-Dist: pydeps (>=1.10.18)
Requires-Dist: pytest-cov (>=3.0.0,<4.0.0)
Requires-Dist: rich (>=12.2.0)
Requires-Dist: scikit-optimize (>=0.9.0)
Requires-Dist: sklearn (>=0.0,<0.1)
Requires-Dist: tinydb (>=4.7.0,<5.0.0)
Project-URL: Repository, https://github.com/qnbhd/feijoa
Description-Content-Type: text/markdown

<p align="left">
          <img width="600" height="250" src="https://raw.githubusercontent.com/qnbhd/feijoa/fa3a125e1a46d7206bee55ec0ba6cf4f580c2e68/docs/feijoa_logo.svg">
</p>

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/feijoa?style=for-the-badge) ![PyPI](https://img.shields.io/pypi/v/feijoa?style=for-the-badge) ![Codecov](https://img.shields.io/codecov/c/github/qnbhd/feijoa?style=for-the-badge)

Feijoa is a Python framework for hyperparameter's optimization.

The Feijoa API is very easy to use, effective for optimizing machine learning algorithms and various software. Feijoa contains many different use cases.

## Compatibility

Feijoa works with Linux and OS X. Requires Python 3.8 or later.

Feijoa works with [Jupyter notebooks](https://jupyter.org/) with no additional configuration required.

# Installing

Install with `pip` or your favourite PyPI package manager.

`python -m pip install feijoa`

## Code example:

```python
from feijoa import create_job, Experiment, SearchSpace, Real
from math import sin


def objective(experiment: Experiment):
    x = experiment.params.get('x')
    y = experiment.params.get('y')

    return sin(x * y)
    
space = SearchSpace()
space.insert(Real('x', low=0.0, high=2.0))
space.insert(Real('y', low=0.0, high=2.0))

job = create_job(search_space=space)
job.do(objective)
```


