doc updates [skip ci]

py-why · Dec 19, 2023 · c6bd78d · c6bd78d
1 parent a516d20
commit c6bd78d
Show file tree

Hide file tree

Showing 21 changed files with 39 additions and 39 deletions.
diff --git a/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/dev/_images/sphx_glr_plot_mixed_edge_graph_001.png b/dev/_images/sphx_glr_plot_mixed_edge_graph_001.png
diff --git a/dev/_images/sphx_glr_plot_mixed_edge_graph_thumb.png b/dev/_images/sphx_glr_plot_mixed_edge_graph_thumb.png
diff --git a/dev/_sources/auto_examples/intro/inducing_path.rst.txt b/dev/_sources/auto_examples/intro/inducing_path.rst.txt
@@ -241,7 +241,7 @@ References
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** ( 0 minutes  1.247 seconds)
+   **Total running time of the script:** ( 0 minutes  1.180 seconds)
 
 **Estimated memory usage:**  8 MB
 

diff --git a/dev/_sources/auto_examples/intro/intro_causal_graphs.rst.txt b/dev/_sources/auto_examples/intro/intro_causal_graphs.rst.txt
@@ -168,7 +168,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, 791.41it/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, 872.14it/s]
        z  ...  y
     0  1  ...  1
     1  1  ...  3
@@ -184,7 +184,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 0x7f80fd8de9b0>
+    <graphviz.graphs.Digraph object at 0x7ff2e408b580>
 
 
 
@@ -304,8 +304,8 @@ in the graph. These unobserved confounders are graphically depicted with a bidir
 
  .. code-block:: none
 
-    ['z', 'x']
-    The ADMG has confounded-components: [{'x', 'y'}, {'z'}, {'w'}]
+    ['x', 'z']
+    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
     'z' is d-separated from 'x' after adding a bidirected edge z<->x: False
@@ -424,7 +424,7 @@ References
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** ( 0 minutes  2.666 seconds)
+   **Total running time of the script:** ( 0 minutes  2.484 seconds)
 
 **Estimated memory usage:**  33 MB
 

diff --git a/dev/_sources/auto_examples/intro/sg_execution_times.rst.txt b/dev/_sources/auto_examples/intro/sg_execution_times.rst.txt
@@ -5,10 +5,10 @@
 
 Computation times
 =================
-**00:03.913** total execution time for **auto_examples_intro** files:
+**00:03.664** total execution time for **auto_examples_intro** files:
 
 +-----------------------------------------------------------------------------------------+-----------+---------+
-| :ref:`sphx_glr_auto_examples_intro_intro_causal_graphs.py` (``intro_causal_graphs.py``) | 00:02.666 | 33.3 MB |
+| :ref:`sphx_glr_auto_examples_intro_intro_causal_graphs.py` (``intro_causal_graphs.py``) | 00:02.484 | 33.3 MB |
 +-----------------------------------------------------------------------------------------+-----------+---------+
-| :ref:`sphx_glr_auto_examples_intro_inducing_path.py` (``inducing_path.py``)             | 00:01.247 | 8.3 MB  |
+| :ref:`sphx_glr_auto_examples_intro_inducing_path.py` (``inducing_path.py``)             | 00:01.180 | 8.3 MB  |
 +-----------------------------------------------------------------------------------------+-----------+---------+
diff --git a/dev/_sources/auto_examples/mixededge/plot_mixed_edge_graph.rst.txt b/dev/_sources/auto_examples/mixededge/plot_mixed_edge_graph.rst.txt
@@ -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 0x7f81a63c5420>, 'bidirected': <networkx.classes.graph.Graph object at 0x7f81a63c5060>}
+    {'directed': <networkx.classes.digraph.DiGraph object at 0x7ff22f0bce20>, 'bidirected': <networkx.classes.graph.Graph object at 0x7ff22f0bd4e0>}
 
 
 
@@ -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: ['X', 'Y', 'Z']
     Graph has node A: False
     Now graph has node A: True
     Graph has node A: False
@@ -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.610 seconds)
+   **Total running time of the script:** ( 0 minutes  1.449 seconds)
 
 **Estimated memory usage:**  17 MB
 

diff --git a/dev/_sources/auto_examples/mixededge/sg_execution_times.rst.txt b/dev/_sources/auto_examples/mixededge/sg_execution_times.rst.txt
@@ -5,8 +5,8 @@
 
 Computation times
 =================
-**00:01.610** total execution time for **auto_examples_mixededge** files:
+**00:01.449** total execution time for **auto_examples_mixededge** files:
 
 +-------------------------------------------------------------------------------------------------+-----------+---------+
-| :ref:`sphx_glr_auto_examples_mixededge_plot_mixed_edge_graph.py` (``plot_mixed_edge_graph.py``) | 00:01.610 | 17.3 MB |
+| :ref:`sphx_glr_auto_examples_mixededge_plot_mixed_edge_graph.py` (``plot_mixed_edge_graph.py``) | 00:01.449 | 17.3 MB |
 +-------------------------------------------------------------------------------------------------+-----------+---------+
diff --git a/...es/auto_examples/visualization/draw_and_compare_graphs_with_same_layout.rst.txt b/...es/auto_examples/visualization/draw_and_compare_graphs_with_same_layout.rst.txt
@@ -139,7 +139,7 @@ such as `Dagitty <http://dagitty.net>`_.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** ( 0 minutes  0.430 seconds)
+   **Total running time of the script:** ( 0 minutes  0.408 seconds)
 
 **Estimated memory usage:**  8 MB
 

diff --git a/dev/_sources/auto_examples/visualization/plot_timeseries_graphs.rst.txt b/dev/_sources/auto_examples/visualization/plot_timeseries_graphs.rst.txt
@@ -135,7 +135,7 @@ which creates a nice default layout for time-series graphs.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** ( 0 minutes  0.954 seconds)
+   **Total running time of the script:** ( 0 minutes  0.958 seconds)
 
 **Estimated memory usage:**  8 MB
 

diff --git a/dev/_sources/auto_examples/visualization/sg_execution_times.rst.txt b/dev/_sources/auto_examples/visualization/sg_execution_times.rst.txt
@@ -5,10 +5,10 @@
 
 Computation times
 =================
-**00:01.385** total execution time for **auto_examples_visualization** files:
+**00:01.366** total execution time for **auto_examples_visualization** files:
 
 +-------------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_auto_examples_visualization_plot_timeseries_graphs.py` (``plot_timeseries_graphs.py``)                                     | 00:00.954 | 8.3 MB |
+| :ref:`sphx_glr_auto_examples_visualization_plot_timeseries_graphs.py` (``plot_timeseries_graphs.py``)                                     | 00:00.958 | 8.3 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_auto_examples_visualization_draw_and_compare_graphs_with_same_layout.py` (``draw_and_compare_graphs_with_same_layout.py``) | 00:00.430 | 8.3 MB |
+| :ref:`sphx_glr_auto_examples_visualization_draw_and_compare_graphs_with_same_layout.py` (``draw_and_compare_graphs_with_same_layout.py``) | 00:00.408 | 8.3 MB |
 +-------------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
diff --git a/dev/auto_examples/intro/inducing_path.html b/dev/auto_examples/intro/inducing_path.html
@@ -446,7 +446,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
 </aside>
 </aside>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes  1.247 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes  1.180 seconds)</p>
 <p><strong>Estimated memory usage:</strong>  8 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-python docutils container">

diff --git a/dev/auto_examples/intro/intro_causal_graphs.html b/dev/auto_examples/intro/intro_causal_graphs.html
@@ -435,7 +435,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, 791.41it/s]
+Fitting causal mechanism of node xy: 100%|##########| 5/5 [00:00&lt;00:00, 872.14it/s]
    z  ...  y
 0  1  ...  1
 1  1  ...  3
@@ -451,7 +451,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 0x7f80fd8de9b0&gt;
+&lt;graphviz.graphs.Digraph object at 0x7ff2e408b580&gt;
 </pre></div>
 </div>
 </section>
@@ -534,8 +534,8 @@ <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;z&#39;, &#39;x&#39;]
-The ADMG has confounded-components: [{&#39;x&#39;, &#39;y&#39;}, {&#39;z&#39;}, {&#39;w&#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;x&#39;, &#39;z&#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
 &#39;z&#39; is d-separated from &#39;x&#39; after adding a bidirected edge z&lt;-&gt;x: False
@@ -615,7 +615,7 @@ <h3>References<a class="headerlink" href="#references" title="Permalink to this
 </aside>
 </aside>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes  2.666 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes  2.484 seconds)</p>
 <p><strong>Estimated memory usage:</strong>  33 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-python docutils container">

diff --git a/dev/auto_examples/intro/sg_execution_times.html b/dev/auto_examples/intro/sg_execution_times.html
@@ -209,15 +209,15 @@
 
   <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="Permalink to this heading">#</a></h1>
-<p><strong>00:03.913</strong> total execution time for <strong>auto_examples_intro</strong> files:</p>
+<p><strong>00:03.664</strong> total execution time for <strong>auto_examples_intro</strong> files:</p>
 <table class="table">
 <tbody>
 <tr class="row-odd"><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.666</p></td>
+<td><p>00:02.484</p></td>
 <td><p>33.3 MB</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:01.247</p></td>
+<td><p>00:01.180</p></td>
 <td><p>8.3 MB</p></td>
 </tr>
 </tbody>

diff --git a/dev/auto_examples/mixededge/plot_mixed_edge_graph.html b/dev/auto_examples/mixededge/plot_mixed_edge_graph.html
@@ -396,7 +396,7 @@ <h2>Mixed Edge Graph Properties<a class="headerlink" href="#mixed-edge-graph-pro
 MixedEdgeGraph named &#39;IV Graph&#39; with 3 nodes and 3 edges and 2 edge types is directed: False because there are directed edges.
 False
 [&#39;directed&#39;, &#39;bidirected&#39;]
-{&#39;directed&#39;: &lt;networkx.classes.digraph.DiGraph object at 0x7f81a63c5420&gt;, &#39;bidirected&#39;: &lt;networkx.classes.graph.Graph object at 0x7f81a63c5060&gt;}
+{&#39;directed&#39;: &lt;networkx.classes.digraph.DiGraph object at 0x7ff22f0bce20&gt;, &#39;bidirected&#39;: &lt;networkx.classes.graph.Graph object at 0x7ff22f0bd4e0&gt;}
 </pre></div>
 </div>
 </section>
@@ -420,7 +420,7 @@ <h2>Mixed Edge Graph Operations on Nodes<a class="headerlink" href="#mixed-edge-
 <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Graph has node A: </span><span class="si">{</span><a href="../../generated/pywhy_graphs.networkx.MixedEdgeGraph.html#pywhy_graphs.networkx.MixedEdgeGraph.has_node" title="pywhy_graphs.networkx.MixedEdgeGraph.has_node" class="sphx-glr-backref-module-pywhy_graphs-networkx sphx-glr-backref-type-py-method"><span class="n">G</span><span class="o">.</span><span class="n">has_node</span></a><span class="p">(</span><span class="s1">&#39;A&#39;</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 </pre></div>
 </div>
-<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>MixedEdgeGraph named &#39;IV Graph&#39; with 3 nodes and 3 edges and 2 edge types has nodes: [&#39;X&#39;, &#39;Z&#39;, &#39;Y&#39;]
+<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>MixedEdgeGraph named &#39;IV Graph&#39; with 3 nodes and 3 edges and 2 edge types has nodes: [&#39;X&#39;, &#39;Y&#39;, &#39;Z&#39;]
 Graph has node A: False
 Now graph has node A: True
 Graph has node A: False
@@ -502,7 +502,7 @@ <h2>Mixed Edge Graph Key Differences<a class="headerlink" href="#mixed-edge-grap
 bidirected with degree: [(&#39;X&#39;, 1), (&#39;Y&#39;, 1), (&#39;Z&#39;, 0)]
 </pre></div>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes  1.610 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes  1.449 seconds)</p>
 <p><strong>Estimated memory usage:</strong>  17 MB</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-mixededge-plot-mixed-edge-graph-py">
 <div class="sphx-glr-download sphx-glr-download-python docutils container">

diff --git a/dev/auto_examples/mixededge/sg_execution_times.html b/dev/auto_examples/mixededge/sg_execution_times.html
@@ -209,11 +209,11 @@
 
   <section id="computation-times">
 <span id="sphx-glr-auto-examples-mixededge-sg-execution-times"></span><h1>Computation times<a class="headerlink" href="#computation-times" title="Permalink to this heading">#</a></h1>
-<p><strong>00:01.610</strong> total execution time for <strong>auto_examples_mixededge</strong> files:</p>
+<p><strong>00:01.449</strong> total execution time for <strong>auto_examples_mixededge</strong> files:</p>
 <table class="table">
 <tbody>
 <tr class="row-odd"><td><p><a class="reference internal" href="plot_mixed_edge_graph.html#sphx-glr-auto-examples-mixededge-plot-mixed-edge-graph-py"><span class="std std-ref">MixedEdgeGraph - Graph with different types of edges</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_mixed_edge_graph.py</span></code>)</p></td>
-<td><p>00:01.610</p></td>
+<td><p>00:01.449</p></td>
 <td><p>17.3 MB</p></td>
 </tr>
 </tbody>

diff --git a/dev/auto_examples/visualization/draw_and_compare_graphs_with_same_layout.html b/dev/auto_examples/visualization/draw_and_compare_graphs_with_same_layout.html
@@ -349,7 +349,7 @@
 <span class="c1"># on graphviz engines: https://graphviz.org/docs/layouts/neato/.</span>
 </pre></div>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes  0.430 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes  0.408 seconds)</p>
 <p><strong>Estimated memory usage:</strong>  8 MB</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-visualization-draw-and-compare-graphs-with-same-layout-py">
 <div class="sphx-glr-download sphx-glr-download-python docutils container">

diff --git a/dev/auto_examples/visualization/plot_timeseries_graphs.html b/dev/auto_examples/visualization/plot_timeseries_graphs.html
@@ -333,7 +333,7 @@
 &#39;G.png&#39;
 </pre></div>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes  0.954 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes  0.958 seconds)</p>
 <p><strong>Estimated memory usage:</strong>  8 MB</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-visualization-plot-timeseries-graphs-py">
 <div class="sphx-glr-download sphx-glr-download-python docutils container">

diff --git a/dev/auto_examples/visualization/sg_execution_times.html b/dev/auto_examples/visualization/sg_execution_times.html
@@ -209,15 +209,15 @@
 
   <section id="computation-times">
 <span id="sphx-glr-auto-examples-visualization-sg-execution-times"></span><h1>Computation times<a class="headerlink" href="#computation-times" title="Permalink to this heading">#</a></h1>
-<p><strong>00:01.385</strong> total execution time for <strong>auto_examples_visualization</strong> files:</p>
+<p><strong>00:01.366</strong> total execution time for <strong>auto_examples_visualization</strong> files:</p>
 <table class="table">
 <tbody>
 <tr class="row-odd"><td><p><a class="reference internal" href="plot_timeseries_graphs.html#sphx-glr-auto-examples-visualization-plot-timeseries-graphs-py"><span class="std std-ref">Drawing timeseries graphs and setting their layout</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_timeseries_graphs.py</span></code>)</p></td>
-<td><p>00:00.954</p></td>
+<td><p>00:00.958</p></td>
 <td><p>8.3 MB</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="draw_and_compare_graphs_with_same_layout.html#sphx-glr-auto-examples-visualization-draw-and-compare-graphs-with-same-layout-py"><span class="std std-ref">Drawing graphs and setting their layout for visual comparison</span></a> (<code class="docutils literal notranslate"><span class="pre">draw_and_compare_graphs_with_same_layout.py</span></code>)</p></td>
-<td><p>00:00.430</p></td>
+<td><p>00:00.408</p></td>
 <td><p>8.3 MB</p></td>
 </tr>
 </tbody>

diff --git a/dev/searchindex.js b/dev/searchindex.js