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 Nov 8, 2024
1 parent 76f6717 commit db91a01
Show file tree
Hide file tree
Showing 31 changed files with 83 additions and 83 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={'I', 'S', 'PSH', 'G', 'L'}, latent_variables=set(), state_variables={}, init_graph=<networkx.classes.graph.Graph object at 0x7fd0da2b9910>, included_edges=<networkx.classes.graph.Graph object at 0x7fd0da2ba010>, excluded_edges=<networkx.classes.graph.Graph object at 0x7fd0da2ba450>, 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', 'S', 'G', 'I', 'PSH'}, latent_variables=set(), state_variables={}, init_graph=<networkx.classes.graph.Graph object at 0x7fc64a2b60d0>, included_edges=<networkx.classes.graph.Graph object at 0x7fc64a2b67d0>, excluded_edges=<networkx.classes.graph.Graph object at 0x7fc64a2b6c10>, 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={'I', 'S', 'PSH', 'G', 'L'}, latent_variables=set(), state_variables={}, init_graph=<networkx.classes.graph.Graph object at 0x7fd0da2c1d90>, included_edges=<networkx.classes.graph.Graph object at 0x7fd0da2c2490>, excluded_edges=<networkx.classes.graph.Graph object at 0x7fd0da2c28d0>, 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', 'S', 'G', 'I', 'PSH'}, latent_variables=set(), state_variables={}, init_graph=<networkx.classes.graph.Graph object at 0x7fc64a2be5d0>, included_edges=<networkx.classes.graph.Graph object at 0x7fc64a2becd0>, excluded_edges=<networkx.classes.graph.Graph object at 0x7fc64a2bf110>, 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,7 +195,7 @@ References

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

**Total running time of the script:** (0 minutes 1.438 seconds)
**Total running time of the script:** (0 minutes 1.331 seconds)

**Estimated memory usage:** 167 MB

Expand Down
2 changes: 1 addition & 1 deletion dev/_sources/auto_examples/intro/inducing_path.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ References

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

**Total running time of the script:** (0 minutes 1.524 seconds)
**Total running time of the script:** (0 minutes 1.424 seconds)

**Estimated memory usage:** 165 MB

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, 727.52it/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, 708.04it/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 0x7fd0fc6a61d0>
<graphviz.graphs.Digraph object at 0x7fc66c486990>



Expand Down Expand Up @@ -307,7 +307,7 @@ in the graph. These unobserved confounders are graphically depicted with a bidir

.. code-block:: none
['x', 'z']
['z', 'x']
The ADMG has confounded-components: [{'y', 'x'}, {'z'}, {'w'}]
'z' is d-separated from 'x': True
'z' is d-separated from 'x' given 'y': False
Expand Down Expand Up @@ -427,7 +427,7 @@ References

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

**Total running time of the script:** (0 minutes 2.873 seconds)
**Total running time of the script:** (0 minutes 2.754 seconds)

**Estimated memory usage:** 252 MB

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:05.834** total execution time for 3 files **from auto_examples/intro**:
**00:05.509** 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.873
- 252.1
- 00:02.754
- 252.2
* - :ref:`sphx_glr_auto_examples_intro_inducing_path.py` (``inducing_path.py``)
- 00:01.524
- 165.2
- 00:01.424
- 165.4
* - :ref:`sphx_glr_auto_examples_intro_checking_validity_of_a_pag.py` (``checking_validity_of_a_pag.py``)
- 00:01.438
- 166.7
- 00:01.331
- 167.0
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 0x7fd1009cf450>, 'bidirected': <networkx.classes.graph.Graph object at 0x7fd0fc6ed4d0>}
{'directed': <networkx.classes.digraph.DiGraph object at 0x7fc66c6c2410>, 'bidirected': <networkx.classes.graph.Graph object at 0x7fc66c494ad0>}
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: ['Y', 'Z', 'X']
MixedEdgeGraph named 'IV Graph' with 3 nodes and 3 edges and 2 edge types has nodes: ['Y', 'X', 'Z']
Graph has node A: False
Now graph has node A: True
Graph has node A: False
Expand Down Expand Up @@ -312,7 +312,7 @@ class properties. Moreover, one can specify the edge type.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 1.706 seconds)
**Total running time of the script:** (0 minutes 1.715 seconds)

**Estimated memory usage:** 172 MB

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Computation times
=================
**00:01.706** total execution time for 1 file **from auto_examples/mixededge**:
**00:01.715** 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.706
- 171.8
- 00:01.715
- 172.0
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ such as `Dagitty <http://dagitty.net>`_.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 0.515 seconds)
**Total running time of the script:** (0 minutes 0.482 seconds)

**Estimated memory usage:** 165 MB

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

**Total running time of the script:** (0 minutes 1.251 seconds)
**Total running time of the script:** (0 minutes 1.195 seconds)

**Estimated memory usage:** 165 MB

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Computation times
=================
**00:01.766** total execution time for 2 files **from auto_examples/visualization**:
**00:01.677** 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:01.251
- 165.2
- 00:01.195
- 165.4
* - :ref:`sphx_glr_auto_examples_visualization_draw_and_compare_graphs_with_same_layout.py` (``draw_and_compare_graphs_with_same_layout.py``)
- 00:00.515
- 165.2
- 00:00.482
- 165.4
26 changes: 13 additions & 13 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:09.306** total execution time for 6 files **from all galleries**:
**00:08.901** 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.873
- 252.1
- 00:02.754
- 252.2
* - :ref:`sphx_glr_auto_examples_mixededge_plot_mixed_edge_graph.py` (``../examples/mixededge/plot_mixed_edge_graph.py``)
- 00:01.706
- 171.8
- 00:01.715
- 172.0
* - :ref:`sphx_glr_auto_examples_intro_inducing_path.py` (``../examples/intro/inducing_path.py``)
- 00:01.524
- 165.2
- 00:01.424
- 165.4
* - :ref:`sphx_glr_auto_examples_intro_checking_validity_of_a_pag.py` (``../examples/intro/checking_validity_of_a_pag.py``)
- 00:01.438
- 166.7
- 00:01.331
- 167.0
* - :ref:`sphx_glr_auto_examples_visualization_plot_timeseries_graphs.py` (``../examples/visualization/plot_timeseries_graphs.py``)
- 00:01.251
- 165.2
- 00:01.195
- 165.4
* - :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.515
- 165.2
- 00:00.482
- 165.4
6 changes: 3 additions & 3 deletions dev/auto_examples/intro/checking_validity_of_a_pag.html
Original file line number Diff line number Diff line change
Expand Up @@ -533,7 +533,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;I&#39;, &#39;S&#39;, &#39;PSH&#39;, &#39;G&#39;, &#39;L&#39;}, latent_variables=set(), state_variables={}, init_graph=&lt;networkx.classes.graph.Graph object at 0x7fd0da2b9910&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x7fd0da2ba010&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x7fd0da2ba450&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;S&#39;, &#39;G&#39;, &#39;I&#39;, &#39;PSH&#39;}, latent_variables=set(), state_variables={}, init_graph=&lt;networkx.classes.graph.Graph object at 0x7fc64a2b60d0&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x7fc64a2b67d0&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x7fc64a2b6c10&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 @@ -552,7 +552,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;I&#39;, &#39;S&#39;, &#39;PSH&#39;, &#39;G&#39;, &#39;L&#39;}, latent_variables=set(), state_variables={}, init_graph=&lt;networkx.classes.graph.Graph object at 0x7fd0da2c1d90&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x7fd0da2c2490&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x7fd0da2c28d0&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;S&#39;, &#39;G&#39;, &#39;I&#39;, &#39;PSH&#39;}, latent_variables=set(), state_variables={}, init_graph=&lt;networkx.classes.graph.Graph object at 0x7fc64a2be5d0&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x7fc64a2becd0&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x7fc64a2bf110&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 @@ -568,7 +568,7 @@ <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 1.438 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 1.331 seconds)</p>
<p><strong>Estimated memory usage:</strong> 167 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">
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/intro/inducing_path.html
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,7 @@ <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 1.524 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 1.424 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-inducing-path-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
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 @@ -585,7 +585,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, 727.52it/s]
Fitting causal mechanism of node xy: 100%|██████████| 5/5 [00:00&lt;00:00, 708.04it/s]
z xy w x y
0 1 1 1 1 1
1 1 1 2 2 3
Expand All @@ -599,7 +599,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 0x7fd0fc6a61d0&gt;
&lt;graphviz.graphs.Digraph object at 0x7fc66c486990&gt;
</pre></div>
</div>
</section>
Expand Down Expand Up @@ -686,7 +686,7 @@ <h2>Acyclic Directed Mixed Graphs (ADMG)<a class="headerlink" href="#acyclic-dir
<span class="c1"># details on causal discovery (i.e. structure learning algorithms), please see that repo.</span>
</pre></div>
</div>
<img src="../../_images/sphx_glr_intro_causal_graphs_002.png" srcset="../../_images/sphx_glr_intro_causal_graphs_002.png" alt="intro causal graphs" class = "sphx-glr-single-img"/><div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>[&#39;x&#39;, &#39;z&#39;]
<img src="../../_images/sphx_glr_intro_causal_graphs_002.png" srcset="../../_images/sphx_glr_intro_causal_graphs_002.png" alt="intro causal graphs" class = "sphx-glr-single-img"/><div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>[&#39;z&#39;, &#39;x&#39;]
The ADMG has confounded-components: [{&#39;y&#39;, &#39;x&#39;}, {&#39;z&#39;}, {&#39;w&#39;}]
&#39;z&#39; is d-separated from &#39;x&#39;: True
&#39;z&#39; is d-separated from &#39;x&#39; given &#39;y&#39;: False
Expand Down Expand Up @@ -768,7 +768,7 @@ <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.873 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 2.754 seconds)</p>
<p><strong>Estimated memory usage:</strong> 252 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">
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 @@ -429,7 +429,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:05.834</strong> total execution time for 3 files <strong>from auto_examples/intro</strong>:</p>
<p><strong>00:05.509</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 @@ -451,16 +451,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.873</p></td>
<td><p>252.1</p></td>
<td><p>00:02.754</p></td>
<td><p>252.2</p></td>
</tr>
<tr class="row-odd"><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:01.524</p></td>
<td><p>165.2</p></td>
<td><p>00:01.424</p></td>
<td><p>165.4</p></td>
</tr>
<tr class="row-even"><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:01.438</p></td>
<td><p>166.7</p></td>
<td><p>00:01.331</p></td>
<td><p>167.0</p></td>
</tr>
</tbody>
</table>
Expand Down
Loading

0 comments on commit db91a01

Please sign in to comment.