AlCatt91 published a site update

API_reference.html

@@ -18,7 +18,7 @@
     <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="besskge.dataset" href="generated/besskge.dataset.html" />
+    <link rel="next" title="besskge.pipeline" href="generated/besskge.pipeline.html" />
     <link rel="prev" title="BESS overview" href="bess.html" /> 
 </head>
 
@@ -46,6 +46,7 @@
 <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="bess.html">BESS overview</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">API reference</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="generated/besskge.pipeline.html">besskge.pipeline</a></li>
 <li class="toctree-l2"><a class="reference internal" href="generated/besskge.dataset.html">besskge.dataset</a></li>
 <li class="toctree-l2"><a class="reference internal" href="generated/besskge.sharding.html">besskge.sharding</a></li>
 <li class="toctree-l2"><a class="reference internal" href="generated/besskge.batch_sampler.html">besskge.batch_sampler</a></li>
@@ -90,34 +91,37 @@
 <h1>BESS-KGE API Reference<a class="headerlink" href="#bess-kge-api-reference" title="Permalink to this heading"></a></h1>
 <table class="autosummary longtable docutils align-default">
 <tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/besskge.dataset.html#module-besskge.dataset" title="besskge.dataset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.dataset</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/besskge.pipeline.html#module-besskge.pipeline" title="besskge.pipeline"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.pipeline</span></code></a></p></td>
+<td><p>High-level APIs for training/inference with BESS.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="generated/besskge.dataset.html#module-besskge.dataset" title="besskge.dataset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.dataset</span></code></a></p></td>
 <td><p>Utilities for building and storing knowledge graph datasets as collections of (h,r,t) triples.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="generated/besskge.sharding.html#module-besskge.sharding" title="besskge.sharding"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.sharding</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/besskge.sharding.html#module-besskge.sharding" title="besskge.sharding"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.sharding</span></code></a></p></td>
 <td><p>Sharding of embedding tables and triple sets for distributed execution.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/besskge.batch_sampler.html#module-besskge.batch_sampler" title="besskge.batch_sampler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.batch_sampler</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="generated/besskge.batch_sampler.html#module-besskge.batch_sampler" title="besskge.batch_sampler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.batch_sampler</span></code></a></p></td>
 <td><p>Classes for sampling batches of positive and negative triples for each processing device, according to the BESS distribution scheme.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="generated/besskge.negative_sampler.html#module-besskge.negative_sampler" title="besskge.negative_sampler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.negative_sampler</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/besskge.negative_sampler.html#module-besskge.negative_sampler" title="besskge.negative_sampler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.negative_sampler</span></code></a></p></td>
 <td><p>Classes for sampling entities to use as corrupted heads/tails when constructing negative samples.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/besskge.bess.html#module-besskge.bess" title="besskge.bess"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.bess</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="generated/besskge.bess.html#module-besskge.bess" title="besskge.bess"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.bess</span></code></a></p></td>
 <td><p>PyTorch modules implementing the BESS distribution scheme <span id="id1">[<a class="reference internal" href="bibliography.html#id11" title="Alberto Cattaneo, Daniel Justus, Harry Mellor, Douglas Orr, Jerome Maloberti, Zhenying Liu, Thorin Farnsworth, Andrew Fitzgibbon, Blazej Banaszewski, and Carlo Luschi. BESS: balanced entity sampling and sharing for large-scale knowledge graph completion. arXiv preprint arXiv:2211.12281, 2022.">CJM+22</a>]</span> for KGE training and inference on multiple IPUs.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="generated/besskge.scoring.html#module-besskge.scoring" title="besskge.scoring"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.scoring</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/besskge.scoring.html#module-besskge.scoring" title="besskge.scoring"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.scoring</span></code></a></p></td>
 <td><p>Functions for scoring positive and negative triples, specific to each KGE model.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/besskge.loss.html#module-besskge.loss" title="besskge.loss"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.loss</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="generated/besskge.loss.html#module-besskge.loss" title="besskge.loss"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.loss</span></code></a></p></td>
 <td><p>Functions for computing the batch loss based on the scores of positive and negative samples.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="generated/besskge.metric.html#module-besskge.metric" title="besskge.metric"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.metric</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/besskge.metric.html#module-besskge.metric" title="besskge.metric"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.metric</span></code></a></p></td>
 <td><p>Utilities for computing metrics to evaluate the predictions of KGE models.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/besskge.embedding.html#module-besskge.embedding" title="besskge.embedding"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.embedding</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="generated/besskge.embedding.html#module-besskge.embedding" title="besskge.embedding"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.embedding</span></code></a></p></td>
 <td><p>Utilities for initializing and managing entity/relation embedding tables.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="generated/besskge.utils.html#module-besskge.utils" title="besskge.utils"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.utils</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/besskge.utils.html#module-besskge.utils" title="besskge.utils"><code class="xref py py-obj docutils literal notranslate"><span class="pre">besskge.utils</span></code></a></p></td>
 <td><p>General purpose utilities.</p></td>
 </tr>
 </tbody>
@@ -129,7 +133,7 @@ <h1>BESS-KGE API Reference<a class="headerlink" href="#bess-kge-api-reference" t
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="bess.html" class="btn btn-neutral float-left" title="BESS overview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="generated/besskge.dataset.html" class="btn btn-neutral float-right" title="besskge.dataset" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="generated/besskge.pipeline.html" class="btn btn-neutral float-right" title="besskge.pipeline" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>