Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

I1083 l bfgs optimiser #1149

Draft
wants to merge 17 commits into
base: main
Choose a base branch
from
1 change: 1 addition & 0 deletions docs/source/optimisers/base_classes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ Optimiser base classes

.. autoclass:: PopulationBasedOptimiser

.. autoclass:: LineSearchBasedOptimiser
1 change: 1 addition & 0 deletions docs/source/optimisers/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ or the :class:`OptimisationController` class.
cmaes_bare
cmaes
gradient_descent
lbfgs
nelder_mead
pso
snes
Expand Down
7 changes: 7 additions & 0 deletions docs/source/optimisers/lbfgs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
******
L-BFGS
******

.. currentmodule:: pints

.. autoclass:: LBFGS
3 changes: 3 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ relevant code.
### Local optimisers
- [Nelder-Mead](./optimisation/nelder-mead.ipynb)

### Quasi-Newton optimisers
- [L-BFGS](./optimisation/lbfgs.ipynb)

### Further optimisation
- [Convenience methods fmin() and curve\_fit()](./optimisation/convenience.ipynb)
- [Maximum loglikelihood](./optimisation/maximum-likelihood.ipynb)
Expand Down
434 changes: 434 additions & 0 deletions examples/optimisation/lbfgs.ipynb

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion pints/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,8 @@ def version(formatted=False):
optimise,
Optimiser,
PopulationBasedOptimiser,
TriangleWaveTransform,
LineSearchBasedOptimiser,
TriangleWaveTransform
)
from ._optimisers._cmaes import CMAES
from ._optimisers._cmaes_bare import BareCMAES
Expand All @@ -175,6 +176,7 @@ def version(formatted=False):
from ._optimisers._pso import PSO
from ._optimisers._snes import SNES
from ._optimisers._xnes import XNES
from ._optimisers._lbfgs import LBFGS


#
Expand Down
Loading