doc updates [skip ci]

dev/_sources/auto_examples/intro/checking_validity_of_a_pag.rst.txt

@@ -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={'G', 'PSH', 'S', 'I', 'L'}, latent_variables=set(), state_variables={}, init_graph=<networkx.classes.graph.Graph object at 0x7f5f5ddc3210>, included_edges=<networkx.classes.graph.Graph object at 0x7f5f5ddc3910>, excluded_edges=<networkx.classes.graph.Graph object at 0x7f5f5ddc3d50>, 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', 'PSH', 'S', 'I', 'G'}, latent_variables=set(), state_variables={}, init_graph=<networkx.classes.graph.Graph object at 0x7fa9dc927950>, included_edges=<networkx.classes.graph.Graph object at 0x7fa9dc92c090>, excluded_edges=<networkx.classes.graph.Graph object at 0x7fa9dc92c4d0>, num_distributions=1, obs_distribution=True, intervention_targets=[], symmetric_diff_map={}, sigma_map={}, f_nodes=[], num_domains=1, domain_map={}, s_nodes=[])
     True
 
 
@@ -180,7 +180,7 @@ relationship. As such, the resulting graph is no longer a valid PAG.
  .. code-block:: none
 
     ConditioningSetSelection.PDS
-    Context(observed_variables={'G', 'PSH', 'S', 'I', 'L'}, latent_variables=set(), state_variables={}, init_graph=<networkx.classes.graph.Graph object at 0x7f5f5dda7750>, included_edges=<networkx.classes.graph.Graph object at 0x7f5f5dde6810>, excluded_edges=<networkx.classes.graph.Graph object at 0x7f5f5dde7a10>, 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', 'PSH', 'S', 'I', 'G'}, latent_variables=set(), state_variables={}, init_graph=<networkx.classes.graph.Graph object at 0x7fa9dc930690>, included_edges=<networkx.classes.graph.Graph object at 0x7fa9dc930d90>, excluded_edges=<networkx.classes.graph.Graph object at 0x7fa9dc9311d0>, num_distributions=1, obs_distribution=True, intervention_targets=[], symmetric_diff_map={}, sigma_map={}, f_nodes=[], num_domains=1, domain_map={}, s_nodes=[])
     False
 
 
@@ -195,9 +195,9 @@ References
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.971 seconds)
+   **Total running time of the script:** (0 minutes 1.188 seconds)
 
-**Estimated memory usage:**  167 MB
+**Estimated memory usage:**  166 MB
 
 
 .. _sphx_glr_download_auto_examples_intro_checking_validity_of_a_pag.py:

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 0.950 seconds)
+   **Total running time of the script:** (0 minutes 1.277 seconds)
 
 **Estimated memory usage:**  165 MB
 

dev/_sources/auto_examples/intro/intro_causal_graphs.rst.txt

@@ -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, 675.35it/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, 760.61it/s]
        z  xy  w  x  y
     0  1   1  1  1  1
     1  1   1  2  2  3
@@ -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 0x7f5f5de2f4d0>
+    <graphviz.graphs.Digraph object at 0x7fa8f7b24ad0>
 
 
 
@@ -307,8 +307,8 @@ in the graph. These unobserved confounders are graphically depicted with a bidir
 
  .. code-block:: none
 
-    ['z', 'x']
-    The ADMG has confounded-components: [{'y', 'x'}, {'z'}, {'w'}]
+    ['x', 'z']
+    The ADMG has confounded-components: [{'x', 'y'}, {'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
@@ -427,9 +427,9 @@ References
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 2.392 seconds)
+   **Total running time of the script:** (0 minutes 2.632 seconds)
 
-**Estimated memory usage:**  252 MB
+**Estimated memory usage:**  251 MB
 
 
 .. _sphx_glr_download_auto_examples_intro_intro_causal_graphs.py:

dev/_sources/auto_examples/intro/sg_execution_times.rst.txt

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:04.313** total execution time for 3 files **from auto_examples/intro**:
+**00:05.096** total execution time for 3 files **from auto_examples/intro**:
 
 .. container::
 
@@ -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.392
-     - 251.7
-   * - :ref:`sphx_glr_auto_examples_intro_checking_validity_of_a_pag.py` (``checking_validity_of_a_pag.py``)
-     - 00:00.971
-     - 166.6
+     - 00:02.632
+     - 251.3
    * - :ref:`sphx_glr_auto_examples_intro_inducing_path.py` (``inducing_path.py``)
-     - 00:00.950
-     - 165.2
+     - 00:01.277
+     - 164.6
+   * - :ref:`sphx_glr_auto_examples_intro_checking_validity_of_a_pag.py` (``checking_validity_of_a_pag.py``)
+     - 00:01.188
+     - 166.1

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 0x7f5e8c138050>, 'bidirected': <networkx.classes.graph.Graph object at 0x7f5ea4a49bd0>}
+    {'directed': <networkx.classes.digraph.DiGraph object at 0x7fa9240c0d10>, 'bidirected': <networkx.classes.graph.Graph object at 0x7fa925f6f710>}
 
 
 
@@ -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
@@ -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.228 seconds)
+   **Total running time of the script:** (0 minutes 1.493 seconds)
 
 **Estimated memory usage:**  171 MB
 

dev/_sources/auto_examples/mixededge/sg_execution_times.rst.txt

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:01.228** total execution time for 1 file **from auto_examples/mixededge**:
+**00:01.493** total execution time for 1 file **from auto_examples/mixededge**:
 
 .. container::
 
@@ -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.228
-     - 171.4
+     - 00:01.493
+     - 171.0

dev/_sources/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.387 seconds)
+   **Total running time of the script:** (0 minutes 0.425 seconds)
 
 **Estimated memory usage:**  165 MB
 

dev/_sources/auto_examples/visualization/plot_timeseries_graphs.rst.txt

@@ -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 0.929 seconds)
+   **Total running time of the script:** (0 minutes 1.157 seconds)
 
 **Estimated memory usage:**  165 MB
 

dev/_sources/auto_examples/visualization/sg_execution_times.rst.txt

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:01.315** total execution time for 2 files **from auto_examples/visualization**:
+**00:01.581** total execution time for 2 files **from auto_examples/visualization**:
 
 .. container::
 
@@ -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.929
-     - 165.2
+     - 00:01.157
+     - 164.5
    * - :ref:`sphx_glr_auto_examples_visualization_draw_and_compare_graphs_with_same_layout.py` (``draw_and_compare_graphs_with_same_layout.py``)
-     - 00:00.387
-     - 165.2
+     - 00:00.425
+     - 164.5

dev/_sources/sg_execution_times.rst.txt

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:06.857** total execution time for 6 files **from all galleries**:
+**00:08.171** total execution time for 6 files **from all galleries**:
 
 .. container::
 
@@ -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.392
-     - 251.7
+     - 00:02.632
+     - 251.3
    * - :ref:`sphx_glr_auto_examples_mixededge_plot_mixed_edge_graph.py` (``../examples/mixededge/plot_mixed_edge_graph.py``)
-     - 00:01.228
-     - 171.4
-   * - :ref:`sphx_glr_auto_examples_intro_checking_validity_of_a_pag.py` (``../examples/intro/checking_validity_of_a_pag.py``)
-     - 00:00.971
-     - 166.6
+     - 00:01.493
+     - 171.0
    * - :ref:`sphx_glr_auto_examples_intro_inducing_path.py` (``../examples/intro/inducing_path.py``)
-     - 00:00.950
-     - 165.2
+     - 00:01.277
+     - 164.6
+   * - :ref:`sphx_glr_auto_examples_intro_checking_validity_of_a_pag.py` (``../examples/intro/checking_validity_of_a_pag.py``)
+     - 00:01.188
+     - 166.1
    * - :ref:`sphx_glr_auto_examples_visualization_plot_timeseries_graphs.py` (``../examples/visualization/plot_timeseries_graphs.py``)
-     - 00:00.929
-     - 165.2
+     - 00:01.157
+     - 164.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.387
-     - 165.2
+     - 00:00.425
+     - 164.5

dev/auto_examples/intro/checking_validity_of_a_pag.html

@@ -566,7 +566,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;G&#39;, &#39;PSH&#39;, &#39;S&#39;, &#39;I&#39;, &#39;L&#39;}, latent_variables=set(), state_variables={}, init_graph=&lt;networkx.classes.graph.Graph object at 0x7f5f5ddc3210&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x7f5f5ddc3910&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x7f5f5ddc3d50&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;PSH&#39;, &#39;S&#39;, &#39;I&#39;, &#39;G&#39;}, latent_variables=set(), state_variables={}, init_graph=&lt;networkx.classes.graph.Graph object at 0x7fa9dc927950&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x7fa9dc92c090&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x7fa9dc92c4d0&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>
@@ -585,7 +585,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;G&#39;, &#39;PSH&#39;, &#39;S&#39;, &#39;I&#39;, &#39;L&#39;}, latent_variables=set(), state_variables={}, init_graph=&lt;networkx.classes.graph.Graph object at 0x7f5f5dda7750&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x7f5f5dde6810&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x7f5f5dde7a10&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;PSH&#39;, &#39;S&#39;, &#39;I&#39;, &#39;G&#39;}, latent_variables=set(), state_variables={}, init_graph=&lt;networkx.classes.graph.Graph object at 0x7fa9dc930690&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x7fa9dc930d90&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x7fa9dc9311d0&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>
@@ -601,8 +601,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.971 seconds)</p>
-<p><strong>Estimated memory usage:</strong>  167 MB</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 1.188 seconds)</p>
+<p><strong>Estimated memory usage:</strong>  166 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>

dev/auto_examples/intro/inducing_path.html

@@ -637,7 +637,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 0.950 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 1.277 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">

dev/auto_examples/intro/intro_causal_graphs.html

@@ -618,7 +618,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, 675.35it/s]
+Fitting causal mechanism of node xy: 100%|██████████| 5/5 [00:00&lt;00:00, 760.61it/s]
    z  xy  w  x  y
 0  1   1  1  1  1
 1  1   1  2  2  3
@@ -632,7 +632,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 0x7f5f5de2f4d0&gt;
+&lt;graphviz.graphs.Digraph object at 0x7fa8f7b24ad0&gt;
 </pre></div>
 </div>
 </section>
@@ -719,8 +719,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;y&#39;, &#39;x&#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;x&#39;, &#39;y&#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
@@ -801,8 +801,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.392 seconds)</p>
-<p><strong>Estimated memory usage:</strong>  252 MB</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 2.632 seconds)</p>
+<p><strong>Estimated memory usage:</strong>  251 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>