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={'L', 'I', 'PSH', 'G', 'S'}, latent_variables=set(), state_variables={}, init_graph=<networkx.classes.graph.Graph object at 0x7f1044a99950>, included_edges=<networkx.classes.graph.Graph object at 0x7f1044a9a050>, excluded_edges=<networkx.classes.graph.Graph object at 0x7f1044a9a490>, 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 0x7fa38092d9d0>, included_edges=<networkx.classes.graph.Graph object at 0x7fa38092e0d0>, excluded_edges=<networkx.classes.graph.Graph object at 0x7fa38092e510>, 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={'L', 'I', 'PSH', 'G', 'S'}, latent_variables=set(), state_variables={}, init_graph=<networkx.classes.graph.Graph object at 0x7f1044aadf10>, included_edges=<networkx.classes.graph.Graph object at 0x7f1044aae610>, excluded_edges=<networkx.classes.graph.Graph object at 0x7f1044aaea50>, 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 0x7fa380942010>, included_edges=<networkx.classes.graph.Graph object at 0x7fa380942710>, excluded_edges=<networkx.classes.graph.Graph object at 0x7fa380942b50>, num_distributions=1, obs_distribution=True, intervention_targets=[], symmetric_diff_map={}, sigma_map={}, f_nodes=[], num_domains=1, domain_map={}, s_nodes=[])
     False
 
 
@@ -195,7 +195,7 @@ References
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 1.110 seconds)
+   **Total running time of the script:** (0 minutes 1.284 seconds)
 
 **Estimated memory usage:**  166 MB
 

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.986 seconds)
+   **Total running time of the script:** (0 minutes 1.320 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, 804.59it/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, 756.30it/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 0x7f1044cf23d0>
+    <graphviz.graphs.Digraph object at 0x7fa380b83850>
 
 
 
@@ -427,7 +427,7 @@ References
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 2.148 seconds)
+   **Total running time of the script:** (0 minutes 2.774 seconds)
 
 **Estimated memory usage:**  251 MB
 

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

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:04.244** total execution time for 3 files **from auto_examples/intro**:
+**00:05.378** 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.148
-     - 251.5
-   * - :ref:`sphx_glr_auto_examples_intro_checking_validity_of_a_pag.py` (``checking_validity_of_a_pag.py``)
-     - 00:01.110
-     - 166.3
+     - 00:02.774
+     - 251.2
    * - :ref:`sphx_glr_auto_examples_intro_inducing_path.py` (``inducing_path.py``)
-     - 00:00.986
-     - 164.8
+     - 00:01.320
+     - 164.9
+   * - :ref:`sphx_glr_auto_examples_intro_checking_validity_of_a_pag.py` (``checking_validity_of_a_pag.py``)
+     - 00:01.284
+     - 166.5

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 0x7f105a72bdd0>, 'bidirected': <networkx.classes.graph.Graph object at 0x7f111725fa90>}
+    {'directed': <networkx.classes.digraph.DiGraph object at 0x7fa392c2dad0>, 'bidirected': <networkx.classes.graph.Graph object at 0x7fa3926d7890>}
 
 
 
@@ -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: ['Z', 'Y', 'X']
     Graph has node A: False
     Now graph has node A: True
     Graph has node A: False
@@ -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.184 seconds)
+   **Total running time of the script:** (0 minutes 1.468 seconds)
 
-**Estimated memory usage:**  171 MB
+**Estimated memory usage:**  172 MB
 
 
 .. _sphx_glr_download_auto_examples_mixededge_plot_mixed_edge_graph.py:

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

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:01.184** total execution time for 1 file **from auto_examples/mixededge**:
+**00:01.468** 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.184
-     - 171.3
+     - 00:01.468
+     - 171.6

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.418 seconds)
+   **Total running time of the script:** (0 minutes 0.516 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.957 seconds)
+   **Total running time of the script:** (0 minutes 1.131 seconds)
 
 **Estimated memory usage:**  165 MB
 

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

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:01.376** total execution time for 2 files **from auto_examples/visualization**:
+**00:01.647** 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.957
-     - 164.8
+     - 00:01.131
+     - 164.9
    * - :ref:`sphx_glr_auto_examples_visualization_draw_and_compare_graphs_with_same_layout.py` (``draw_and_compare_graphs_with_same_layout.py``)
-     - 00:00.418
-     - 164.8
+     - 00:00.516
+     - 164.9

dev/_sources/sg_execution_times.rst.txt

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:06.804** total execution time for 6 files **from all galleries**:
+**00:08.493** 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.148
-     - 251.5
+     - 00:02.774
+     - 251.2
    * - :ref:`sphx_glr_auto_examples_mixededge_plot_mixed_edge_graph.py` (``../examples/mixededge/plot_mixed_edge_graph.py``)
-     - 00:01.184
-     - 171.3
-   * - :ref:`sphx_glr_auto_examples_intro_checking_validity_of_a_pag.py` (``../examples/intro/checking_validity_of_a_pag.py``)
-     - 00:01.110
-     - 166.3
+     - 00:01.468
+     - 171.6
    * - :ref:`sphx_glr_auto_examples_intro_inducing_path.py` (``../examples/intro/inducing_path.py``)
-     - 00:00.986
-     - 164.8
+     - 00:01.320
+     - 164.9
+   * - :ref:`sphx_glr_auto_examples_intro_checking_validity_of_a_pag.py` (``../examples/intro/checking_validity_of_a_pag.py``)
+     - 00:01.284
+     - 166.5
    * - :ref:`sphx_glr_auto_examples_visualization_plot_timeseries_graphs.py` (``../examples/visualization/plot_timeseries_graphs.py``)
-     - 00:00.957
-     - 164.8
+     - 00:01.131
+     - 164.9
    * - :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.418
-     - 164.8
+     - 00:00.516
+     - 164.9

dev/auto_examples/intro/checking_validity_of_a_pag.html

@@ -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;L&#39;, &#39;I&#39;, &#39;PSH&#39;, &#39;G&#39;, &#39;S&#39;}, latent_variables=set(), state_variables={}, init_graph=&lt;networkx.classes.graph.Graph object at 0x7f1044a99950&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x7f1044a9a050&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x7f1044a9a490&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 0x7fa38092d9d0&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x7fa38092e0d0&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x7fa38092e510&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>
@@ -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;L&#39;, &#39;I&#39;, &#39;PSH&#39;, &#39;G&#39;, &#39;S&#39;}, latent_variables=set(), state_variables={}, init_graph=&lt;networkx.classes.graph.Graph object at 0x7f1044aadf10&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x7f1044aae610&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x7f1044aaea50&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 0x7fa380942010&gt;, included_edges=&lt;networkx.classes.graph.Graph object at 0x7fa380942710&gt;, excluded_edges=&lt;networkx.classes.graph.Graph object at 0x7fa380942b50&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>
@@ -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.110 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 1.284 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">

dev/auto_examples/intro/inducing_path.html

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

@@ -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, 804.59it/s]
+Fitting causal mechanism of node xy: 100%|██████████| 5/5 [00:00&lt;00:00, 756.30it/s]
    z  xy  w  x  y
 0  1   1  1  1  1
 1  1   1  2  2  3
@@ -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 0x7f1044cf23d0&gt;
+&lt;graphviz.graphs.Digraph object at 0x7fa380b83850&gt;
 </pre></div>
 </div>
 </section>
@@ -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.148 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 2.774 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">

dev/auto_examples/intro/sg_execution_times.html

@@ -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:04.244</strong> total execution time for 3 files <strong>from auto_examples/intro</strong>:</p>
+<p><strong>00:05.378</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" />
@@ -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.148</p></td>
-<td><p>251.5</p></td>
+<td><p>00:02.774</p></td>
+<td><p>251.2</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:01.110</p></td>
-<td><p>166.3</p></td>
+<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.320</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.986</p></td>
-<td><p>164.8</p></td>
+<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.284</p></td>
+<td><p>166.5</p></td>
 </tr>
 </tbody>
 </table>