A Python toolbox for performing gradient-free optimization
Project description
Nevergrad - A gradient-free optimization platform
nevergrad is a Python 3.6+ library. It can be installed with:
pip install nevergrad
You can also install the master branch instead of the latest release with:
pip install git+https://github.com/facebookresearch/nevergrad@master#egg=nevergrad
Alternatively, you can clone the repository and run pip install -e . from inside the repository folder.
By default, this only installs requirements for the optimization and instrumentation subpackages. If you are also interested in the benchmarking part,
you should install with the [benchmark] flag (example: pip install 'nevergrad[benchmark]'), and if you also want the test tools, use
the [all] flag (example: pip install -e '.[all]')
You can join Nevergrad users Facebook group here
Goals and structure
The goals of this package are to provide:
- gradient/derivative-free optimization algorithms, including algorithms able to handle noise.
- tools to instrument any code, making it painless to optimize your parameters/hyperparameters, whether they are continuous, discrete or a mixture of continuous and discrete variables.
- functions on which to test the optimization algorithms.
- benchmark routines in order to compare algorithms easily.
The structure of the package follows its goal, you will therefore find subpackages:
optimization: implementing optimization algorithmsinstrumentation: tooling to convert code into a well-defined function to optimize.functions: implementing both simple and complex benchmark functionsbenchmark: for running experiments comparing the algorithms on benchmark functionscommon: a set of tools used throughout the package
Convergence of a population of points to the minima with two-points DE.
Documentation
The following README is very general, here are links to find more details on:
- how to perform optimization using
nevergrad, including using parallelization and a few recommendation on which algorithm should be used depending on the settings - how to instrument functions with any kind of parameters in order to convert them into a function defined on a continuous vectorial space where optimization can be performed. It also provides a tool to instantiate a script or non-python code in order into a Python function and be able to tune some of its parameters.
- how to benchmark all optimizers on various test functions.
- benchmark results of some standard optimizers an simple test cases.
- examples of optimization for machine learning.
- how to contribute through issues and pull requests and how to setup your dev environment.
- guidelines of how to contribute by adding a new algorithm.
Basic optimization example
All optimizers assume a centered and reduced prior at the beginning of the optimization (i.e. 0 mean and unitary standard deviation). They are however able to find solutions far from this initial prior.
Optimizing (minimizing!) a function using an optimizer (here OnePlusOne) can be easily run with:
import nevergrad as ng
def square(x):
return sum((x - .5)**2)
optimizer = ng.optimizers.OnePlusOne(instrumentation=2, budget=100)
recommendation = optimizer.minimize(square)
print(recommendation) # optimal args and kwargs
>>> Candidate(args=(array([0.500, 0.499]),), kwargs={})
recommendation holds the optimal attributes args and kwargs found by the optimizer for the provided function.
In this example, the optimal value will be found in recommendation.args[0] and will be a np.ndarray of size 2.
instrumentation=n is a shortcut to state that the function has only one variable, of dimension n,
See the instrumentation tutorial for more complex instrumentations.
You can print the full list of optimizers with:
import nevergrad as ng
print(list(sorted(ng.optimizers.registry.keys())))
The optimization documentation contains more information on how to use several workers,
take full control of the optimization through the ask and tell interface, perform multiobjective optimization,
as well as pieces of advice on how to choose the proper optimizer for your problem.
Citing
@misc{nevergrad,
author = {J. Rapin and O. Teytaud},
title = {{Nevergrad - A gradient-free optimization platform}},
year = {2018},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://GitHub.com/FacebookResearch/Nevergrad}},
}
License
nevergrad is released under the MIT license. See LICENSE for additional details about it.
LGPL code is however also included in the multiobjective subpackage.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file nevergrad-0.3.0.tar.gz.
File metadata
- Download URL: nevergrad-0.3.0.tar.gz
- Upload date:
- Size: 173.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e0c36dcca59fddf52b8280f10217700de43aa02b84a331baa8d20e40ec8189ef |
|
| MD5 | 4827d2a34494eb4594c32adc3beb56df |
|
| BLAKE2b-256 | f1a449b6ea616b5d3b4933039d444e8dc82e280f1ad72a40a7d85fa53bec322d |
Provenance
File details
Details for the file nevergrad-0.3.0-py3-none-any.whl.
File metadata
- Download URL: nevergrad-0.3.0-py3-none-any.whl
- Upload date:
- Size: 233.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 803424d5bbc2e25b7615500c92948107ce89f42796830d4a5955a8b32ecc7d24 |
|
| MD5 | b5d8491fbfbca6febe2efd145263a608 |
|
| BLAKE2b-256 | a14bdf3878dcd3bdc9cd9e9dfa27deea963e3c7f995cc28224f1b4d2b98e0a0a |
