Skip to content

Commit 1eeae8b

Browse files
committed
Updated documentation to include paper URL and reference to DFO-LS
1 parent db8f62b commit 1eeae8b

File tree

4 files changed

+7
-3
lines changed

4 files changed

+7
-3
lines changed

README.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ DFO-GN: Derivative-Free Nonlinear Least-Squares Solver |PyPI Version|
44
DFO-GN is a package for solving nonlinear least-squares minimisation, without requiring derivatives of the objective.
55

66
This is an implementation of the algorithm from our paper:
7-
A Derivative-Free Gauss-Newton Method, C. Cartis and L. Roberts, submitted (2017).
7+
`A Derivative-Free Gauss-Newton Method <https://arxiv.org/abs/1710.11005>`_, C. Cartis and L. Roberts, submitted (2017).
8+
9+
Note: we have released a newer package, called DFO-LS, which is an upgrade of DFO-GN to improve its flexibility and robustness to noisy problems. See `here <https://github.com/numericalalgorithmsgroup/dfols>`_ for details.
810

911
Documentation
1012
-------------

docs/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,12 @@ Mathematically, DFO-GN solves
2727
\min_{x\in\mathbb{R}^n} &\quad f(x) := \sum_{i=1}^{m}r_{i}(x)^2 \\
2828
\text{s.t.} &\quad a \leq x \leq b
2929
30-
where the functions :math:`r_i(x)` may be nonlinear and even nonconvex. Full details of the DFO-GN algorithm are given in our paper: C. Cartis and L. Roberts, A Derivative-Free Gauss-Newton Method, *in preparation*, (2017).
30+
where the functions :math:`r_i(x)` may be nonlinear and even nonconvex. Full details of the DFO-GN algorithm are given in our paper: `A Derivative-Free Gauss-Newton Method <https://arxiv.org/abs/1710.11005>`_, C. Cartis and L. Roberts, submitted (2017).
3131

3232
DFO-GN is released under the open source GNU General Public License, a copy of which can be found in LICENSE.txt. Please `contact NAG <http://www.nag.com/content/worldwide-contact-information>`_ for alternative licensing. It is compatible with both Python 2 and Python 3.
3333

34+
Note: we have released a newer package, called DFO-LS, which is an upgrade of DFO-GN to improve its flexibility and robustness to noisy problems. See `here <https://github.com/numericalalgorithmsgroup/dfols>`_ for details.
35+
3436
If you have any questions or suggestsions about the code, or have used DFO-GN for an interesting application, we would very much like to hear from you: please contact `Lindon Roberts <[email protected]>`_ (`alternative email <[email protected]>`_).
3537

3638
.. toctree::

docs/info.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,5 +90,5 @@ References
9090
----------
9191

9292
.. [CR2017]
93-
Cartis, C. and Roberts, L., A Derivative-Free Gauss-Newton Method, *in preparation* (2017).
93+
Cartis, C. and Roberts, L., `A Derivative-Free Gauss-Newton Method <https://arxiv.org/abs/1710.11005>`_, submitted (2017).
9494

manual.pdf

269 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)