1
0
Fork 0

Update documentation

master
philipMartini 4 years ago
parent 431236cd6c
commit d25582d751
  1. BIN
      docs-out/_build/doctrees/PyCTBN.PyCTBN.estimators.doctree
  2. BIN
      docs-out/_build/doctrees/environment.pickle
  3. 29
      docs-out/_build/html/PyCTBN.PyCTBN.estimators.html
  4. 2
      docs-out/_build/html/searchindex.js
  5. 29
      docs/PyCTBN.PyCTBN.estimators.html
  6. 2
      docs/searchindex.js

@ -399,22 +399,26 @@ in the graph <code class="docutils literal notranslate"><span class="pre">_net_g
<li><p><strong>sample_path</strong> (<a class="reference internal" href="PyCTBN.PyCTBN.structure_graph.html#PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath" title="PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath"><em>SamplePath</em></a>) – the _sample_path object containing the trajectories and the real structure</p></li> <li><p><strong>sample_path</strong> (<a class="reference internal" href="PyCTBN.PyCTBN.structure_graph.html#PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath" title="PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath"><em>SamplePath</em></a>) – the _sample_path object containing the trajectories and the real structure</p></li>
<li><p><strong>exp_test_alfa</strong> (<em>float</em>) – the significance level for the exponential Hp test</p></li> <li><p><strong>exp_test_alfa</strong> (<em>float</em>) – the significance level for the exponential Hp test</p></li>
<li><p><strong>chi_test_alfa</strong> (<em>float</em>) – the significance level for the chi Hp test</p></li> <li><p><strong>chi_test_alfa</strong> (<em>float</em>) – the significance level for the chi Hp test</p></li>
<li><p><strong>known_edges</strong> (<em>List</em>) – the prior known edges in the net structure if present</p></li>
</ul> </ul>
</dd> </dd>
<dt class="field-even">_nodes</dt> <dt class="field-even">Param</dt>
<dd class="field-even"><p>the nodes labels</p> <dd class="field-even"><p>thumb_threshold: the threshold value to consider a valid independence test</p>
</dd> </dd>
<dt class="field-odd">_nodes_vals</dt> <dt class="field-odd">_nodes</dt>
<dd class="field-odd"><p>the nodes cardinalities</p> <dd class="field-odd"><p>the nodes labels</p>
</dd> </dd>
<dt class="field-even">_nodes_indxs</dt> <dt class="field-even">_nodes_vals</dt>
<dd class="field-even"><p>the nodes indexes</p> <dd class="field-even"><p>the nodes cardinalities</p>
</dd> </dd>
<dt class="field-odd">_complete_graph</dt> <dt class="field-odd">_nodes_indxs</dt>
<dd class="field-odd"><p>the complete directed graph built using the nodes labels in <code class="docutils literal notranslate"><span class="pre">_nodes</span></code></p> <dd class="field-odd"><p>the nodes indexes</p>
</dd>
<dt class="field-even">_complete_graph</dt>
<dd class="field-even"><p>the complete directed graph built using the nodes labels in <code class="docutils literal notranslate"><span class="pre">_nodes</span></code></p>
</dd> </dd>
<dt class="field-even">_cache</dt> <dt class="field-odd">_cache</dt>
<dd class="field-even"><p>the Cache object</p> <dd class="field-odd"><p>the Cache object</p>
</dd> </dd>
</dl> </dl>
<dl class="py method"> <dl class="py method">
@ -529,7 +533,10 @@ it is performed also the chi_test.</p>
<p>Has the task of estimating the network structure given the trajectories in <code class="docutils literal notranslate"><span class="pre">samplepath</span></code>.</p> <p>Has the task of estimating the network structure given the trajectories in <code class="docutils literal notranslate"><span class="pre">samplepath</span></code>.</p>
<dl class="field-list simple"> <dl class="field-list simple">
<dt class="field-odd">Parameters</dt> <dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sample_path</strong> (<a class="reference internal" href="PyCTBN.PyCTBN.structure_graph.html#PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath" title="PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath"><em>SamplePath</em></a>) – the _sample_path object containing the trajectories and the real structure</p> <dd class="field-odd"><ul class="simple">
<li><p><strong>sample_path</strong> (<a class="reference internal" href="PyCTBN.PyCTBN.structure_graph.html#PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath" title="PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath"><em>SamplePath</em></a>) – the _sample_path object containing the trajectories and the real structure</p></li>
<li><p><strong>known_edges</strong> (<em>List</em>) – the prior known edges in the net structure if present</p></li>
</ul>
</dd> </dd>
<dt class="field-even">_nodes</dt> <dt class="field-even">_nodes</dt>
<dd class="field-even"><p>the nodes labels</p> <dd class="field-even"><p>the nodes labels</p>

File diff suppressed because one or more lines are too long

@ -399,22 +399,26 @@ in the graph <code class="docutils literal notranslate"><span class="pre">_net_g
<li><p><strong>sample_path</strong> (<a class="reference internal" href="PyCTBN.PyCTBN.structure_graph.html#PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath" title="PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath"><em>SamplePath</em></a>) – the _sample_path object containing the trajectories and the real structure</p></li> <li><p><strong>sample_path</strong> (<a class="reference internal" href="PyCTBN.PyCTBN.structure_graph.html#PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath" title="PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath"><em>SamplePath</em></a>) – the _sample_path object containing the trajectories and the real structure</p></li>
<li><p><strong>exp_test_alfa</strong> (<em>float</em>) – the significance level for the exponential Hp test</p></li> <li><p><strong>exp_test_alfa</strong> (<em>float</em>) – the significance level for the exponential Hp test</p></li>
<li><p><strong>chi_test_alfa</strong> (<em>float</em>) – the significance level for the chi Hp test</p></li> <li><p><strong>chi_test_alfa</strong> (<em>float</em>) – the significance level for the chi Hp test</p></li>
<li><p><strong>known_edges</strong> (<em>List</em>) – the prior known edges in the net structure if present</p></li>
</ul> </ul>
</dd> </dd>
<dt class="field-even">_nodes</dt> <dt class="field-even">Param</dt>
<dd class="field-even"><p>the nodes labels</p> <dd class="field-even"><p>thumb_threshold: the threshold value to consider a valid independence test</p>
</dd> </dd>
<dt class="field-odd">_nodes_vals</dt> <dt class="field-odd">_nodes</dt>
<dd class="field-odd"><p>the nodes cardinalities</p> <dd class="field-odd"><p>the nodes labels</p>
</dd> </dd>
<dt class="field-even">_nodes_indxs</dt> <dt class="field-even">_nodes_vals</dt>
<dd class="field-even"><p>the nodes indexes</p> <dd class="field-even"><p>the nodes cardinalities</p>
</dd> </dd>
<dt class="field-odd">_complete_graph</dt> <dt class="field-odd">_nodes_indxs</dt>
<dd class="field-odd"><p>the complete directed graph built using the nodes labels in <code class="docutils literal notranslate"><span class="pre">_nodes</span></code></p> <dd class="field-odd"><p>the nodes indexes</p>
</dd>
<dt class="field-even">_complete_graph</dt>
<dd class="field-even"><p>the complete directed graph built using the nodes labels in <code class="docutils literal notranslate"><span class="pre">_nodes</span></code></p>
</dd> </dd>
<dt class="field-even">_cache</dt> <dt class="field-odd">_cache</dt>
<dd class="field-even"><p>the Cache object</p> <dd class="field-odd"><p>the Cache object</p>
</dd> </dd>
</dl> </dl>
<dl class="py method"> <dl class="py method">
@ -529,7 +533,10 @@ it is performed also the chi_test.</p>
<p>Has the task of estimating the network structure given the trajectories in <code class="docutils literal notranslate"><span class="pre">samplepath</span></code>.</p> <p>Has the task of estimating the network structure given the trajectories in <code class="docutils literal notranslate"><span class="pre">samplepath</span></code>.</p>
<dl class="field-list simple"> <dl class="field-list simple">
<dt class="field-odd">Parameters</dt> <dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sample_path</strong> (<a class="reference internal" href="PyCTBN.PyCTBN.structure_graph.html#PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath" title="PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath"><em>SamplePath</em></a>) – the _sample_path object containing the trajectories and the real structure</p> <dd class="field-odd"><ul class="simple">
<li><p><strong>sample_path</strong> (<a class="reference internal" href="PyCTBN.PyCTBN.structure_graph.html#PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath" title="PyCTBN.PyCTBN.structure_graph.sample_path.SamplePath"><em>SamplePath</em></a>) – the _sample_path object containing the trajectories and the real structure</p></li>
<li><p><strong>known_edges</strong> (<em>List</em>) – the prior known edges in the net structure if present</p></li>
</ul>
</dd> </dd>
<dt class="field-even">_nodes</dt> <dt class="field-even">_nodes</dt>
<dd class="field-even"><p>the nodes labels</p> <dd class="field-even"><p>the nodes labels</p>

File diff suppressed because one or more lines are too long