Skip to content

Commit

Permalink
Updated documentation and version number to 1.2.3
Browse files Browse the repository at this point in the history
  • Loading branch information
lindonroberts committed Jun 1, 2021
1 parent a2a5e22 commit ff249b3
Show file tree
Hide file tree
Showing 31 changed files with 96 additions and 62 deletions.
2 changes: 1 addition & 1 deletion dfols/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@
"""

__version__ = '1.2.2'
__version__ = '1.2.3'
1 change: 1 addition & 0 deletions docs/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Stochastic Noise Information
Interpolation Management
--------------------------------
* :code:`interpolation.precondition` - whether or not to scale the interpolation linear system to improve conditioning. Default is :code:`True`.
* :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`.

Regression Model Management
---------------------------
Expand Down
Binary file modified docs/build/doctrees/advanced.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/history.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: b3ad0b00e790bb6579f3b5d48d034bbf
config: 7851303ebe6ed71f013a86e86fbeadbc
tags: 645f666f9bcd5a90fca523b33c5a78b7
1 change: 1 addition & 0 deletions docs/build/html/_sources/advanced.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Stochastic Noise Information
Interpolation Management
--------------------------------
* :code:`interpolation.precondition` - whether or not to scale the interpolation linear system to improve conditioning. Default is :code:`True`.
* :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`.

Regression Model Management
---------------------------
Expand Down
4 changes: 4 additions & 0 deletions docs/build/html/_sources/history.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,7 @@ Version 1.2.1 (13 Feb 2020)
Version 1.2.2 (26 Feb 2021)
---------------------------
* Minor update to remove NumPy deprecation warnings - no changes to the DFO-LS algorithm.

Version 1.2.3 (1 Jun 2021)
---------------------------
* Minor update to customise handling of NaNs in objective evaluations - no changes to the DFO-LS algorithm.
2 changes: 1 addition & 1 deletion docs/build/html/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.2.2',
VERSION: '1.2.3',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
5 changes: 3 additions & 2 deletions docs/build/html/advanced.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

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



Expand Down Expand Up @@ -61,7 +61,7 @@


<div class="version">
1.2.2
1.2.3
</div>


Expand Down Expand Up @@ -242,6 +242,7 @@ <h2>Stochastic Noise Information<a class="headerlink" href="#stochastic-noise-in
<h2>Interpolation Management<a class="headerlink" href="#interpolation-management" title="Permalink to this headline"></a></h2>
<ul class="simple">
<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>
<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>
</ul>
</div>
<div class="section" id="regression-model-management">
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/diagnostic.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

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



Expand Down Expand Up @@ -61,7 +61,7 @@


<div class="version">
1.2.2
1.2.3
</div>


Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

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

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



Expand Down Expand Up @@ -60,7 +60,7 @@


<div class="version">
1.2.2
1.2.3
</div>


Expand Down
11 changes: 9 additions & 2 deletions docs/build/html/history.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

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



Expand Down Expand Up @@ -60,7 +60,7 @@


<div class="version">
1.2.2
1.2.3
</div>


Expand Down Expand Up @@ -100,6 +100,7 @@
<li class="toctree-l2"><a class="reference internal" href="#version-1-2-12-feb-2020">Version 1.2 (12 Feb 2020)</a></li>
<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>
<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>
<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>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -225,6 +226,12 @@ <h2>Version 1.2.2 (26 Feb 2021)<a class="headerlink" href="#version-1-2-2-26-feb
<li><p>Minor update to remove NumPy deprecation warnings - no changes to the DFO-LS algorithm.</p></li>
</ul>
</div>
<div class="section" id="version-1-2-3-1-jun-2021">
<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>
<ul class="simple">
<li><p>Minor update to customise handling of NaNs in objective evaluations - no changes to the DFO-LS algorithm.</p></li>
</ul>
</div>
</div>


Expand Down
9 changes: 5 additions & 4 deletions docs/build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

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



Expand Down Expand Up @@ -60,7 +60,7 @@


<div class="version">
1.2.2
1.2.3
</div>


Expand Down Expand Up @@ -158,8 +158,8 @@

<div class="section" id="dfo-ls-derivative-free-optimizer-for-least-squares-minimization">
<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>
<p><strong>Release:</strong> 1.2.2</p>
<p><strong>Date:</strong> 26 February 2021</p>
<p><strong>Release:</strong> 1.2.3</p>
<p><strong>Date:</strong> 01 June 2021</p>
<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>
<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>
<p>That is, DFO-LS solves</p>
Expand Down Expand Up @@ -233,6 +233,7 @@ <h1>DFO-LS: Derivative-Free Optimizer for Least-Squares Minimization<a class="he
<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>
<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>
<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>
<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>
</ul>
</li>
</ul>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/info.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

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



Expand Down Expand Up @@ -61,7 +61,7 @@


<div class="version">
1.2.2
1.2.3
</div>


Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/install.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

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



Expand Down Expand Up @@ -61,7 +61,7 @@


<div class="version">
1.2.2
1.2.3
</div>


Expand Down
Binary file modified docs/build/html/objects.inv
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/build/html/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

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



Expand Down Expand Up @@ -60,7 +60,7 @@


<div class="version">
1.2.2
1.2.3
</div>


Expand Down
Loading

0 comments on commit ff249b3

Please sign in to comment.