Skip to content

Commit

Permalink
Update docs [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions-bot committed Aug 22, 2024
1 parent 8fd31d8 commit 8912e95
Show file tree
Hide file tree
Showing 33 changed files with 166 additions and 138 deletions.
2 changes: 1 addition & 1 deletion .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: b59bad4c17570b1fcc96e4ad0dce2f5e
config: 6976d284ef5c4e73d12147cb7335eb12
tags: 645f666f9bcd5a90fca523b33c5a78b7
4 changes: 2 additions & 2 deletions coverage/badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion coverage/d_271e390af77d1723___init___py.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion coverage/d_271e390af77d1723_constants_py.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion coverage/d_271e390af77d1723_debris_fitters_py.html
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion coverage/d_271e390af77d1723_filter_py.html
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion coverage/d_271e390af77d1723_fit_py.html
Original file line number Diff line number Diff line change
Expand Up @@ -915,7 +915,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion coverage/d_271e390af77d1723_geometry_py.html
Original file line number Diff line number Diff line change
Expand Up @@ -825,7 +825,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion coverage/d_271e390af77d1723_hankel_py.html
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion coverage/d_271e390af77d1723_io_py.html
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion coverage/d_271e390af77d1723_make_figs_py.html
Original file line number Diff line number Diff line change
Expand Up @@ -1262,7 +1262,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
30 changes: 15 additions & 15 deletions coverage/d_271e390af77d1723_minimizer_py.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=emulateIE7" />
<title>Coverage for frank/minimizer.py: 84%</title>
<title>Coverage for frank/minimizer.py: 75%</title>
<link rel="icon" sizes="32x32" href="favicon_32.png">
<link rel="stylesheet" href="style.css" type="text/css">
<script type="text/javascript" src="coverage_html.js" defer></script>
Expand All @@ -13,7 +13,7 @@
<div class="content">
<h1>
<span class="text">Coverage for </span><b>frank/minimizer.py</b>:
<span class="pc_cov">84%</span>
<span class="pc_cov">75%</span>
</h1>
<div id="help_panel_wrapper">
<input id="help_panel_state" type="checkbox">
Expand Down Expand Up @@ -44,8 +44,8 @@ <h1>
</div>
<h2>
<span class="text">103 statements &nbsp;</span>
<button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">87<span class="text"> run</span></button>
<button type="button" class="mis show_mis button_toggle_mis" value="mis" data-shortcut="m" title="Toggle lines missing">16<span class="text"> missing</span></button>
<button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">77<span class="text"> run</span></button>
<button type="button" class="mis show_mis button_toggle_mis" value="mis" data-shortcut="m" title="Toggle lines missing">26<span class="text"> missing</span></button>
<button type="button" class="exc show_exc button_toggle_exc" value="exc" data-shortcut="x" title="Toggle lines excluded">0<span class="text"> excluded</span></button>
</h2>
<div style="display: none;">
Expand Down Expand Up @@ -198,7 +198,7 @@ <h2>
<p class="pln"><span class="n"><a id="t139" href="#t139">139</a></span><span class="t">&nbsp;</span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t140" href="#t140">140</a></span><span class="t"> <span class="nam">x_new</span> <span class="op">=</span> <span class="nam">x0</span> <span class="op">+</span> <span class="nam">lam</span><span class="op">*</span><span class="nam">p</span>&nbsp;</span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t141" href="#t141">141</a></span><span class="t"> <span class="key">if</span> <span class="nam">np</span><span class="op">.</span><span class="nam">all</span><span class="op">(</span><span class="nam">x_new</span> <span class="op">==</span> <span class="nam">x0</span><span class="op">)</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t142" href="#t142">142</a></span><span class="t"> <span class="key">return</span> <span class="nam">x0</span><span class="op">,</span> <span class="nam">f0</span><span class="op">,</span> <span class="nam">nfev</span><span class="op">,</span> <span class="key">True</span>&nbsp;</span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t142" href="#t142">142</a></span><span class="t"> <span class="key">return</span> <span class="nam">x0</span><span class="op">,</span> <span class="nam">f0</span><span class="op">,</span> <span class="nam">nfev</span><span class="op">,</span> <span class="key">True</span>&nbsp;</span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t143" href="#t143">143</a></span><span class="t">&nbsp;</span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t144" href="#t144">144</a></span><span class="t"> <span class="nam">f_new</span><span class="op">,</span> <span class="nam">cost_new</span> <span class="op">=</span> <span class="nam">eval</span><span class="op">(</span><span class="nam">x_new</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t145" href="#t145">145</a></span><span class="t"> <span class="nam">nfev</span> <span class="op">+=</span> <span class="num">1</span>&nbsp;</span><span class="r"></span></p>
Expand Down Expand Up @@ -314,20 +314,20 @@ <h2>
<p class="pln"><span class="n"><a id="t255" href="#t255">255</a></span><span class="t">&nbsp;</span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t256" href="#t256">256</a></span><span class="t"> <span class="com"># Try again once more with a different back tracking algorithm </span>&nbsp;</span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t257" href="#t257">257</a></span><span class="t"> <span class="key">if</span> <span class="nam">failed_descent</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t258" href="#t258">258</a></span><span class="t"> <span class="nam">dx</span> <span class="op">=</span> <span class="nam">line_search</span><span class="op">.</span><span class="nam">reduce_step</span><span class="op">(</span><span class="op">-</span><span class="nam">jx</span><span class="op">,</span> <span class="nam">x</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t259" href="#t259">259</a></span><span class="t"> <span class="nam">alpha</span> <span class="op">=</span> <span class="num">2</span><span class="op">**</span><span class="op">-</span><span class="num">4</span>&nbsp;</span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t260" href="#t260">260</a></span><span class="t"> <span class="key">for</span> <span class="nam">_</span> <span class="key">in</span> <span class="nam">range</span><span class="op">(</span><span class="num">10</span><span class="op">)</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t261" href="#t261">261</a></span><span class="t"> <span class="nam">xn</span> <span class="op">=</span> <span class="nam">x</span> <span class="op">+</span> <span class="nam">dx</span>&nbsp;</span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t262" href="#t262">262</a></span><span class="t"> <span class="nam">fn</span> <span class="op">=</span> <span class="nam">fun</span><span class="op">(</span><span class="nam">xn</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t263" href="#t263">263</a></span><span class="t"> <span class="nam">nfev</span> <span class="op">+=</span> <span class="num">1</span>&nbsp;</span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t264" href="#t264">264</a></span><span class="t"> <span class="key">if</span> <span class="nam">fn</span> <span class="op">&lt;</span> <span class="nam">fx</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t258" href="#t258">258</a></span><span class="t"> <span class="nam">dx</span> <span class="op">=</span> <span class="nam">line_search</span><span class="op">.</span><span class="nam">reduce_step</span><span class="op">(</span><span class="op">-</span><span class="nam">jx</span><span class="op">,</span> <span class="nam">x</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t259" href="#t259">259</a></span><span class="t"> <span class="nam">alpha</span> <span class="op">=</span> <span class="num">2</span><span class="op">**</span><span class="op">-</span><span class="num">4</span>&nbsp;</span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t260" href="#t260">260</a></span><span class="t"> <span class="key">for</span> <span class="nam">_</span> <span class="key">in</span> <span class="nam">range</span><span class="op">(</span><span class="num">10</span><span class="op">)</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t261" href="#t261">261</a></span><span class="t"> <span class="nam">xn</span> <span class="op">=</span> <span class="nam">x</span> <span class="op">+</span> <span class="nam">dx</span>&nbsp;</span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t262" href="#t262">262</a></span><span class="t"> <span class="nam">fn</span> <span class="op">=</span> <span class="nam">fun</span><span class="op">(</span><span class="nam">xn</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t263" href="#t263">263</a></span><span class="t"> <span class="nam">nfev</span> <span class="op">+=</span> <span class="num">1</span>&nbsp;</span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t264" href="#t264">264</a></span><span class="t"> <span class="key">if</span> <span class="nam">fn</span> <span class="op">&lt;</span> <span class="nam">fx</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t265" href="#t265">265</a></span><span class="t"> <span class="key">break</span>&nbsp;</span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t266" href="#t266">266</a></span><span class="t"> <span class="key">else</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t267" href="#t267">267</a></span><span class="t"> <span class="nam">dx</span> <span class="op">*=</span> <span class="nam">alpha</span>&nbsp;</span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t267" href="#t267">267</a></span><span class="t"> <span class="nam">dx</span> <span class="op">*=</span> <span class="nam">alpha</span>&nbsp;</span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t268" href="#t268">268</a></span><span class="t"> <span class="key">else</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t269" href="#t269">269</a></span><span class="t"> <span class="com"># Neither gradient descent nor Newton's method can improve</span>&nbsp;</span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t270" href="#t270">270</a></span><span class="t"> <span class="com"># the solution</span>&nbsp;</span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t271" href="#t271">271</a></span><span class="t"> <span class="key">return</span> <span class="nam">x</span><span class="op">,</span> <span class="op">(</span><span class="num">1</span><span class="op">,</span> <span class="nam">nstep</span><span class="op">,</span> <span class="nam">nfev</span><span class="op">,</span> <span class="nam">nhess</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t271" href="#t271">271</a></span><span class="t"> <span class="key">return</span> <span class="nam">x</span><span class="op">,</span> <span class="op">(</span><span class="num">1</span><span class="op">,</span> <span class="nam">nstep</span><span class="op">,</span> <span class="nam">nfev</span><span class="op">,</span> <span class="nam">nhess</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t272" href="#t272">272</a></span><span class="t">&nbsp;</span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t273" href="#t273">273</a></span><span class="t"> <span class="nam">fx</span> <span class="op">=</span> <span class="nam">fn</span>&nbsp;</span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t274" href="#t274">274</a></span><span class="t"> <span class="nam">x</span> <span class="op">=</span> <span class="nam">xn</span>&nbsp;</span><span class="r"></span></p>
Expand All @@ -346,7 +346,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion coverage/d_271e390af77d1723_plot_py.html
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion coverage/d_271e390af77d1723_radial_fitters_py.html
Original file line number Diff line number Diff line change
Expand Up @@ -1053,7 +1053,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion coverage/d_271e390af77d1723_statistical_models_py.html
Original file line number Diff line number Diff line change
Expand Up @@ -1337,7 +1337,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion coverage/d_271e390af77d1723_tests_py.html
Original file line number Diff line number Diff line change
Expand Up @@ -897,7 +897,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
2 changes: 1 addition & 1 deletion coverage/d_271e390af77d1723_utilities_py.html
Original file line number Diff line number Diff line change
Expand Up @@ -1181,7 +1181,7 @@ <h2>
<div class="content">
<p>
<a class="nav" href="index.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
12 changes: 6 additions & 6 deletions coverage/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<header>
<div class="content">
<h1>Coverage report:
<span class="pc_cov">86%</span>
<span class="pc_cov">85%</span>
</h1>
<div id="help_panel_wrapper">
<input id="help_panel_state" type="checkbox">
Expand Down Expand Up @@ -114,9 +114,9 @@ <h1>Coverage report:
<tr class="file">
<td class="name left"><a href="d_271e390af77d1723_minimizer_py.html">frank/minimizer.py</a></td>
<td>103</td>
<td>16</td>
<td>26</td>
<td>0</td>
<td class="right" data-ratio="87 103">84%</td>
<td class="right" data-ratio="77 103">75%</td>
</tr>
<tr class="file">
<td class="name left"><a href="d_271e390af77d1723_plot_py.html">frank/plot.py</a></td>
Expand Down Expand Up @@ -158,9 +158,9 @@ <h1>Coverage report:
<tr class="total">
<td class="name left">Total</td>
<td>2889</td>
<td>409</td>
<td>419</td>
<td>0</td>
<td class="right" data-ratio="2480 2889">86%</td>
<td class="right" data-ratio="2470 2889">85%</td>
</tr>
</tfoot>
</table>
Expand All @@ -172,7 +172,7 @@ <h1>Coverage report:
<div class="content">
<p>
<a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.2</a>,
created at 2023-11-03 12:52 +0000
created at 2024-08-22 13:30 +0000
</p>
</div>
</footer>
Expand Down
Loading

0 comments on commit 8912e95

Please sign in to comment.