Skip to content

Commit ff249b3

Browse files
lindonrobertslindonroberts
committed
Updated documentation and version number to 1.2.3
1 parent a2a5e22 commit ff249b3

31 files changed

+96
-62
lines changed

‎dfols/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@
2222
2323
"""
2424

25-
__version__ = '1.2.2'
25+
__version__ = '1.2.3'

‎docs/advanced.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Stochastic Noise Information
5757
Interpolation Management
5858
--------------------------------
5959
* :code:`interpolation.precondition` - whether or not to scale the interpolation linear system to improve conditioning. Default is :code:`True`.
60+
* :code:`interpolation.throw_error_on_nans` - whether or not to throw :code:`numpy.linalg.LinAlgError` if trying to interpolate to NaN objective values. If :code:`False`, DFO-LS should terminate gracefully with an error flag. Default is :code:`False`.
6061

6162
Regression Model Management
6263
---------------------------

‎docs/build/doctrees/advanced.doctree

1.44 KB
Binary file not shown.

‎docs/build/doctrees/environment.pickle

430 Bytes
Binary file not shown.

‎docs/build/doctrees/history.doctree

840 Bytes
Binary file not shown.

‎docs/build/doctrees/index.doctree

-8 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: b3ad0b00e790bb6579f3b5d48d034bbf
3+
config: 7851303ebe6ed71f013a86e86fbeadbc
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/build/html/_sources/advanced.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Stochastic Noise Information
5757
Interpolation Management
5858
--------------------------------
5959
* :code:`interpolation.precondition` - whether or not to scale the interpolation linear system to improve conditioning. Default is :code:`True`.
60+
* :code:`interpolation.throw_error_on_nans` - whether or not to throw :code:`numpy.linalg.LinAlgError` if trying to interpolate to NaN objective values. If :code:`False`, DFO-LS should terminate gracefully with an error flag. Default is :code:`False`.
6061

6162
Regression Model Management
6263
---------------------------

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,7 @@ Version 1.2.1 (13 Feb 2020)
4141
Version 1.2.2 (26 Feb 2021)
4242
---------------------------
4343
* Minor update to remove NumPy deprecation warnings - no changes to the DFO-LS algorithm.
44+
45+
Version 1.2.3 (1 Jun 2021)
46+
---------------------------
47+
* Minor update to customise handling of NaNs in objective evaluations - no changes to the DFO-LS algorithm.

‎docs/build/html/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '1.2.2',
3+
VERSION: '1.2.3',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

‎docs/build/html/advanced.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Advanced Usage &mdash; DFO-LS v1.2.2 documentation</title>
11+
<title>Advanced Usage &mdash; DFO-LS v1.2.3 documentation</title>
1212

1313

1414

@@ -61,7 +61,7 @@
6161

6262

6363
<div class="version">
64-
1.2.2
64+
1.2.3
6565
</div>
6666

6767

@@ -242,6 +242,7 @@ <h2>Stochastic Noise Information<a class="headerlink" href="#stochastic-noise-in
242242
<h2>Interpolation Management<a class="headerlink" href="#interpolation-management" title="Permalink to this headline"></a></h2>
243243
<ul class="simple">
244244
<li><p><code class="code docutils literal notranslate"><span class="pre">interpolation.precondition</span></code> - whether or not to scale the interpolation linear system to improve conditioning. Default is <code class="code docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
245+
<li><p><code class="code docutils literal notranslate"><span class="pre">interpolation.throw_error_on_nans</span></code> - whether or not to throw <code class="code docutils literal notranslate"><span class="pre">numpy.linalg.LinAlgError</span></code> if trying to interpolate to NaN objective values. If <code class="code docutils literal notranslate"><span class="pre">False</span></code>, DFO-LS should terminate gracefully with an error flag. Default is <code class="code docutils literal notranslate"><span class="pre">False</span></code>.</p></li>
245246
</ul>
246247
</div>
247248
<div class="section" id="regression-model-management">

‎docs/build/html/diagnostic.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Diagnostic Information &mdash; DFO-LS v1.2.2 documentation</title>
11+
<title>Diagnostic Information &mdash; DFO-LS v1.2.3 documentation</title>
1212

1313

1414

@@ -61,7 +61,7 @@
6161

6262

6363
<div class="version">
64-
1.2.2
64+
1.2.3
6565
</div>
6666

6767

‎docs/build/html/genindex.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1111

12-
<title>Index &mdash; DFO-LS v1.2.2 documentation</title>
12+
<title>Index &mdash; DFO-LS v1.2.3 documentation</title>
1313

1414

1515

@@ -60,7 +60,7 @@
6060

6161

6262
<div class="version">
63-
1.2.2
63+
1.2.3
6464
</div>
6565

6666

‎docs/build/html/history.html

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Version History &mdash; DFO-LS v1.2.2 documentation</title>
11+
<title>Version History &mdash; DFO-LS v1.2.3 documentation</title>
1212

1313

1414

@@ -60,7 +60,7 @@
6060

6161

6262
<div class="version">
63-
1.2.2
63+
1.2.3
6464
</div>
6565

6666

@@ -100,6 +100,7 @@
100100
<li class="toctree-l2"><a class="reference internal" href="#version-1-2-12-feb-2020">Version 1.2 (12 Feb 2020)</a></li>
101101
<li class="toctree-l2"><a class="reference internal" href="#version-1-2-1-13-feb-2020">Version 1.2.1 (13 Feb 2020)</a></li>
102102
<li class="toctree-l2"><a class="reference internal" href="#version-1-2-2-26-feb-2021">Version 1.2.2 (26 Feb 2021)</a></li>
103+
<li class="toctree-l2"><a class="reference internal" href="#version-1-2-3-1-jun-2021">Version 1.2.3 (1 Jun 2021)</a></li>
103104
</ul>
104105
</li>
105106
</ul>
@@ -225,6 +226,12 @@ <h2>Version 1.2.2 (26 Feb 2021)<a class="headerlink" href="#version-1-2-2-26-feb
225226
<li><p>Minor update to remove NumPy deprecation warnings - no changes to the DFO-LS algorithm.</p></li>
226227
</ul>
227228
</div>
229+
<div class="section" id="version-1-2-3-1-jun-2021">
230+
<h2>Version 1.2.3 (1 Jun 2021)<a class="headerlink" href="#version-1-2-3-1-jun-2021" title="Permalink to this headline"></a></h2>
231+
<ul class="simple">
232+
<li><p>Minor update to customise handling of NaNs in objective evaluations - no changes to the DFO-LS algorithm.</p></li>
233+
</ul>
234+
</div>
228235
</div>
229236

230237

‎docs/build/html/index.html

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>DFO-LS: Derivative-Free Optimizer for Least-Squares Minimization &mdash; DFO-LS v1.2.2 documentation</title>
11+
<title>DFO-LS: Derivative-Free Optimizer for Least-Squares Minimization &mdash; DFO-LS v1.2.3 documentation</title>
1212

1313

1414

@@ -60,7 +60,7 @@
6060

6161

6262
<div class="version">
63-
1.2.2
63+
1.2.3
6464
</div>
6565

6666

@@ -158,8 +158,8 @@
158158

159159
<div class="section" id="dfo-ls-derivative-free-optimizer-for-least-squares-minimization">
160160
<h1>DFO-LS: Derivative-Free Optimizer for Least-Squares Minimization<a class="headerlink" href="#dfo-ls-derivative-free-optimizer-for-least-squares-minimization" title="Permalink to this headline"></a></h1>
161-
<p><strong>Release:</strong> 1.2.2</p>
162-
<p><strong>Date:</strong> 26 February 2021</p>
161+
<p><strong>Release:</strong> 1.2.3</p>
162+
<p><strong>Date:</strong> 01 June 2021</p>
163163
<p><strong>Author:</strong> <a class="reference external" href="mailto:lindon&#46;roberts&#37;&#52;&#48;anu&#46;edu&#46;au">Lindon Roberts</a></p>
164164
<p>DFO-LS is a flexible package for finding local solutions to nonlinear least-squares minimization problems (with optional bound constraints), without requiring any derivatives of the objective. DFO-LS stands for Derivative-Free Optimizer for Least-Squares.</p>
165165
<p>That is, DFO-LS solves</p>
@@ -233,6 +233,7 @@ <h1>DFO-LS: Derivative-Free Optimizer for Least-Squares Minimization<a class="he
233233
<li class="toctree-l2"><a class="reference internal" href="history.html#version-1-2-12-feb-2020">Version 1.2 (12 Feb 2020)</a></li>
234234
<li class="toctree-l2"><a class="reference internal" href="history.html#version-1-2-1-13-feb-2020">Version 1.2.1 (13 Feb 2020)</a></li>
235235
<li class="toctree-l2"><a class="reference internal" href="history.html#version-1-2-2-26-feb-2021">Version 1.2.2 (26 Feb 2021)</a></li>
236+
<li class="toctree-l2"><a class="reference internal" href="history.html#version-1-2-3-1-jun-2021">Version 1.2.3 (1 Jun 2021)</a></li>
236237
</ul>
237238
</li>
238239
</ul>

‎docs/build/html/info.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Overview &mdash; DFO-LS v1.2.2 documentation</title>
11+
<title>Overview &mdash; DFO-LS v1.2.3 documentation</title>
1212

1313

1414

@@ -61,7 +61,7 @@
6161

6262

6363
<div class="version">
64-
1.2.2
64+
1.2.3
6565
</div>
6666

6767

‎docs/build/html/install.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Installing DFO-LS &mdash; DFO-LS v1.2.2 documentation</title>
11+
<title>Installing DFO-LS &mdash; DFO-LS v1.2.3 documentation</title>
1212

1313

1414

@@ -61,7 +61,7 @@
6161

6262

6363
<div class="version">
64-
1.2.2
64+
1.2.3
6565
</div>
6666

6767

‎docs/build/html/objects.inv

0 Bytes
Binary file not shown.

‎docs/build/html/search.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Search &mdash; DFO-LS v1.2.2 documentation</title>
11+
<title>Search &mdash; DFO-LS v1.2.3 documentation</title>
1212

1313

1414

@@ -60,7 +60,7 @@
6060

6161

6262
<div class="version">
63-
1.2.2
63+
1.2.3
6464
</div>
6565

6666

0 commit comments

Comments
 (0)