new doc ✨

soda-inria · Jul 3, 2024 · 78244a3 · 78244a3
1 parent 32189b7
commit 78244a3
Show file tree

Hide file tree

Showing 68 changed files with 7,815 additions and 0 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -0,0 +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: 2d9b94c28c373b5fc8c7bcca05ceb3e1
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_modules/carte/configs/model_parameters.html b/docs/_modules/carte/configs/model_parameters.html
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -0,0 +1,103 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; carte 1.0.0 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" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <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=8d563738"></script>
+        <script src="../_static/doctools.js?v=9a2dae69"></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" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            carte
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </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">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../modules.html">carte</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">carte</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="carte/configs/model_parameters.html">carte.configs.model_parameters</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Myung Jun Kim, Léo Grinsztajn, Gaël Varoquaux.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/docs/_sources/carte.configs.rst.txt b/docs/_sources/carte.configs.rst.txt
@@ -0,0 +1,45 @@
+carte.configs package
+=====================
+
+Submodules
+----------
+
+carte.configs.carte\_configs module
+-----------------------------------
+
+.. automodule:: carte.configs.carte_configs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+carte.configs.directory module
+------------------------------
+
+.. automodule:: carte.configs.directory
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+carte.configs.model\_parameters module
+--------------------------------------
+
+.. automodule:: carte.configs.model_parameters
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+carte.configs.visuailization module
+-----------------------------------
+
+.. automodule:: carte.configs.visuailization
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: carte.configs
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/carte.data.rst.txt b/docs/_sources/carte.data.rst.txt
@@ -0,0 +1,10 @@
+carte.data package
+==================
+
+Module contents
+---------------
+
+.. automodule:: carte.data
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/carte.rst.txt b/docs/_sources/carte.rst.txt
@@ -0,0 +1,21 @@
+carte package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   carte.configs
+   carte.data
+   carte.scripts
+   carte.src
+
+Module contents
+---------------
+
+.. automodule:: carte
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/carte.scripts.rst.txt b/docs/_sources/carte.scripts.rst.txt
@@ -0,0 +1,53 @@
+carte.scripts package
+=====================
+
+Submodules
+----------
+
+carte.scripts.compile\_results\_singletable module
+--------------------------------------------------
+
+.. automodule:: carte.scripts.compile_results_singletable
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+carte.scripts.download\_data module
+-----------------------------------
+
+.. automodule:: carte.scripts.download_data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+carte.scripts.evaluate\_singletable module
+------------------------------------------
+
+.. automodule:: carte.scripts.evaluate_singletable
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+carte.scripts.preprocess\_lm module
+-----------------------------------
+
+.. automodule:: carte.scripts.preprocess_lm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+carte.scripts.preprocess\_raw module
+------------------------------------
+
+.. automodule:: carte.scripts.preprocess_raw
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: carte.scripts
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/carte.src.rst.txt b/docs/_sources/carte.src.rst.txt
@@ -0,0 +1,85 @@
+carte.src package
+=================
+
+Submodules
+----------
+
+carte.src.baseline\_multitable module
+-------------------------------------
+
+.. automodule:: carte.src.baseline_multitable
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+carte.src.baseline\_singletable\_nn module
+------------------------------------------
+
+.. automodule:: carte.src.baseline_singletable_nn
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+carte.src.carte\_estimator module
+---------------------------------
+
+.. automodule:: carte.src.carte_estimator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+carte.src.carte\_gridsearch module
+----------------------------------
+
+.. automodule:: carte.src.carte_gridsearch
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+carte.src.carte\_model module
+-----------------------------
+
+.. automodule:: carte.src.carte_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+carte.src.carte\_table\_to\_graph module
+----------------------------------------
+
+.. automodule:: carte.src.carte_table_to_graph
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+carte.src.evaluate\_utils module
+--------------------------------
+
+.. automodule:: carte.src.evaluate_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+carte.src.preprocess\_utils module
+----------------------------------
+
+.. automodule:: carte.src.preprocess_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+carte.src.visualization\_utils module
+-------------------------------------
+
+.. automodule:: carte.src.visualization_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: carte.src
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,20 @@
+.. carte documentation master file, created by
+   sphinx-quickstart on Wed Jul  3 14:42:59 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to carte's documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/_sources/modules.rst.txt b/docs/_sources/modules.rst.txt
@@ -0,0 +1,7 @@
+carte
+=====
+
+.. toctree::
+   :maxdepth: 4
+
+   carte