Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pdfo/pdfo
Powell's Derivative-Free Optimization solvers.
https://github.com/pdfo/pdfo
blackbox-optimization bobyqa cobyla constrained-optimization derivative-free-optimization fortran lincoa matlab newuoa nonlinear-optimization numerical-optimization optimization optimization-algorithms powell python simulation simulation-based-optimization unconstrained-optimization uobyqa zeroth-order-optimization
Last synced: 2 days ago
JSON representation
Powell's Derivative-Free Optimization solvers.
- Host: GitHub
- URL: https://github.com/pdfo/pdfo
- Owner: pdfo
- License: bsd-3-clause
- Created: 2020-04-19T08:51:55.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T08:01:00.000Z (3 months ago)
- Last Synced: 2025-01-19T08:51:44.357Z (3 days ago)
- Topics: blackbox-optimization, bobyqa, cobyla, constrained-optimization, derivative-free-optimization, fortran, lincoa, matlab, newuoa, nonlinear-optimization, numerical-optimization, optimization, optimization-algorithms, powell, python, simulation, simulation-based-optimization, unconstrained-optimization, uobyqa, zeroth-order-optimization
- Language: Fortran
- Homepage: https://www.pdfo.net
- Size: 4.05 MB
- Stars: 100
- Watchers: 7
- Forks: 26
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
PDFO: Powell's Derivative-Free Optimization solvers
Introduction | Python | MATLAB | Citing PDFO | Acknowledgments
Dedicated to the late Professor [M. J. D. Powell](https://www.zhangzk.net/powell.html) FRS (1936–2015).
[](https://github.com/pdfo/pdfo/actions/workflows/build.yml)
[](https://opensource.org/licenses/BSD-3-Clause/)
[](https://github.com/pdfo/pdfo/releases/)
[](https://pypi.org/project/pdfo/)
[](https://www.mathworks.com/matlabcentral/fileexchange/75195-pdfo-powell-s-derivative-free-optimization-solvers/)
[](https://doi.org/10.5281/zenodo.3887568)
## Introduction
PDFO (Powell's Derivative-Free Optimization solvers) is a cross-platform package
providing interfaces for using the late Professor [M. J. D. Powell's](https://www.zhangzk.net/powell.html)
derivative-free optimization solvers, including UOBYQA, NEWUOA, BOBYQA, LINCOA,
and COBYLA. See the [PDFO homepage](https://www.pdfo.net) and the [PDFO paper](https://arxiv.org/pdf/2302.13246.pdf) for more information.
This package makes use of a modified version of [Powell's](https://www.zhangzk.net/powell.html)
Fortran code. See the folder [`original`](https://github.com/pdfo/pdfo/tree/main/fsrc/original)
under `fsrc` for [Powell's](https://www.zhangzk.net/powell.html) original code.
## Python version of PDFO
### Installation
#### Recommended installation
To use the Python version of PDFO on Linux, Mac, or Windows, you need
[Python](https://www.python.org/) (version 3.8 or above).
It is highly recommended to install PDFO via [PyPI](https://pypi.org).
Install [pip](https://pip.pypa.io/en/stable/installing/) in your system if
you Python version does not include it. Then execute
```bash
pip install pdfo
```
in a command shell (e.g., the terminal for Linux and macOS, or the Command
Shell for Windows). If your pip launcher is not `pip`, adapt the
command accordingly (it may be `pip3` for example). If this
command runs successfully, PDFO is installed. You may verify the
installation by
```bash
python -m unittest pdfo.testpdfo
```
Once again, if your Python launcher is not `python`, adapt the command accordingly (it may be `python3` for example).
If you are an Anaconda user, PDFO is also available through the conda installer
( https://anaconda.org/conda-forge/pdfo ). However, it is not managed by us.
#### Alternative installation (using source distribution)
Alternatively, although deeply discouraged, PDFO can be installed from the
source code. It requires you to install additional Python headers, a Fortran
compiler (e.g., [gfortran](https://gcc.gnu.org/fortran/)), and
[F2PY](https://numpy.org/doc/stable/f2py/) (provided by
[NumPy](https://numpy.org/)).
Download and decompress the [source code package](https://www.pdfo.net/docs.html#download),
or clone it from [GitHub](https://github.com/pdfo/pdfo) or [Gitee](https://gitee.com/pdfo/pdfo).
You will obtain a folder containing `pyproject.toml`; in a command shell,
change your directory to this folder; then install PDFO by executing
```bash
pip install .
```
### Usage
PDFO provides a Python function `pdfo`, which can solve general constrained or unconstrained optimization problems without using derivatives.
The `pdfo` function can automatically identify the type of your problem and then call one of Powell’s solvers, namely COBYLA, UOBYQA, NEWUOA, BOBYQA, and LINCOA.
The user can also specify the solver by setting the `method` field of the options passed to `pdfo`.
The `pdfo` function is designed to be compatible with the [scipy.optimize.minimize](https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html#scipy.optimize.minimize) function of [SciPy](https://scipy.org/). You can call pdfo in exactly the same way as calling [scipy.optimize.minimize](https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html#scipy.optimize.minimize) except that `pdfo` does not accept derivative arguments.
For the detailed syntax of `pdfo`, use the standard `help` command
of Python:
```python
from pdfo import pdfo
help(pdfo)
```
### Uninstall
PDFO can be uninstalled by executing the following command in a command shell:
```bash
python3 -m pip uninstall pdfo
```
## MATLAB version of PDFO
### Prerequisites
PDFO supports MATLAB R2014a and later releases. To use PDFO, you need first
set up the [MEX](https://www.mathworks.com/help/matlab/ref/mex.html) of your
MATLAB so that it can compile Fortran.
**The setup of MEX is a pure MATLAB usage problem and it has nothing to do with PDFO.**
To see whether your MEX is ready, run the following code in MATLAB:
```matlab
mex('-setup', '-v', 'fortran'); mex('-v', fullfile(matlabroot, 'extern', 'examples', 'refbook', 'timestwo.F'));
```
If this completes successfully, then your MEX is ready. Otherwise, it is not, and
you may try the [`setup_mex` package](https://github.com/equipez/setup_mex) at
```
https://github.com/equipez/setup_mex
```
It will help you to set MEX up on Windows or macOS (the setup of MEX is trivial on Linux).
In case `setup_mex` does not work, you need to consult a local MATLAB expert or the technical support of
MathWorks about "[how to set up MEX](https://www.mathworks.com/help/matlab/ref/mex.html)", which is
**not** part of PDFO.
### Installation
Download and decompress the [source code package](https://www.pdfo.net/docs.html#download),
or clone it from [GitHub](https://github.com/pdfo/pdfo) or [Gitee](https://gitee.com/pdfo/pdfo).
You will obtain a folder containing `setup.m`. Place this folder at the location
where you want PDFO to be installed. In MATLAB, change the directory to this
folder, and execute the following command:
```matlab
setup
```
If this command runs successfully, PDFO is installed. You may execute the
following command in MATLAB to verify the installation:
```matlab
testpdfo
```
### Usage
PDFO provides a MATLAB function `pdfo`, which can solve general constrained or unconstrained optimization problems without using derivatives.
The `pdfo` function can automatically identify the type of your problem and then call one of Powell’s solvers, namely COBYLA, UOBYQA, NEWUOA, BOBYQA, and LINCOA.
The user can also specify the solver by setting the `solver` field of the options passed to `pdfo`.
The `pdfo` function is designed to be compatible with the `fmincon` function available in the [Optimization Toolbox](https://www.mathworks.com/products/optimization.html) of MATLAB.
You can call `pdfo` in the same way as calling `fmincon`. In addition, `pdfo` can be called in some flexible ways that are not supported by `fmincon`.
For detailed syntax of `pdfo`, use the standard `help` command
of MATLAB:
```matlab
help pdfo
```
### Uninstall
PDFO can be uninstalled using the setup.m script by executing the following
command in MATLAB:
```matlab
setup uninstall
```
## Citing PDFO
If you use PDFO, please cite the following paper. Note that PDFO contains improvements and bug fixes that do not exist in Powell's original code. See Subsections 4.3--4.5 of the paper for details.
[1] T. M. Ragonneau and Z. Zhang, [PDFO: a cross-platform package for Powell's derivative-free optimization solvers](https://arxiv.org/pdf/2302.13246.pdf), arXiv:2302.13246, 2023.
```bibtex
@misc{Ragonneau_Zhang_2023,
title = {{PDFO}: a cross-platform package for {Powell}'s derivative-free optimization solvers},
author = {Ragonneau, T. M. and Zhang, Z.},
howpublished = {arXiv:2302.13246},
year = 2023
}
```
In addition, Powell’s methods can be cited as follows.
[2] M. J. D. Powell. A direct search optimization method that models the objective and constraint functions by linear interpolation. In S. Gomez and J. P. Hennart, editors, *Advances in Optimization and Numerical Analysis*, pages 51–67, Dordrecht, NL, 1994. Springer.
[3] M. J. D. Powell. UOBYQA: unconstrained optimization by quadratic approximation. *Math. Program.*, 92:555–582, 2002.
[4] M. J. D. Powell. The NEWUOA software for unconstrained optimization without derivatives. In G. Di Pillo and M. Roma, editors, *Large-Scale Nonlinear Optimization*, volume 83 of *Nonconvex Optimization and Its Applications*, pages 255–297, Boston, MA, USA, 2006. Springer.
[5] M. J. D. Powell. The BOBYQA algorithm for bound constrained optimization without derivatives. Technical Report DAMTP 2009/NA06, Department of Applied Mathematics and Theoretical Physics, University of Cambridge, Cambridge, UK, 2009.
**Remark:** LINCOA seeks the least value of a nonlinear function subject to
linear inequality constraints without using derivatives of the objective
function. Powell did not publish a paper to introduce the algorithm.
## Acknowledgments
PDFO is dedicated to the memory of the late Professor [Powell](https://www.zhangzk.net/powell.html)
with gratitude for his inspiration and for the treasures he left to us.
We are grateful to Professor [Ya-xiang Yuan](http://lsec.cc.ac.cn/~yyx/) for his
everlasting encouragement and support.
The development of PDFO is a long-term project, which would not be sustainable without the continued
funds from the [Hong Kong Research Grants Council](https://www.ugc.edu.hk/eng/rgc)
(ref. PolyU 253012/17P, PolyU 153054/20P, and PolyU 153066/21P),
the [Hong Kong Ph.D. Fellowship Scheme](https://cerg1.ugc.edu.hk/hkpfs) (ref. PF18-24698),
and the [Hong Kong Polytechnic University](https://www.polyu.edu.hk) (PolyU),
in particular the [Department of Applied Mathematics](https://www.polyu.edu.hk/ama) (AMA).