Updated docs

chasmani · Dec 14, 2023 · 8f02043 · 8f02043
1 parent fc5eb59
commit 8f02043
Show file tree

Hide file tree

Showing 11 changed files with 13 additions and 4 deletions.
diff --git a/docs/_build/doctrees/README.doctree b/docs/_build/doctrees/README.doctree
diff --git a/docs/_build/doctrees/api.doctree b/docs/_build/doctrees/api.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/html/README.html b/docs/_build/html/README.html
@@ -81,7 +81,7 @@ <h1>piecewise-regression (aka segmented regression) in python<a class="headerlin
 <dd class="field-even"><p>Charlie Pilgrim</p>
 </dd>
 <dt class="field-odd">Version<span class="colon">:</span></dt>
-<dd class="field-odd"><p>1.4.2</p>
+<dd class="field-odd"><p>1.4.3</p>
 </dd>
 <dt class="field-even">Github<span class="colon">:</span></dt>
 <dd class="field-even"><p><a class="reference external" href="https://github.com/chasmani/piecewise-regression">https://github.com/chasmani/piecewise-regression</a></p>

diff --git a/docs/_build/html/_sources/README.rst.txt b/docs/_build/html/_sources/README.rst.txt
@@ -3,7 +3,7 @@ piecewise-regression (aka segmented regression) in python
 ==========================================================
 :piecewise-regression: fitting straight line models with breakpoints
 :Author: Charlie Pilgrim
-:Version: 1.4.2
+:Version: 1.4.3
 :Github: https://github.com/chasmani/piecewise-regression
 :Documentation: https://piecewise-regression.readthedocs.io/en/master/index.html
 :Paper: https://joss.theoj.org/papers/10.21105/joss.03859

diff --git a/docs/_build/html/api.html b/docs/_build/html/api.html
@@ -50,6 +50,7 @@
 <li class="toctree-l3"><a class="reference internal" href="#piecewise_regression.main.Fit"><code class="docutils literal notranslate"><span class="pre">Fit</span></code></a><ul>
 <li class="toctree-l4"><a class="reference internal" href="#piecewise_regression.main.Fit.bootstrap_data"><code class="docutils literal notranslate"><span class="pre">Fit.bootstrap_data()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#piecewise_regression.main.Fit.bootstrap_restarting"><code class="docutils literal notranslate"><span class="pre">Fit.bootstrap_restarting()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#piecewise_regression.main.Fit.get_params"><code class="docutils literal notranslate"><span class="pre">Fit.get_params()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#piecewise_regression.main.Fit.get_results"><code class="docutils literal notranslate"><span class="pre">Fit.get_results()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#piecewise_regression.main.Fit.plot"><code class="docutils literal notranslate"><span class="pre">Fit.plot()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#piecewise_regression.main.Fit.plot_best_muggeo_breakpoint_history"><code class="docutils literal notranslate"><span class="pre">Fit.plot_best_muggeo_breakpoint_history()</span></code></a></li>
@@ -198,6 +199,12 @@ <h2>Main<a class="headerlink" href="#main" title="Link to this heading"></a><
 </ul>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="piecewise_regression.main.Fit.get_params">
+<span class="sig-name descname"><span class="pre">get_params</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#piecewise_regression.main.Fit.get_params" title="Link to this definition"></a></dt>
+<dd><p>Return a small dictionary with just the fit estimates.</p>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="piecewise_regression.main.Fit.get_results">
 <span class="sig-name descname"><span class="pre">get_results</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#piecewise_regression.main.Fit.get_results" title="Link to this definition"></a></dt>

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -141,6 +141,8 @@ <h2 id="G">G</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#piecewise_regression.main.NextBreakpoints.get_const_standard_error">get_const_standard_error() (piecewise_regression.main.NextBreakpoints method)</a>
+</li>
+      <li><a href="api.html#piecewise_regression.main.Fit.get_params">get_params() (piecewise_regression.main.Fit method)</a>
 </li>
       <li><a href="api.html#piecewise_regression.main.NextBreakpoints.get_predicted_yy">get_predicted_yy() (piecewise_regression.main.NextBreakpoints method)</a>
 </li>

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -84,7 +84,7 @@ <h2>piecewise-regression (aka segmented regression) in python<a class="headerlin
 <dd class="field-even"><p>Charlie Pilgrim</p>
 </dd>
 <dt class="field-odd">Version<span class="colon">:</span></dt>
-<dd class="field-odd"><p>1.4.2</p>
+<dd class="field-odd"><p>1.4.3</p>
 </dd>
 <dt class="field-even">Github<span class="colon">:</span></dt>
 <dd class="field-even"><p><a class="reference external" href="https://github.com/chasmani/piecewise-regression">https://github.com/chasmani/piecewise-regression</a></p>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js