Skip to content

Commit c337582

Browse files
committed
Updated docs
1 parent 434f06e commit c337582

29 files changed

+88
-56
lines changed
1.2 KB
Binary file not shown.
397 Bytes
Binary file not shown.
1.97 KB
Binary file not shown.

docs/build/doctrees/index.doctree

0 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 records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 68998865de82696a435b809a6c2218cf
3+
config: dc3d67d80215e417d5666736e6b32a34
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/.buildinfo.bak

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 records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 8f661d36a6be2d7a955cb70d94b0aec4
3+
config: 68998865de82696a435b809a6c2218cf
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ Regression Model Management
6767

6868
Multiple Restarts
6969
-----------------
70-
* :code:`restarts.use_restarts` - Whether to do restarts when :math:`\rho_k` reaches :math:`\rho_{end}`, or (optionally) when all points are within noise level of :math:`f(x_k)`. Default is :code:`False` for smooth problems or :code:`True` for noisy problems.
70+
* :code:`restarts.use_restarts` - Whether to do restarts when :math:`\rho_k` reaches :math:`\rho_{end}`, or (optionally) when all points are within noise level of :math:`f(x_k)`. Default is :code:`False` for smooth problems or :code:`True` for noisy problems.
71+
* :code:`restarts.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`.
7172
* :code:`restarts.max_unsuccessful_restarts` - Maximum number of consecutive unsuccessful restarts allowed (i.e.~restarts which did not reduce the objective further). Default is 10.
7273
* :code:`restarts.rhoend_scale` - Factor to reduce :math:`\rho_{end}` by with each restart. Default is 1.
7374
* :code:`restarts.use_soft_restarts` - Whether to use soft or hard restarts. Default is :code:`True`.

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,8 @@ Version 1.6.2 (21 Jan 2026)
102102
Version 1.6.3 (16 Mar 2026)
103103
-------------------------
104104
* Allow parameter :code:`init.run_in_parallel=True` when :code:`init.random_initial_directions=False`
105+
106+
Version 1.6.4 (23 Mar 2026)
107+
-------------------------
108+
* Add new parameter :code:`restarts.throw_error_on_nans` to customize handling of NaN objective values during restarts
109+

docs/build/html/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '1.6.3',
2+
VERSION: '1.6.4',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

docs/build/html/advanced.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Advanced Usage &mdash; DFO-LS v1.6.3 documentation</title>
9+
<title>Advanced Usage &mdash; DFO-LS v1.6.4 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=452006c5"></script>
16+
<script src="_static/documentation_options.js?v=8ea99608"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
@@ -181,6 +181,7 @@ <h2>Regression Model Management<a class="headerlink" href="#regression-model-man
181181
<h2>Multiple Restarts<a class="headerlink" href="#multiple-restarts" title="Link to this heading"></a></h2>
182182
<ul class="simple">
183183
<li><p><code class="code docutils literal notranslate"><span class="pre">restarts.use_restarts</span></code> - Whether to do restarts when <span class="math notranslate nohighlight">\(\rho_k\)</span> reaches <span class="math notranslate nohighlight">\(\rho_{end}\)</span>, or (optionally) when all points are within noise level of <span class="math notranslate nohighlight">\(f(x_k)\)</span>. Default is <code class="code docutils literal notranslate"><span class="pre">False</span></code> for smooth problems or <code class="code docutils literal notranslate"><span class="pre">True</span></code> for noisy problems.</p></li>
184+
<li><p><code class="code docutils literal notranslate"><span class="pre">restarts.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>
184185
<li><p><code class="code docutils literal notranslate"><span class="pre">restarts.max_unsuccessful_restarts</span></code> - Maximum number of consecutive unsuccessful restarts allowed (i.e.~restarts which did not reduce the objective further). Default is 10.</p></li>
185186
<li><p><code class="code docutils literal notranslate"><span class="pre">restarts.rhoend_scale</span></code> - Factor to reduce <span class="math notranslate nohighlight">\(\rho_{end}\)</span> by with each restart. Default is 1.</p></li>
186187
<li><p><code class="code docutils literal notranslate"><span class="pre">restarts.use_soft_restarts</span></code> - Whether to use soft or hard restarts. Default is <code class="code docutils literal notranslate"><span class="pre">True</span></code>.</p></li>

0 commit comments

Comments
 (0)