updated the docs

MEDomics-UdeS · Jul 2, 2024 · c1fed4d · c1fed4d
1 parent df4a140
commit c1fed4d
Show file tree

Hide file tree

Showing 71 changed files with 1,025 additions and 320 deletions.
diff --git a/...ild/html/_sources/det3pa.datasets.rst.txt → docs/MED3pa.datasets.rst b/...ild/html/_sources/det3pa.datasets.rst.txt → docs/MED3pa.datasets.rst
diff --git a/docs/det3pa.detectron.rst → docs/MED3pa.detectron.rst b/docs/det3pa.detectron.rst → docs/MED3pa.detectron.rst
diff --git a/...build/html/_sources/det3pa.med3pa.rst.txt → docs/MED3pa.med3pa.rst b/...build/html/_sources/det3pa.med3pa.rst.txt → docs/MED3pa.med3pa.rst
diff --git a/...build/html/_sources/det3pa.models.rst.txt → docs/MED3pa.models.rst b/...build/html/_sources/det3pa.models.rst.txt → docs/MED3pa.models.rst
diff --git a/docs/_build/html/_sources/det3pa.rst.txt → docs/MED3pa.rst b/docs/_build/html/_sources/det3pa.rst.txt → docs/MED3pa.rst
diff --git a/docs/_build/doctrees/det3pa.datasets.doctree → docs/_build/doctrees/MED3pa.datasets.doctree b/docs/_build/doctrees/det3pa.datasets.doctree → docs/_build/doctrees/MED3pa.datasets.doctree
diff --git a/.../_build/doctrees/det3pa.detectron.doctree → .../_build/doctrees/MED3pa.detectron.doctree b/.../_build/doctrees/det3pa.detectron.doctree → .../_build/doctrees/MED3pa.detectron.doctree
diff --git a/docs/_build/doctrees/det3pa.doctree → docs/_build/doctrees/MED3pa.doctree b/docs/_build/doctrees/det3pa.doctree → docs/_build/doctrees/MED3pa.doctree
diff --git a/docs/_build/doctrees/MED3pa.med3pa.doctree b/docs/_build/doctrees/MED3pa.med3pa.doctree
diff --git a/docs/_build/doctrees/det3pa.models.doctree → docs/_build/doctrees/MED3pa.models.doctree b/docs/_build/doctrees/det3pa.models.doctree → docs/_build/doctrees/MED3pa.models.doctree
diff --git a/docs/_build/doctrees/datasets_tutorials.doctree b/docs/_build/doctrees/datasets_tutorials.doctree
diff --git a/docs/_build/doctrees/det3pa.med3pa.doctree b/docs/_build/doctrees/det3pa.med3pa.doctree
diff --git a/docs/_build/doctrees/detectron_tutorials.doctree b/docs/_build/doctrees/detectron_tutorials.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/installation.doctree b/docs/_build/doctrees/installation.doctree
diff --git a/docs/_build/doctrees/med3pa_tutorials.doctree b/docs/_build/doctrees/med3pa_tutorials.doctree
diff --git a/docs/_build/doctrees/models_tutorials.doctree b/docs/_build/doctrees/models_tutorials.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: 6c1b820e181777133506df76d9a7a5f6
+config: c7a227aba9459eaeb81d1dbb7fb63d39
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/det3pa.datasets.html → docs/_build/html/MED3pa.datasets.html b/docs/_build/html/det3pa.datasets.html → docs/_build/html/MED3pa.datasets.html
@@ -43,7 +43,11 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">Subpackages</span></p>
+              <p class="caption" role="heading"><span class="caption-text">Installation Guide</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation Guide</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Subpackages</span></p>
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">datasets subpackage</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#overview">Overview</a></li>
@@ -687,7 +691,7 @@ <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this head
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Lyna Chikouche, Ludmila Amriou.</p>
+    <p>&#169; Copyright 2024, MEDomics Consortium.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/_build/html/det3pa.detectron.html → docs/_build/html/MED3pa.detectron.html b/docs/_build/html/det3pa.detectron.html → docs/_build/html/MED3pa.detectron.html
@@ -43,7 +43,11 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">Subpackages</span></p>
+              <p class="caption" role="heading"><span class="caption-text">Installation Guide</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation Guide</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Subpackages</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="MED3pa.datasets.html">datasets subpackage</a></li>
 <li class="toctree-l1"><a class="reference internal" href="MED3pa.models.html">models subpackage</a></li>
@@ -95,7 +99,7 @@
 <h1>detectron subpackage<a class="headerlink" href="#detectron-subpackage" title="Permalink to this heading"></a></h1>
 <section id="overview">
 <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this heading"></a></h2>
-<p>The <code class="docutils literal notranslate"><span class="pre">detectron</span></code> subpackage is a modular implementation of the Detectron method, as described in the paper  <a class="reference external" href="https://arxiv.org/abs/2212.02742">“A learning-based hypothesis test for harmful covariate shift”</a>.
+<p>The <code class="docutils literal notranslate"><span class="pre">detectron</span></code> subpackage is a modular and enhanced implementation of the Detectron method, as described in the paper  <a class="reference external" href="https://openreview.net/forum?id=rdfgqiwz7lZ">“Ginsberg, T., Liang, Z., &amp; Krishnan, R. G. (2023). A Learning Based Hypothesis Test for Harmful Covariate Shift.”</a>.
 This method is designed to detect potentially harmful shifts in data distributions that could undermine the reliability and performance of machine learning models in critical applications.</p>
 <p><strong>Detectron</strong> employs a set of classifiers called (CDCs) trained to agree on domain data but explicitly designed to disagree on this possibly shifted data.
 This unique strategy allows it to effectively identify and quantify shifts in data distributions that pose a risk to the model’s generalization capabilities.</p>
@@ -700,7 +704,7 @@ <h2>experiment module<a class="headerlink" href="#experiment-module" title="Perm
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Lyna Chikouche, Ludmila Amriou.</p>
+    <p>&#169; Copyright 2024, MEDomics Consortium.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/_build/html/det3pa.html → docs/_build/html/MED3pa.html b/docs/_build/html/det3pa.html → docs/_build/html/MED3pa.html
@@ -21,7 +21,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="datasets subpackage" href="MED3pa.datasets.html" />
-    <link rel="prev" title="Welcome to MED3pa documentation!" href="index.html" /> 
+    <link rel="prev" title="Installation Guide" href="installation.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -43,7 +43,11 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">Subpackages</span></p>
+              <p class="caption" role="heading"><span class="caption-text">Installation Guide</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation Guide</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Subpackages</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="MED3pa.datasets.html">datasets subpackage</a></li>
 <li class="toctree-l1"><a class="reference internal" href="MED3pa.models.html">models subpackage</a></li>
@@ -136,14 +140,14 @@
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="index.html" class="btn btn-neutral float-left" title="Welcome to MED3pa documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="installation.html" class="btn btn-neutral float-left" title="Installation Guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="MED3pa.datasets.html" class="btn btn-neutral float-right" title="datasets subpackage" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Lyna Chikouche, Ludmila Amriou.</p>
+    <p>&#169; Copyright 2024, MEDomics Consortium.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a