edited docstrings

jakobrunge · Feb 23, 2022 · 1674c12 · 1674c12
1 parent caac5da
commit 1674c12
Show file tree

Hide file tree

Showing 146 changed files with 30,728 additions and 7,939 deletions.
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ Tigramite is a causal time series analysis python package. It allows to efficien
 - Mediation class: J. Runge et al. (2015): Identifying causal gateways and mediators in complex spatio-temporal systems. Nature Communications, 6, 8502. http://doi.org/10.1038/ncomms9502
 - Mediation class: J. Runge (2015): Quantifying information transfer and mediation along causal pathways in complex systems. Phys. Rev. E, 92(6), 62829. http://doi.org/10.1103/PhysRevE.92.062829
 - CMIknn: J. Runge (2018): Conditional Independence Testing Based on a Nearest-Neighbor Estimator of Conditional Mutual Information. In Proceedings of the 21st International Conference on Artificial Intelligence and Statistics. http://proceedings.mlr.press/v84/runge18a.html
-- J. Runge, Necessary and sufficient graphical conditions for optimal adjustment sets in causal graphical models with hidden variables, Advances in Neural Information Processing Systems, 2021, 34
+- J. Runge, Necessary and sufficient graphical conditions for optimal adjustment sets in causal graphical models with hidden variables, Advances in Neural Information Processing Systems, 2021, 34. https://proceedings.neurips.cc/paper/2021/hash/8485ae387a981d783f8764e508151cd9-Abstract.html
 
 ## Features
 
@@ -54,7 +54,7 @@ Tigramite is a causal time series analysis python package. It allows to efficien
 - parallel computing script based on mpi4py
 - handling of missing values and masks
 - p-value correction and confidence interval estimation
-- causal effect class to  non-parametrically estimate (conditional) causal effects and also mediated causal effects
+- causal effect class to  non-parametrically estimate (conditional) causal effects and also linear mediated causal effects
 - prediction class based on sklearn models including causal feature selection
 - GUI covering basic functionality on https://github.com/stbachinger/TigramiteGui
 
@@ -66,12 +66,12 @@ Tigramite is a causal time series analysis python package. It allows to efficien
 - scipy
 - numba
 
-## Optional packages depending on the test
+## Optional packages depending on used functions
 - scikit-learn>=0.21  # Gaussian Process (GP) Regression
 - matplotlib>=3.4.0   # Plotting
 - networkx>=2.4       # Plotting
 - torch>=1.7          # GPDC torch version
-- gpytorch>=1.4       # GPDC gpytorch version
+- gpytorch>=1.4       # GPDC torch version
 - dcor>=0.5.3         # GPDC distance correlation version
 
 ## Installation

diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: b9995aa6748323a52a5ac5eca19ee0a4
+config: 37032d0f981cb98fc486692370ccb5c1
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_images/math/04effbe50a9c1421627153afe77c1c013193dd90.png b/docs/_build/html/_images/math/04effbe50a9c1421627153afe77c1c013193dd90.png
diff --git a/docs/_build/html/_images/math/15af846e07c93e1c0d4cdbba8f4cefca67a811cb.png b/docs/_build/html/_images/math/15af846e07c93e1c0d4cdbba8f4cefca67a811cb.png
diff --git a/docs/_build/html/_images/math/1a2da53015c9d2f2c52257723f812bf512b6818e.png b/docs/_build/html/_images/math/1a2da53015c9d2f2c52257723f812bf512b6818e.png
diff --git a/docs/_build/html/_images/math/1b5e577d6216dca3af7d87aa122a0b9b360d6cb3.png b/docs/_build/html/_images/math/1b5e577d6216dca3af7d87aa122a0b9b360d6cb3.png
diff --git a/docs/_build/html/_images/math/20582dab63cb7f6604f5bf70224030ad3411ae16.png b/docs/_build/html/_images/math/20582dab63cb7f6604f5bf70224030ad3411ae16.png
diff --git a/docs/_build/html/_images/math/26b09a13f97c2e89eb7687980b95a54839775fc8.png b/docs/_build/html/_images/math/26b09a13f97c2e89eb7687980b95a54839775fc8.png
diff --git a/docs/_build/html/_images/math/2882aa5d9b56c4f42679de5f902a74d8ae88a624.png b/docs/_build/html/_images/math/2882aa5d9b56c4f42679de5f902a74d8ae88a624.png
diff --git a/docs/_build/html/_images/math/2bf86ca220f43e569c6c7aefaf32742919222e6e.png b/docs/_build/html/_images/math/2bf86ca220f43e569c6c7aefaf32742919222e6e.png
diff --git a/docs/_build/html/_images/math/2f5aa019312e1bbc969deab8dca8b00f76025404.png b/docs/_build/html/_images/math/2f5aa019312e1bbc969deab8dca8b00f76025404.png
diff --git a/docs/_build/html/_images/math/42858b59a7270363c15ca14b0d5fc56d33af1f8a.png b/docs/_build/html/_images/math/42858b59a7270363c15ca14b0d5fc56d33af1f8a.png
diff --git a/docs/_build/html/_images/math/5406eadc281dbd20de843b0034c8497320dae5cb.png b/docs/_build/html/_images/math/5406eadc281dbd20de843b0034c8497320dae5cb.png
diff --git a/docs/_build/html/_images/math/5aa339d4daf45a810dda332e3c80a0698e526e04.png b/docs/_build/html/_images/math/5aa339d4daf45a810dda332e3c80a0698e526e04.png
diff --git a/docs/_build/html/_images/math/5f8c562c89b6bf12d27dc6cdc9dc090f7bb78e9c.png b/docs/_build/html/_images/math/5f8c562c89b6bf12d27dc6cdc9dc090f7bb78e9c.png
diff --git a/docs/_build/html/_images/math/64932505aadaa1eac6316ff09c2c3b101b068168.png b/docs/_build/html/_images/math/64932505aadaa1eac6316ff09c2c3b101b068168.png
diff --git a/docs/_build/html/_images/math/667eda4bf3d5ce33b6cc785cadfef79bb95741ca.png b/docs/_build/html/_images/math/667eda4bf3d5ce33b6cc785cadfef79bb95741ca.png
diff --git a/docs/_build/html/_images/math/6ecffdf6c6b31ddba452a834568233441411465b.png b/docs/_build/html/_images/math/6ecffdf6c6b31ddba452a834568233441411465b.png
diff --git a/docs/_build/html/_images/math/789735c1db036ea36cd0aa25a3af4b2528ed3abe.png b/docs/_build/html/_images/math/789735c1db036ea36cd0aa25a3af4b2528ed3abe.png
diff --git a/docs/_build/html/_images/math/78b6e77cc610bf56f5c64cb6dcc6d6ee49f886f9.png b/docs/_build/html/_images/math/78b6e77cc610bf56f5c64cb6dcc6d6ee49f886f9.png
diff --git a/docs/_build/html/_images/math/7b5b384bfd47bd6e8d707b3189aaab3a46c5ed04.png b/docs/_build/html/_images/math/7b5b384bfd47bd6e8d707b3189aaab3a46c5ed04.png
diff --git a/docs/_build/html/_images/math/7daf0d4815e763eb90f0d5f1dc406f668c1e21db.png b/docs/_build/html/_images/math/7daf0d4815e763eb90f0d5f1dc406f668c1e21db.png
diff --git a/docs/_build/html/_images/math/914b2d4b6659b86d3153d5510839dfb254dfc8a3.png b/docs/_build/html/_images/math/914b2d4b6659b86d3153d5510839dfb254dfc8a3.png
diff --git a/docs/_build/html/_images/math/95f028ab2b20b895fa12d986e0d9f40f7b6e52d3.png b/docs/_build/html/_images/math/95f028ab2b20b895fa12d986e0d9f40f7b6e52d3.png
diff --git a/docs/_build/html/_images/math/9630132210b904754c9ab272b61cb527d12263ca.png b/docs/_build/html/_images/math/9630132210b904754c9ab272b61cb527d12263ca.png
diff --git a/docs/_build/html/_images/math/9c353382eebb42a8a9dec3a426d346d4842bd39d.png b/docs/_build/html/_images/math/9c353382eebb42a8a9dec3a426d346d4842bd39d.png
diff --git a/docs/_build/html/_images/math/ab9afdaf786ce53318d75d81f050af8560822fcd.png b/docs/_build/html/_images/math/ab9afdaf786ce53318d75d81f050af8560822fcd.png
diff --git a/docs/_build/html/_images/math/b62df33f46595ed60c51f255186ee346c1fcc0cb.png b/docs/_build/html/_images/math/b62df33f46595ed60c51f255186ee346c1fcc0cb.png
diff --git a/docs/_build/html/_images/math/b6c245d487949782a89cab9ee83504a62fdc2337.png b/docs/_build/html/_images/math/b6c245d487949782a89cab9ee83504a62fdc2337.png
diff --git a/docs/_build/html/_images/math/be07aa32325c7a6161c0cef04f9b702054873211.png b/docs/_build/html/_images/math/be07aa32325c7a6161c0cef04f9b702054873211.png
diff --git a/docs/_build/html/_images/math/be38eb4004ec8179f569f36692f9132289acf8b1.png b/docs/_build/html/_images/math/be38eb4004ec8179f569f36692f9132289acf8b1.png
diff --git a/docs/_build/html/_images/math/c0d0f97cd9bb4e6571e2689163f9f2989b304f55.png b/docs/_build/html/_images/math/c0d0f97cd9bb4e6571e2689163f9f2989b304f55.png
diff --git a/docs/_build/html/_images/math/c4ed4f54ee00448249d2df22ad67f3e281df085b.png b/docs/_build/html/_images/math/c4ed4f54ee00448249d2df22ad67f3e281df085b.png
diff --git a/docs/_build/html/_images/math/c67734af70861b2bd4dedf5c41c9aad231466f84.png b/docs/_build/html/_images/math/c67734af70861b2bd4dedf5c41c9aad231466f84.png
diff --git a/docs/_build/html/_images/math/d226d17c031c4b264fb8f59f953381951cc2e9b4.png b/docs/_build/html/_images/math/d226d17c031c4b264fb8f59f953381951cc2e9b4.png
diff --git a/docs/_build/html/_images/math/d4ac9b60213cb2ffe02c6d5dacac8796221c73ac.png b/docs/_build/html/_images/math/d4ac9b60213cb2ffe02c6d5dacac8796221c73ac.png
diff --git a/docs/_build/html/_images/math/d8ee85ac4d75924cdf4b18f5fb3b46550932fc26.png b/docs/_build/html/_images/math/d8ee85ac4d75924cdf4b18f5fb3b46550932fc26.png
diff --git a/docs/_build/html/_images/math/db3d34854a6f48587cf5b9a41df90ad1c5e332d6.png b/docs/_build/html/_images/math/db3d34854a6f48587cf5b9a41df90ad1c5e332d6.png
diff --git a/docs/_build/html/_images/math/e3fc28292267f066fee7718c64f4bbfece521f24.png b/docs/_build/html/_images/math/e3fc28292267f066fee7718c64f4bbfece521f24.png
diff --git a/docs/_build/html/_images/math/e676f7877e03a3707387149ce203c5e79ed8f9a9.png b/docs/_build/html/_images/math/e676f7877e03a3707387149ce203c5e79ed8f9a9.png
diff --git a/docs/_build/html/_images/math/ed38fa24f1c94891bd312012aab3f6673be3eb83.png b/docs/_build/html/_images/math/ed38fa24f1c94891bd312012aab3f6673be3eb83.png
diff --git a/docs/_build/html/_images/math/f852990c4a225a95d2c694a9f1351f54bac3ba86.png b/docs/_build/html/_images/math/f852990c4a225a95d2c694a9f1351f54bac3ba86.png
diff --git a/docs/_build/html/_images/math/fff7b4153a6590df59f8ed526be56220045b7f3b.png b/docs/_build/html/_images/math/fff7b4153a6590df59f8ed526be56220045b7f3b.png
diff --git a/docs/_build/html/_modules/abc.html b/docs/_build/html/_modules/abc.html
diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html
@@ -1,30 +1,21 @@
 
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
 
-<html xmlns="http://www.w3.org/1999/xhtml">
+<html>
   <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Overview: module code &#8212; Tigramite 5.0 documentation</title>
     <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '../',
-        VERSION:     '5.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
-    <script type="text/javascript" src="../_static/jquery.js"></script>
-    <script type="text/javascript" src="../_static/underscore.js"></script>
-    <script type="text/javascript" src="../_static/doctools.js"></script>
+    <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+    <script src="../_static/jquery.js"></script>
+    <script src="../_static/underscore.js"></script>
+    <script src="../_static/doctools.js"></script>
+    <script src="../_static/language_data.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" /> 
-  </head>
-  <body>
+  </head><body>
     <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
@@ -34,23 +25,10 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Tigramite 5.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="../index.html">Tigramite 5.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li> 
       </ul>
-    </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper">
-<div id="searchbox" style="display: none" role="search">
-  <h3>Quick search</h3>
-    <form class="search" action="../search.html" method="get">
-      <div><input type="text" name="q" /></div>
-      <div><input type="submit" value="Go" /></div>
-      <input type="hidden" name="check_keywords" value="yes" />
-      <input type="hidden" name="area" value="default" />
-    </form>
-</div>
-<script type="text/javascript">$('#searchbox').show(0);</script>
-        </div>
-      </div>
+    </div>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -72,11 +50,27 @@ <h1>All modules for which code is available</h1>
 <li><a href="tigramite/models.html">tigramite.models</a></li>
 <li><a href="tigramite/pcmci.html">tigramite.pcmci</a></li>
 <li><a href="tigramite/plotting.html">tigramite.plotting</a></li>
+<li><a href="tigramite/toymodels/structural_causal_processes.html">tigramite.toymodels.structural_causal_processes</a></li>
 </ul>
 
+            <div class="clearer"></div>
           </div>
         </div>
       </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" />
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>$('#searchbox').show(0);</script>
+        </div>
+      </div>
       <div class="clearer"></div>
     </div>
     <div class="related" role="navigation" aria-label="related navigation">
@@ -88,12 +82,13 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Tigramite 5.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="../index.html">Tigramite 5.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2021, Jakob Runge.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
     </div>
   </body>
 </html>