Updated documentation

iuliivasilev · Dec 1, 2024 · c64bc6a · c64bc6a
1 parent af4df29
commit c64bc6a
Show file tree

Hide file tree

Showing 48 changed files with 996 additions and 516 deletions.
diff --git a/docs/_build/doctrees/auto_examples/index.doctree b/docs/_build/doctrees/auto_examples/index.doctree
diff --git a/docs/_build/doctrees/auto_examples/sg_execution_times.doctree b/docs/_build/doctrees/auto_examples/sg_execution_times.doctree
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/doctrees/modules/Experiments.doctree b/docs/_build/doctrees/modules/Experiments.doctree
diff --git a/docs/_build/doctrees/modules/External.doctree b/docs/_build/doctrees/modules/External.doctree
diff --git a/docs/_build/doctrees/modules/Metrics.doctree b/docs/_build/doctrees/modules/Metrics.doctree
diff --git a/docs/_build/doctrees/modules/Tree.doctree b/docs/_build/doctrees/modules/Tree.doctree
diff --git a/docs/_build/doctrees/sg_execution_times.doctree b/docs/_build/doctrees/sg_execution_times.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: 8ebcdd3a94cc8c783fb6bee52f77602b
+config: 19038d3bb86d3a352ec79e7137dca909
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/API Reference.html b/docs/_build/html/API Reference.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>API Reference &mdash; survivors 1.7.0 documentation</title>
+  <title>API Reference &mdash; survivors 1.7.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=61a4c737" />
@@ -19,7 +19,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=030dc6f6"></script>
+        <script src="_static/documentation_options.js?v=a77542ef"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -70,6 +70,11 @@
 <li class="toctree-l1"><a class="reference internal" href="Why.html">Why survivors?</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Citing.html">Citing survivors</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="auto_examples/plot_experiments_guide.html">Experiments guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="auto_examples/plot_user_guide.html">Base User guide</a></li>
 </ul>
 
         </div>
@@ -112,11 +117,22 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this
 <li class="toctree-l1"><a class="reference internal" href="modules/Metrics.html">Metrics</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.DESCEND_METRICS"><code class="docutils literal notranslate"><span class="pre">DESCEND_METRICS</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.METRIC_DICT"><code class="docutils literal notranslate"><span class="pre">METRIC_DICT</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.bal_ibs"><code class="docutils literal notranslate"><span class="pre">bal_ibs()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.bal_ibs_WW"><code class="docutils literal notranslate"><span class="pre">bal_ibs_WW()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.bal_ibs_remain"><code class="docutils literal notranslate"><span class="pre">bal_ibs_remain()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.concordance_index"><code class="docutils literal notranslate"><span class="pre">concordance_index()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.get_hazard_func"><code class="docutils literal notranslate"><span class="pre">get_hazard_func()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.get_survival_func"><code class="docutils literal notranslate"><span class="pre">get_survival_func()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.iauc"><code class="docutils literal notranslate"><span class="pre">iauc()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.iauc_TI"><code class="docutils literal notranslate"><span class="pre">iauc_TI()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.iauc_WW"><code class="docutils literal notranslate"><span class="pre">iauc_WW()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.iauc_WW_TI"><code class="docutils literal notranslate"><span class="pre">iauc_WW_TI()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.ibs"><code class="docutils literal notranslate"><span class="pre">ibs()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.ibs_WW"><code class="docutils literal notranslate"><span class="pre">ibs_WW()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.ibs_remain"><code class="docutils literal notranslate"><span class="pre">ibs_remain()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.ipa"><code class="docutils literal notranslate"><span class="pre">ipa()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.kl"><code class="docutils literal notranslate"><span class="pre">kl()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html#survivors.metrics.loglikelihood"><code class="docutils literal notranslate"><span class="pre">loglikelihood()</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="modules/Criteria.html">Criteria</a><ul>

diff --git a/docs/_build/html/AboutSA.html b/docs/_build/html/AboutSA.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>About Survival Analysis &mdash; survivors 1.7.0 documentation</title>
+  <title>About Survival Analysis &mdash; survivors 1.7.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=61a4c737" />
@@ -19,7 +19,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=030dc6f6"></script>
+        <script src="_static/documentation_options.js?v=a77542ef"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -59,6 +59,11 @@
 <li class="toctree-l1"><a class="reference internal" href="Why.html">Why survivors?</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Citing.html">Citing survivors</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="auto_examples/plot_experiments_guide.html">Experiments guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="auto_examples/plot_user_guide.html">Base User guide</a></li>
 </ul>
 
         </div>

diff --git a/docs/_build/html/Citing.html b/docs/_build/html/Citing.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Citing survivors &mdash; survivors 1.7.0 documentation</title>
+  <title>Citing survivors &mdash; survivors 1.7.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=61a4c737" />
@@ -19,12 +19,13 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=030dc6f6"></script>
+        <script src="_static/documentation_options.js?v=a77542ef"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="Experiments guide" href="auto_examples/plot_experiments_guide.html" />
     <link rel="prev" title="Installation" href="Installation.html" /> 
 </head>
 
@@ -58,6 +59,11 @@
 <li class="toctree-l1"><a class="reference internal" href="Why.html">Why survivors?</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Installation.html">Installation</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Citing survivors</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="auto_examples/plot_experiments_guide.html">Experiments guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="auto_examples/plot_user_guide.html">Base User guide</a></li>
 </ul>
 
         </div>
@@ -123,6 +129,7 @@ <h1>Citing survivors<a class="headerlink" href="#citing-survivors" title="Link t
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="Installation.html" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="auto_examples/plot_experiments_guide.html" class="btn btn-neutral float-right" title="Experiments guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

diff --git a/docs/_build/html/Component description.html b/docs/_build/html/Component description.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Component description &mdash; survivors 1.7.0 documentation</title>
+  <title>Component description &mdash; survivors 1.7.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=61a4c737" />
@@ -19,7 +19,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=030dc6f6"></script>
+        <script src="_static/documentation_options.js?v=a77542ef"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -59,6 +59,11 @@
 <li class="toctree-l1"><a class="reference internal" href="Why.html">Why survivors?</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Citing.html">Citing survivors</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="auto_examples/plot_experiments_guide.html">Experiments guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="auto_examples/plot_user_guide.html">Base User guide</a></li>
 </ul>
 
         </div>

diff --git a/docs/_build/html/Installation.html b/docs/_build/html/Installation.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Installation &mdash; survivors 1.7.0 documentation</title>
+  <title>Installation &mdash; survivors 1.7.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=61a4c737" />
@@ -19,7 +19,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=030dc6f6"></script>
+        <script src="_static/documentation_options.js?v=a77542ef"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -59,6 +59,11 @@
 <li class="toctree-l1"><a class="reference internal" href="Why.html">Why survivors?</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Citing.html">Citing survivors</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="auto_examples/plot_experiments_guide.html">Experiments guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="auto_examples/plot_user_guide.html">Base User guide</a></li>
 </ul>
 
         </div>

diff --git a/docs/_build/html/Why.html b/docs/_build/html/Why.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Why survivors? &mdash; survivors 1.7.0 documentation</title>
+  <title>Why survivors? &mdash; survivors 1.7.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=61a4c737" />
@@ -19,7 +19,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=030dc6f6"></script>
+        <script src="_static/documentation_options.js?v=a77542ef"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -59,6 +59,11 @@
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Why survivors?</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Citing.html">Citing survivors</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="auto_examples/plot_experiments_guide.html">Experiments guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="auto_examples/plot_user_guide.html">Base User guide</a></li>
 </ul>
 
         </div>

diff --git a/docs/_build/html/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/docs/_build/html/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/docs/_build/html/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/docs/_build/html/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip