Skip to main content

Logo

pypi conda binder gitter Zenodo DOI

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

scikit-optimize requires

  • Python >= 3.6

  • NumPy (>= 1.13.3)

  • SciPy (>= 0.19.1)

  • joblib (>= 0.11)

  • scikit-learn >= 0.20

  • matplotlib >= 2.0.0

You can install the latest release with:

pip install ts-scikit-optimize

This installs an essential version of scikit-optimize. To install scikit-optimize with plotting functionality, you can instead do:

pip install 'ts-scikit-optimize[plots]'

This will install matplotlib along with scikit-optimize.

In addition there is a conda-forge package of scikit-optimize:

conda install -c conda-forge scikit-optimize

Using conda-forge is probably the easiest way to install scikit-optimize on Windows.

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/khulnasoft-lab/ts-scikit-optimize.git
cd ts-scikit-optimize
pip install -e.

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

To only run the subset of tests with short run time, you can use pytest -m 'fast_test' (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!

Making a Release

The release procedure is almost completely automated. By tagging a new release travis will build all required packages and push them to PyPI. To make a release create a new issue and work through the following checklist:

  • update the version tag in __init__.py

  • update the version tag mentioned in the README

  • check if the dependencies in setup.py are valid or need unpinning

  • check that the doc/whats_new/v0.X.rst is up to date

  • did the last build of master succeed?

  • create a new release

  • ping conda-forge

Before making a release we usually create a release candidate. If the next release is v0.X then the release candidate should be tagged v0.Xrc1 in __init__.py. Mark a release candidate as a “pre-release” on GitHub when you tag it.

Commercial support

Feel free to get in touch if you need commercial support or would like to sponsor development. Resources go towards paying for additional work by seasoned engineers and researchers.

Made possible by

The scikit-optimize project was made possible with the support of

Wild Tree Tech NYU Center for Data Science NSF Northrop Grumman

If your employer allows you to work on scikit-optimize during the day and would like recognition, feel free to add them to the “Made possible by” list.

Metadata

Release files for ts-scikit-optimize 0.9.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ts-scikit-optimize 0.9.2
File Size Uploaded
ts-scikit-optimize-0.9.2.tar.gz 385.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ts-scikit-optimize 0.9.2
File Interpreter ABI Platform
ts_scikit_optimize-0.9.2-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 485.9 kB

Release files / ts-scikit-optimize-0.9.2.tar.gz

Download URL ts-scikit-optimize-0.9.2.tar.gz
Size 385.5 kB
Tags Source
SHA-256 checksum
How to use checksums
db6d7a487445229e8c2993ef66e3fe6578fe63eab05e7acbae026116c5c3c71c
BLAKE2b-256 checksum
How to use checksums
0cd72b3d42ff29e28c54e6ede5fed365007da7fe532fc84520ad4fce92fa2d32
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.13

Release files / ts_scikit_optimize-0.9.2-py2.py3-none-any.whl

Download URL ts_scikit_optimize-0.9.2-py2.py3-none-any.whl
Size 100.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
3b6fb7cc0d3915f8f8522186d71c6ebcc877b3abe31c9513402f115e1cd36ee4
BLAKE2b-256 checksum
How to use checksums
32a172dfbe045cca59bf6fb349848819d1aafc93f7b07d81a3da7af4446b1ffe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.13

Release history Release notifications | RSS feed

This release

0.9.2 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page