Skip to content

Commit 61b9cd8

Browse files
committed
Updated documentation for v1.4 release
1 parent 7a3e1d4 commit 61b9cd8

34 files changed

+115
-69
lines changed
420 Bytes
Binary file not shown.
424 Bytes
Binary file not shown.

docs/build/doctrees/history.doctree

1.81 KB
Binary file not shown.

docs/build/doctrees/index.doctree

-8 Bytes
Binary file not shown.

docs/build/doctrees/install.doctree

363 Bytes
Binary file not shown.

docs/build/html/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: cec3c360cac1770071ca221721114dde
3+
config: 6a2288786364dcb1761dcd61fd935f30
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/diagnostic.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Diagnostic Information
22
======================
3-
In :doc:`userguide`, we saw that the output of Py-BOBYQA returns a container which includes diagnostic information about the progress of the algorithm (:code:`soln.diagnostic_info`). This object is a `Pandas <http://pandas.pydata.org/>`_ DataFrame, with one row per iteration of the algorithm. In this section, we explain the meaning of each type of output (the columns of the DataFrame).
3+
In :doc:`userguide`, we saw that the output of Py-BOBYQA returns a container which includes diagnostic information about the progress of the algorithm (:code:`soln.diagnostic_info`). This object is a `Pandas <http://pandas.pydata.org/>`_ DataFrame, with one row per iteration of the algorithm. If Pandas is not available, it returns a dictionary where each key listed below has a list of values, one per iteration of the algorithm. In this section, we explain the meaning of each type of output (the columns of the DataFrame).
44

55
To save this information to a CSV file, use:
66

docs/build/html/_sources/history.rst.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,10 @@ Version 1.2 (25 Feb 2020)
3939
Version 1.3 (14 Apr 2021)
4040
-------------------------
4141
* Remove NumPy deprecation warnings from use of np.int and np.float
42+
43+
Version 1.4 (16 May 2023)
44+
-------------------------
45+
* Return diagnostic information as dictionary if Pandas not available (removes Pandas dependency)
46+
* Handle Nan/Inf values in model gradient and Hessian by gracefully exiting trust-region subproblem
47+
* Bugfix: automatically make model Hessian symmetric before trust-region subproblem with warning, instead of returning an error
48+
* Bugfix: reset slow iteration counter when doing soft restarts

docs/build/html/_sources/index.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Py-BOBYQA: Derivative-Free Optimizer for Bound-Constrained Minimization
1010

1111
**Date:** |today|
1212

13-
**Author:** `Lindon Roberts <lindon.roberts@maths.ox.ac.uk>`_
13+
**Author:** `Lindon Roberts <lindon.roberts@sydney.edu.au>`_
1414

1515
Py-BOBYQA is a flexible package for finding local solutions to nonlinear, nonconvex minimization problems (with optional bound constraints), without requiring any derivatives of the objective. Py-BOBYQA is a Python implementation of the `BOBYQA <http://mat.uc.pt/~zhang/software.html#powell_software>`_ solver by Powell (documentation `here <http://www.damtp.cam.ac.uk/user/na/NA_papers/NA2009_06.pdf>`_). It is particularly useful when evaluations of the objective function are expensive and/or noisy.
1616

docs/build/html/_sources/install.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Additionally, the following python packages should be installed (these will be i
1111

1212
* `NumPy 1.11 or higher <http://www.numpy.org/>`_
1313
* `SciPy 0.18 or higher <http://www.scipy.org/>`_
14-
* `Pandas 0.17 or higher <https://pandas.pydata.org/>`_
14+
* Optionally, `Pandas 0.17 or higher <https://pandas.pydata.org/>`_, to return the diagnostic information as a DataFrame
1515

1616
**Optional package:** Py-BOBYQA versions 1.2 and higher also support the `trustregion <https://github.com/lindonroberts/trust-region>`_ package for fast trust-region subproblem solutions. To install this, make sure you have a Fortran compiler (e.g. `gfortran <https://gcc.gnu.org/wiki/GFortran>`_) and NumPy installed, then run :code:`pip install trustregion`. You do not have to have trustregion installed for Py-BOBYQA to work, and it is not installed by default.
1717

0 commit comments

Comments
 (0)