Skip to content

Commit

Permalink
doc updates [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Circle Ci committed Dec 24, 2024
1 parent 136e45f commit a352959
Show file tree
Hide file tree
Showing 31 changed files with 97 additions and 97 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified dev/_images/sphx_glr_plot_mixed_edge_graph_001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_mixed_edge_graph_thumb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ To check if the constructed PAG is a valid one in pywhy-graphs, we can simply do
.. code-block:: none
ConditioningSetSelection.PDS
Context(observed_variables={'S', 'PSH', 'I', 'L', 'G'}, latent_variables=set(), state_variables={}, init_graph=<networkx.classes.graph.Graph object at 0x731e548aa450>, included_edges=<networkx.classes.graph.Graph object at 0x731e548aab50>, excluded_edges=<networkx.classes.graph.Graph object at 0x731e548aaf90>, num_distributions=1, obs_distribution=True, intervention_targets=[], symmetric_diff_map={}, sigma_map={}, f_nodes=[], num_domains=1, domain_map={}, s_nodes=[])
Context(observed_variables={'L', 'G', 'I', 'S', 'PSH'}, latent_variables=set(), state_variables={}, init_graph=<networkx.classes.graph.Graph object at 0x74cb44cde690>, included_edges=<networkx.classes.graph.Graph object at 0x74cb44cded90>, excluded_edges=<networkx.classes.graph.Graph object at 0x74cb44cdf1d0>, num_distributions=1, obs_distribution=True, intervention_targets=[], symmetric_diff_map={}, sigma_map={}, f_nodes=[], num_domains=1, domain_map={}, s_nodes=[])
True
Expand Down Expand Up @@ -180,7 +180,7 @@ relationship. As such, the resulting graph is no longer a valid PAG.
.. code-block:: none
ConditioningSetSelection.PDS
Context(observed_variables={'S', 'PSH', 'I', 'L', 'G'}, latent_variables=set(), state_variables={}, init_graph=<networkx.classes.graph.Graph object at 0x731e546be490>, included_edges=<networkx.classes.graph.Graph object at 0x731e546beb90>, excluded_edges=<networkx.classes.graph.Graph object at 0x731e546befd0>, num_distributions=1, obs_distribution=True, intervention_targets=[], symmetric_diff_map={}, sigma_map={}, f_nodes=[], num_domains=1, domain_map={}, s_nodes=[])
Context(observed_variables={'L', 'G', 'I', 'S', 'PSH'}, latent_variables=set(), state_variables={}, init_graph=<networkx.classes.graph.Graph object at 0x74cb44cee690>, included_edges=<networkx.classes.graph.Graph object at 0x74cb44ceed90>, excluded_edges=<networkx.classes.graph.Graph object at 0x74cb44cef1d0>, num_distributions=1, obs_distribution=True, intervention_targets=[], symmetric_diff_map={}, sigma_map={}, f_nodes=[], num_domains=1, domain_map={}, s_nodes=[])
False
Expand All @@ -195,9 +195,9 @@ References

.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 0.973 seconds)
**Total running time of the script:** (0 minutes 1.031 seconds)

**Estimated memory usage:** 166 MB
**Estimated memory usage:** 165 MB


.. _sphx_glr_download_auto_examples_intro_checking_validity_of_a_pag.py:
Expand Down
4 changes: 2 additions & 2 deletions dev/_sources/auto_examples/intro/inducing_path.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -241,9 +241,9 @@ References

.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 0.959 seconds)
**Total running time of the script:** (0 minutes 1.010 seconds)

**Estimated memory usage:** 165 MB
**Estimated memory usage:** 163 MB


.. _sphx_glr_download_auto_examples_intro_inducing_path.py:
Expand Down
8 changes: 4 additions & 4 deletions dev/_sources/auto_examples/intro/intro_causal_graphs.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Here, we will simulate some data to understand causal graphs in the context of S

.. code-block:: none
Fitting causal models: 0%| | 0/5 [00:00<?, ?it/s] Fitting causal mechanism of node x: 0%| | 0/5 [00:00<?, ?it/s] Fitting causal mechanism of node y: 0%| | 0/5 [00:00<?, ?it/s] Fitting causal mechanism of node z: 0%| | 0/5 [00:00<?, ?it/s] Fitting causal mechanism of node w: 0%| | 0/5 [00:00<?, ?it/s] Fitting causal mechanism of node xy: 0%| | 0/5 [00:00<?, ?it/s] Fitting causal mechanism of node xy: 100%|██████████| 5/5 [00:00<00:00, 865.63it/s]
Fitting causal models: 0%| | 0/5 [00:00<?, ?it/s] Fitting causal mechanism of node x: 0%| | 0/5 [00:00<?, ?it/s] Fitting causal mechanism of node y: 0%| | 0/5 [00:00<?, ?it/s] Fitting causal mechanism of node z: 0%| | 0/5 [00:00<?, ?it/s] Fitting causal mechanism of node w: 0%| | 0/5 [00:00<?, ?it/s] Fitting causal mechanism of node xy: 0%| | 0/5 [00:00<?, ?it/s] Fitting causal mechanism of node xy: 100%|██████████| 5/5 [00:00<00:00, 864.77it/s]
z xy w x y
0 1 1 1 1 1
1 1 1 2 2 3
Expand All @@ -183,7 +183,7 @@ Here, we will simulate some data to understand causal graphs in the context of S
y [1, 3, 2, 0]
dtype: object

<graphviz.graphs.Digraph object at 0x731e548f4c10>
<graphviz.graphs.Digraph object at 0x74cb44f22f10>



Expand Down Expand Up @@ -427,9 +427,9 @@ References

.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 2.115 seconds)
**Total running time of the script:** (0 minutes 2.298 seconds)

**Estimated memory usage:** 250 MB
**Estimated memory usage:** 248 MB


.. _sphx_glr_download_auto_examples_intro_intro_causal_graphs.py:
Expand Down
14 changes: 7 additions & 7 deletions dev/_sources/auto_examples/intro/sg_execution_times.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Computation times
=================
**00:04.046** total execution time for 3 files **from auto_examples/intro**:
**00:04.339** total execution time for 3 files **from auto_examples/intro**:

.. container::

Expand All @@ -33,11 +33,11 @@ Computation times
- Time
- Mem (MB)
* - :ref:`sphx_glr_auto_examples_intro_intro_causal_graphs.py` (``intro_causal_graphs.py``)
- 00:02.115
- 249.9
- 00:02.298
- 247.5
* - :ref:`sphx_glr_auto_examples_intro_checking_validity_of_a_pag.py` (``checking_validity_of_a_pag.py``)
- 00:00.973
- 166.1
- 00:01.031
- 164.9
* - :ref:`sphx_glr_auto_examples_intro_inducing_path.py` (``inducing_path.py``)
- 00:00.959
- 164.7
- 00:01.010
- 163.5
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Mixed Edge Graph Properties
MixedEdgeGraph named 'IV Graph' with 3 nodes and 3 edges and 2 edge types is directed: False because there are directed edges.
False
['directed', 'bidirected']
{'directed': <networkx.classes.digraph.DiGraph object at 0x731d8918c390>, 'bidirected': <networkx.classes.graph.Graph object at 0x731e53d2c750>}
{'directed': <networkx.classes.digraph.DiGraph object at 0x74ca7a1545d0>, 'bidirected': <networkx.classes.graph.Graph object at 0x74cb4433e9d0>}
Expand Down Expand Up @@ -194,7 +194,7 @@ Mixed Edge Graph Operations on Nodes

.. code-block:: none
MixedEdgeGraph named 'IV Graph' with 3 nodes and 3 edges and 2 edge types has nodes: ['X', 'Z', 'Y']
MixedEdgeGraph named 'IV Graph' with 3 nodes and 3 edges and 2 edge types has nodes: ['Z', 'Y', 'X']
Graph has node A: False
Now graph has node A: True
Graph has node A: False
Expand Down Expand Up @@ -312,9 +312,9 @@ class properties. Moreover, one can specify the edge type.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 1.143 seconds)
**Total running time of the script:** (0 minutes 1.274 seconds)

**Estimated memory usage:** 171 MB
**Estimated memory usage:** 170 MB


.. _sphx_glr_download_auto_examples_mixededge_plot_mixed_edge_graph.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Computation times
=================
**00:01.143** total execution time for 1 file **from auto_examples/mixededge**:
**00:01.274** total execution time for 1 file **from auto_examples/mixededge**:

.. container::

Expand All @@ -33,5 +33,5 @@ Computation times
- Time
- Mem (MB)
* - :ref:`sphx_glr_auto_examples_mixededge_plot_mixed_edge_graph.py` (``plot_mixed_edge_graph.py``)
- 00:01.143
- 170.6
- 00:01.274
- 169.7
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,9 @@ such as `Dagitty <http://dagitty.net>`_.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 0.406 seconds)
**Total running time of the script:** (0 minutes 0.431 seconds)

**Estimated memory usage:** 165 MB
**Estimated memory usage:** 163 MB


.. _sphx_glr_download_auto_examples_visualization_draw_and_compare_graphs_with_same_layout.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,9 @@ which creates a nice default layout for time-series graphs.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 0.934 seconds)
**Total running time of the script:** (0 minutes 1.080 seconds)

**Estimated memory usage:** 165 MB
**Estimated memory usage:** 164 MB


.. _sphx_glr_download_auto_examples_visualization_plot_timeseries_graphs.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Computation times
=================
**00:01.341** total execution time for 2 files **from auto_examples/visualization**:
**00:01.510** total execution time for 2 files **from auto_examples/visualization**:

.. container::

Expand All @@ -33,8 +33,8 @@ Computation times
- Time
- Mem (MB)
* - :ref:`sphx_glr_auto_examples_visualization_plot_timeseries_graphs.py` (``plot_timeseries_graphs.py``)
- 00:00.934
- 164.7
- 00:01.080
- 163.8
* - :ref:`sphx_glr_auto_examples_visualization_draw_and_compare_graphs_with_same_layout.py` (``draw_and_compare_graphs_with_same_layout.py``)
- 00:00.406
- 164.7
- 00:00.431
- 163.5
28 changes: 14 additions & 14 deletions dev/_sources/sg_execution_times.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Computation times
=================
**00:06.530** total execution time for 6 files **from all galleries**:
**00:07.123** total execution time for 6 files **from all galleries**:

.. container::

Expand All @@ -33,20 +33,20 @@ Computation times
- Time
- Mem (MB)
* - :ref:`sphx_glr_auto_examples_intro_intro_causal_graphs.py` (``../examples/intro/intro_causal_graphs.py``)
- 00:02.115
- 249.9
- 00:02.298
- 247.5
* - :ref:`sphx_glr_auto_examples_mixededge_plot_mixed_edge_graph.py` (``../examples/mixededge/plot_mixed_edge_graph.py``)
- 00:01.143
- 170.6
- 00:01.274
- 169.7
* - :ref:`sphx_glr_auto_examples_visualization_plot_timeseries_graphs.py` (``../examples/visualization/plot_timeseries_graphs.py``)
- 00:01.080
- 163.8
* - :ref:`sphx_glr_auto_examples_intro_checking_validity_of_a_pag.py` (``../examples/intro/checking_validity_of_a_pag.py``)
- 00:00.973
- 166.1
- 00:01.031
- 164.9
* - :ref:`sphx_glr_auto_examples_intro_inducing_path.py` (``../examples/intro/inducing_path.py``)
- 00:00.959
- 164.7
* - :ref:`sphx_glr_auto_examples_visualization_plot_timeseries_graphs.py` (``../examples/visualization/plot_timeseries_graphs.py``)
- 00:00.934
- 164.7
- 00:01.010
- 163.5
* - :ref:`sphx_glr_auto_examples_visualization_draw_and_compare_graphs_with_same_layout.py` (``../examples/visualization/draw_and_compare_graphs_with_same_layout.py``)
- 00:00.406
- 164.7
- 00:00.431
- 163.5
8 changes: 4 additions & 4 deletions dev/auto_examples/intro/checking_validity_of_a_pag.html
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,7 @@ <h2>Validity of a PAG<a class="headerlink" href="#validity-of-a-pag" title="Link
</pre></div>
</div>
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>ConditioningSetSelection.PDS
Context(observed_variables={&#39;S&#39;, &#39;PSH&#39;, &#39;I&#39;, &#39;L&#39;, &#39;G&#39;}, latent_variables=set(), state_variables={}, init_graph=&lt;networkx.classes.graph.Graph object at 0x731e548aa450&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x731e548aab50&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x731e548aaf90&gt;, num_distributions=1, obs_distribution=True, intervention_targets=[], symmetric_diff_map={}, sigma_map={}, f_nodes=[], num_domains=1, domain_map={}, s_nodes=[])
Context(observed_variables={&#39;L&#39;, &#39;G&#39;, &#39;I&#39;, &#39;S&#39;, &#39;PSH&#39;}, latent_variables=set(), state_variables={}, init_graph=&lt;networkx.classes.graph.Graph object at 0x74cb44cde690&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x74cb44cded90&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x74cb44cdf1d0&gt;, num_distributions=1, obs_distribution=True, intervention_targets=[], symmetric_diff_map={}, sigma_map={}, f_nodes=[], num_domains=1, domain_map={}, s_nodes=[])
True
</pre></div>
</div>
Expand All @@ -558,7 +558,7 @@ <h2>Validity of a PAG<a class="headerlink" href="#validity-of-a-pag" title="Link
</pre></div>
</div>
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>ConditioningSetSelection.PDS
Context(observed_variables={&#39;S&#39;, &#39;PSH&#39;, &#39;I&#39;, &#39;L&#39;, &#39;G&#39;}, latent_variables=set(), state_variables={}, init_graph=&lt;networkx.classes.graph.Graph object at 0x731e546be490&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x731e546beb90&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x731e546befd0&gt;, num_distributions=1, obs_distribution=True, intervention_targets=[], symmetric_diff_map={}, sigma_map={}, f_nodes=[], num_domains=1, domain_map={}, s_nodes=[])
Context(observed_variables={&#39;L&#39;, &#39;G&#39;, &#39;I&#39;, &#39;S&#39;, &#39;PSH&#39;}, latent_variables=set(), state_variables={}, init_graph=&lt;networkx.classes.graph.Graph object at 0x74cb44cee690&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x74cb44ceed90&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x74cb44cef1d0&gt;, num_distributions=1, obs_distribution=True, intervention_targets=[], symmetric_diff_map={}, sigma_map={}, f_nodes=[], num_domains=1, domain_map={}, s_nodes=[])
False
</pre></div>
</div>
Expand All @@ -574,8 +574,8 @@ <h2>References<a class="headerlink" href="#references" title="Link to this headi
</aside>
</aside>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.973 seconds)</p>
<p><strong>Estimated memory usage:</strong> 166 MB</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 1.031 seconds)</p>
<p><strong>Estimated memory usage:</strong> 165 MB</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-intro-checking-validity-of-a-pag-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../../_downloads/5f927be0252fc0d8c3167ec4c832cbc7/checking_validity_of_a_pag.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">checking_validity_of_a_pag.ipynb</span></code></a></p>
Expand Down
4 changes: 2 additions & 2 deletions dev/auto_examples/intro/inducing_path.html
Original file line number Diff line number Diff line change
Expand Up @@ -610,8 +610,8 @@ <h2>References<a class="headerlink" href="#references" title="Link to this headi
</aside>
</aside>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.959 seconds)</p>
<p><strong>Estimated memory usage:</strong> 165 MB</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 1.010 seconds)</p>
<p><strong>Estimated memory usage:</strong> 163 MB</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-intro-inducing-path-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../../_downloads/8259499c2b052354bd5dc54791c0d957/inducing_path.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">inducing_path.ipynb</span></code></a></p>
Expand Down
8 changes: 4 additions & 4 deletions dev/auto_examples/intro/intro_causal_graphs.html
Original file line number Diff line number Diff line change
Expand Up @@ -591,7 +591,7 @@ <h2>Structural Causal Models: Simulating some data<a class="headerlink" href="#s
Fitting causal mechanism of node z: 0%| | 0/5 [00:00&lt;?, ?it/s]
Fitting causal mechanism of node w: 0%| | 0/5 [00:00&lt;?, ?it/s]
Fitting causal mechanism of node xy: 0%| | 0/5 [00:00&lt;?, ?it/s]
Fitting causal mechanism of node xy: 100%|██████████| 5/5 [00:00&lt;00:00, 865.63it/s]
Fitting causal mechanism of node xy: 100%|██████████| 5/5 [00:00&lt;00:00, 864.77it/s]
z xy w x y
0 1 1 1 1 1
1 1 1 2 2 3
Expand All @@ -605,7 +605,7 @@ <h2>Structural Causal Models: Simulating some data<a class="headerlink" href="#s
y [1, 3, 2, 0]
dtype: object

&lt;graphviz.graphs.Digraph object at 0x731e548f4c10&gt;
&lt;graphviz.graphs.Digraph object at 0x74cb44f22f10&gt;
</pre></div>
</div>
</section>
Expand Down Expand Up @@ -774,8 +774,8 @@ <h3>References<a class="headerlink" href="#references" title="Link to this headi
</aside>
</aside>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 2.115 seconds)</p>
<p><strong>Estimated memory usage:</strong> 250 MB</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 2.298 seconds)</p>
<p><strong>Estimated memory usage:</strong> 248 MB</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-intro-intro-causal-graphs-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../../_downloads/e92c7413422dfa4591a10ac31b2b0f4d/intro_causal_graphs.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">intro_causal_graphs.ipynb</span></code></a></p>
Expand Down
14 changes: 7 additions & 7 deletions dev/auto_examples/intro/sg_execution_times.html
Original file line number Diff line number Diff line change
Expand Up @@ -435,7 +435,7 @@

<section id="computation-times">
<span id="sphx-glr-auto-examples-intro-sg-execution-times"></span><h1>Computation times<a class="headerlink" href="#computation-times" title="Link to this heading">#</a></h1>
<p><strong>00:04.046</strong> total execution time for 3 files <strong>from auto_examples/intro</strong>:</p>
<p><strong>00:04.339</strong> total execution time for 3 files <strong>from auto_examples/intro</strong>:</p>
<div class="docutils container">
<style scoped>
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet" />
Expand All @@ -457,16 +457,16 @@
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference internal" href="intro_causal_graphs.html#sphx-glr-auto-examples-intro-intro-causal-graphs-py"><span class="std std-ref">An introduction to causal graphs and how to use them</span></a> (<code class="docutils literal notranslate"><span class="pre">intro_causal_graphs.py</span></code>)</p></td>
<td><p>00:02.115</p></td>
<td><p>249.9</p></td>
<td><p>00:02.298</p></td>
<td><p>247.5</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="checking_validity_of_a_pag.html#sphx-glr-auto-examples-intro-checking-validity-of-a-pag-py"><span class="std std-ref">On PAGs and their validity</span></a> (<code class="docutils literal notranslate"><span class="pre">checking_validity_of_a_pag.py</span></code>)</p></td>
<td><p>00:00.973</p></td>
<td><p>166.1</p></td>
<td><p>00:01.031</p></td>
<td><p>164.9</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="inducing_path.html#sphx-glr-auto-examples-intro-inducing-path-py"><span class="std std-ref">An introduction to Inducing Paths and how to find them</span></a> (<code class="docutils literal notranslate"><span class="pre">inducing_path.py</span></code>)</p></td>
<td><p>00:00.959</p></td>
<td><p>164.7</p></td>
<td><p>00:01.010</p></td>
<td><p>163.5</p></td>
</tr>
</tbody>
</table>
Expand Down
Loading

0 comments on commit a352959

Please sign in to comment.