Skip to main content

Sequential model-based optimization toolbox.

Project description

Travis Status CircleCI Status

Scikit-Optimize

Scikit-Optimize, or skopt, is a simple and efficient library to minimize (very) expensive and noisy black-box functions. It implements several methods for sequential model-based optimization. skopt aims to be accessible and easy to use in many contexts.

The library is built on top of NumPy, SciPy and Scikit-Learn.

We do not perform gradient-based optimization. For gradient-based optimization algorithms look at scipy.optimize here.

Approximated objective

Approximated objective function after 50 iterations of gp_minimize. Plot made using skopt.plots.plot_objective.

Install

The latest released version of scikit-optimize is v0.4, which you can install with:

pip install numpy # install numpy explicitly first
pip install scikit-optimize

Getting started

Find the minimum of the noisy function f(x) over the range -2 < x < 2 with skopt:

import numpy as np
from skopt import gp_minimize

def f(x):
    return (np.sin(5 * x[0]) * (1 - np.tanh(x[0] ** 2)) *
            np.random.randn() * 0.1)

res = gp_minimize(f, [(-2.0, 2.0)])

For more control over the optimization loop you can use the skopt.Optimizer class:

from skopt import Optimizer

opt = Optimizer([(-2.0, 2.0)])

for i in range(20):
    suggested = opt.ask()
    y = f(suggested)
    opt.tell(suggested, y)
    print('iteration:', i, suggested, y)

Read our introduction to bayesian optimization and the other examples.

Development

The library is still experimental and under heavy development. Checkout the next milestone for the plans for the next release or look at some easy issues to get started contributing.

The development version can be installed through:

git clone https://github.com/scikit-optimize/scikit-optimize.git
cd scikit-optimize
pip install -e.

Run all tests by executing pytest in the top level directory.

To only run the subset of tests with low run time, you can use pytest -m 'fast_test'. On the other hand pytest -m 'slow_test' is also possible. To exclude all slow running tests try pytest -m 'not slow_test'.

This is implemented using pytest attributes. If a tests runs longer than 1 second, it is marked as slow, else as fast.

All contributors are welcome!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scikit-optimize-0.4.tar.gz (52.8 kB view details)

Uploaded Source

Built Distribution

scikit_optimize-0.4-py2.py3-none-any.whl (65.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file scikit-optimize-0.4.tar.gz.

File metadata

File hashes

Hashes for scikit-optimize-0.4.tar.gz
Algorithm Hash digest
SHA256 c01d5b9f31105172067b1df18d15c277a15c81580317c2b002d8e63df6216156
MD5 6fed06530ca6888e7e2b315f0091ead5
BLAKE2b-256 3266361bb509e9e2bc69186c599922dbb1fe16e229afb4140ec7e8040b80f0c9

See more details on using hashes here.

File details

Details for the file scikit_optimize-0.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for scikit_optimize-0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 013c8e6091fff43454b90c9dc91feca5324c985293e877c3bccbaa0940ed3785
MD5 dc6225b727f77a088cb35a9c760cff71
BLAKE2b-256 a4c831c22ad46dd24aa07a3c079d3501462326e8caff61d976d22335265e2a3e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page