Deleted old documentation

Ayuei · Jan 25, 2023 · 0fc8c9a · 0fc8c9a
1 parent b75619f
commit 0fc8c9a
Show file tree

Hide file tree

Showing 24 changed files with 8 additions and 15,015 deletions.
diff --git a/docs/debeir.html b/docs/debeir.html
@@ -50,7 +50,7 @@ <h1 class="modulename">
 
                         <div class="docstring"><p>The DeBEIR (Dense Bi-Encoder Information Retrieval) source code library.</p>
 
-<p>See ./main.py in the parent directory for an out-of-the-box runnable code.</p>
+<p>See ./examples/ in the parent directory for an out-of-the-box runnable code.</p>
 
 <p>Otherwise, check out notebooks in the parent directory for training your own model amongst other things.</p>
 </div>
@@ -62,7 +62,7 @@ <h1 class="modulename">
                         <div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos">1</span></a><span class="sd">&quot;&quot;&quot;</span>
 </span><span id="L-2"><a href="#L-2"><span class="linenos">2</span></a><span class="sd">The DeBEIR (Dense Bi-Encoder Information Retrieval) source code library.</span>
 </span><span id="L-3"><a href="#L-3"><span class="linenos">3</span></a>
-</span><span id="L-4"><a href="#L-4"><span class="linenos">4</span></a><span class="sd">See ./main.py in the parent directory for an out-of-the-box runnable code.</span>
+</span><span id="L-4"><a href="#L-4"><span class="linenos">4</span></a><span class="sd">See ./examples/ in the parent directory for an out-of-the-box runnable code.</span>
 </span><span id="L-5"><a href="#L-5"><span class="linenos">5</span></a>
 </span><span id="L-6"><a href="#L-6"><span class="linenos">6</span></a><span class="sd">Otherwise, check out notebooks in the parent directory for training your own model amongst other things.</span>
 </span><span id="L-7"><a href="#L-7"><span class="linenos">7</span></a><span class="sd">&quot;&quot;&quot;</span>

diff --git a/docs/debeir/core.html b/docs/debeir/core.html
@@ -57,7 +57,7 @@ <h1 class="modulename">
 
                         <div class="docstring"><p>Core library interfaces that must be implemented for custom datasets</p>
 
-<p>Interfaces to implement custom data_sets in nir.data_sets.</p>
+<p>Interfaces to implement custom datasets in <a href="datasets.html">debeir.datasets</a>.</p>
 </div>
 
                         <input id="mod-core-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
@@ -67,7 +67,7 @@ <h1 class="modulename">
                         <div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos">1</span></a><span class="sd">&quot;&quot;&quot;</span>
 </span><span id="L-2"><a href="#L-2"><span class="linenos">2</span></a><span class="sd">Core library interfaces that must be implemented for custom datasets</span>
 </span><span id="L-3"><a href="#L-3"><span class="linenos">3</span></a>
-</span><span id="L-4"><a href="#L-4"><span class="linenos">4</span></a><span class="sd">Interfaces to implement custom data_sets in nir.data_sets.</span>
+</span><span id="L-4"><a href="#L-4"><span class="linenos">4</span></a><span class="sd">Interfaces to implement custom datasets in debeir.datasets.</span>
 </span><span id="L-5"><a href="#L-5"><span class="linenos">5</span></a><span class="sd">&quot;&quot;&quot;</span>
 </span></pre></div>
 

diff --git a/docs/debeir/data_sets.html b/docs/debeir/data_sets.html
diff --git a/docs/debeir/data_sets/bioreddit.html b/docs/debeir/data_sets/bioreddit.html
diff --git a/docs/debeir/data_sets/clinical_trials.html b/docs/debeir/data_sets/clinical_trials.html
diff --git a/docs/debeir/data_sets/factory.html b/docs/debeir/data_sets/factory.html
diff --git a/docs/debeir/data_sets/marco.html b/docs/debeir/data_sets/marco.html
diff --git a/docs/debeir/data_sets/trec_clinical_trials.html b/docs/debeir/data_sets/trec_clinical_trials.html
diff --git a/docs/debeir/data_sets/trec_covid.html b/docs/debeir/data_sets/trec_covid.html
diff --git a/docs/debeir/data_sets/types.html b/docs/debeir/data_sets/types.html
diff --git a/docs/debeir/data_sets/utils.html b/docs/debeir/data_sets/utils.html
diff --git a/docs/debeir/datasets.html b/docs/debeir/datasets.html
@@ -53,7 +53,7 @@ <h2>Submodules</h2>
                     <h1 class="modulename">
 <a href="./../debeir.html">debeir</a><wbr>.datasets    </h1>
 
-                        <div class="docstring"><p>Contains data_sets implemented from nir.interfaces</p>
+                        <div class="docstring"><p>Contains data_sets implemented from nir.core</p>
 
 <ol>
 <li>Parser (For reading data from files into a Dict object)</li>
@@ -69,7 +69,7 @@ <h1 class="modulename">
                         <label class="view-source-button" for="mod-datasets-view-source"><span>View Source</span></label>
 
                         <div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos">1</span></a><span class="sd">&quot;&quot;&quot;</span>
-</span><span id="L-2"><a href="#L-2"><span class="linenos">2</span></a><span class="sd">Contains data_sets implemented from nir.interfaces</span>
+</span><span id="L-2"><a href="#L-2"><span class="linenos">2</span></a><span class="sd">Contains data_sets implemented from nir.core</span>
 </span><span id="L-3"><a href="#L-3"><span class="linenos">3</span></a><span class="sd">1. Parser (For reading data from files into a Dict object)</span>
 </span><span id="L-4"><a href="#L-4"><span class="linenos">4</span></a><span class="sd">2. Query object (Generating queries)</span>
 </span><span id="L-5"><a href="#L-5"><span class="linenos">5</span></a><span class="sd">    - These query objects can be very lightweight containing only the mappings of the index.</span>

diff --git a/docs/debeir/evaluation/evaluator.html b/docs/debeir/evaluation/evaluator.html
@@ -319,7 +319,7 @@ <h6 id="returns">Returns</h6>
 <div class="attr function">
 
         <span class="def">def</span>
-        <span class="name">average_all_metrics</span><span class="signature pdoc-code multiline">(<span class="param">	<span class="bp">self</span>,</span><span class="param">	<span class="n">runs</span><span class="p">:</span> <span class="n">Dict</span>,</span><span class="param">	<span class="n">logger</span><span class="p">:</span> <span class="o">&lt;</span><span class="n">loguru</span><span class="o">.</span><span class="n">logger</span> <span class="n">handlers</span><span class="o">=</span><span class="p">[(</span><span class="nb">id</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">sink</span><span class="o">=&lt;</span><span class="n">_io</span><span class="o">.</span><span class="n">StringIO</span> <span class="nb">object</span> <span class="n">at</span> <span class="mh">0x105cfa710</span><span class="o">&gt;</span><span class="p">)]</span><span class="o">&gt;</span></span><span class="return-annotation">):</span></span>
+        <span class="name">average_all_metrics</span><span class="signature pdoc-code multiline">(<span class="param">	<span class="bp">self</span>,</span><span class="param">	<span class="n">runs</span><span class="p">:</span> <span class="n">Dict</span>,</span><span class="param">	<span class="n">logger</span><span class="p">:</span> <span class="o">&lt;</span><span class="n">loguru</span><span class="o">.</span><span class="n">logger</span> <span class="n">handlers</span><span class="o">=</span><span class="p">[(</span><span class="nb">id</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">sink</span><span class="o">=&lt;</span><span class="n">_io</span><span class="o">.</span><span class="n">StringIO</span> <span class="nb">object</span> <span class="n">at</span> <span class="mh">0x103af2710</span><span class="o">&gt;</span><span class="p">)]</span><span class="o">&gt;</span></span><span class="return-annotation">):</span></span>
 
                 <label class="view-source-button" for="Evaluator.average_all_metrics-view-source"><span>View Source</span></label>
 

diff --git a/docs/debeir/interfaces.html b/docs/debeir/interfaces.html
diff --git a/docs/debeir/interfaces/callbacks.html b/docs/debeir/interfaces/callbacks.html
diff --git a/docs/debeir/interfaces/config.html b/docs/debeir/interfaces/config.html
diff --git a/docs/debeir/interfaces/converters.html b/docs/debeir/interfaces/converters.html
diff --git a/docs/debeir/interfaces/document.html b/docs/debeir/interfaces/document.html
diff --git a/docs/debeir/interfaces/executor.html b/docs/debeir/interfaces/executor.html
diff --git a/docs/debeir/interfaces/indexer.html b/docs/debeir/interfaces/indexer.html
diff --git a/docs/debeir/interfaces/parser.html b/docs/debeir/interfaces/parser.html
diff --git a/docs/debeir/interfaces/pipeline.html b/docs/debeir/interfaces/pipeline.html
diff --git a/docs/debeir/interfaces/query.html b/docs/debeir/interfaces/query.html
diff --git a/docs/search.js b/docs/search.js