Update documentation

4 years ago · 5349669bc9
parent 028e6f6b22
commit 5349669bc9
6 changed files with 16 additions and 8 deletions
--- a/docs-out/_build/doctrees/PyCTBN.PyCTBN.estimators.doctree
+++ b/docs-out/_build/doctrees/PyCTBN.PyCTBN.estimators.doctree
--- a/docs-out/_build/doctrees/environment.pickle
+++ b/docs-out/_build/doctrees/environment.pickle
--- a/docs-out/_build/html/PyCTBN.PyCTBN.estimators.html
+++ b/docs-out/_build/html/PyCTBN.PyCTBN.estimators.html
@ -645,9 +645,13 @@ Spurious edges are colored in red if a prior structure is present.</p>
 <dl class="py method">
 <dt id="PyCTBN.PyCTBN.estimators.structure_estimator.StructureEstimator.save_results">
-<code class="sig-name descname">save_results</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#PyCTBN.PyCTBN.estimators.structure_estimator.StructureEstimator.save_results" title="Permalink to this definition">¶</a></dt>
+<code class="sig-name descname">save_results</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">file_path</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#PyCTBN.PyCTBN.estimators.structure_estimator.StructureEstimator.save_results" title="Permalink to this definition">¶</a></dt>
-<dd><p>Save the estimated Structure to a .json file in the path where the data are loaded from.
+<dd><p>Save the estimated Structure to a .json file in file_path.</p>
-The file is named as the input dataset but the <cite>results_</cite> word is appended to the results file.</p>
+<dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><p><strong>file_path</strong> (<em>string</em>) – the path including the file name with .json extension</p>
 </dd>
 </dl>
 </dd></dl>
 <dl class="py method">
--- a/docs-out/_build/html/searchindex.js
+++ b/docs-out/_build/html/searchindex.js
--- a/docs/PyCTBN.PyCTBN.estimators.html
+++ b/docs/PyCTBN.PyCTBN.estimators.html
@ -645,9 +645,13 @@ Spurious edges are colored in red if a prior structure is present.</p>
 <dl class="py method">
 <dt id="PyCTBN.PyCTBN.estimators.structure_estimator.StructureEstimator.save_results">
-<code class="sig-name descname">save_results</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#PyCTBN.PyCTBN.estimators.structure_estimator.StructureEstimator.save_results" title="Permalink to this definition">¶</a></dt>
+<code class="sig-name descname">save_results</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">file_path</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#PyCTBN.PyCTBN.estimators.structure_estimator.StructureEstimator.save_results" title="Permalink to this definition">¶</a></dt>
-<dd><p>Save the estimated Structure to a .json file in the path where the data are loaded from.
+<dd><p>Save the estimated Structure to a .json file in file_path.</p>
-The file is named as the input dataset but the <cite>results_</cite> word is appended to the results file.</p>
+<dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><p><strong>file_path</strong> (<em>string</em>) – the path including the file name with .json extension</p>
 </dd>
 </dl>
 </dd></dl>
 <dl class="py method">
--- a/docs/searchindex.js
+++ b/docs/searchindex.js