Deploying to gh-pages from @ 211e0c1 🚀

_modules/index.html

@@ -323,10 +323,6 @@
   <h1 id="modules-index--page-root">All modules for which code is available</h1>
 <ul><li><a href="graphnet/data/constants.html">graphnet.data.constants</a></li>
 <li><a href="graphnet/data/dataconverter.html">graphnet.data.dataconverter</a></li>
-<li><a href="graphnet/data/dataloader.html">graphnet.data.dataloader</a></li>
-<li><a href="graphnet/data/dataset/dataset.html">graphnet.data.dataset.dataset</a></li>
-<li><a href="graphnet/data/dataset/parquet/parquet_dataset.html">graphnet.data.dataset.parquet.parquet_dataset</a></li>
-<li><a href="graphnet/data/dataset/sqlite/sqlite_dataset.html">graphnet.data.dataset.sqlite.sqlite_dataset</a></li>
 <li><a href="graphnet/data/extractors/i3extractor.html">graphnet.data.extractors.i3extractor</a></li>
 <li><a href="graphnet/data/extractors/i3featureextractor.html">graphnet.data.extractors.i3featureextractor</a></li>
 <li><a href="graphnet/data/extractors/i3genericextractor.html">graphnet.data.extractors.i3genericextractor</a></li>
@@ -343,40 +339,14 @@ <h1 id="modules-index--page-root">All modules for which code is available</h1>
 <li><a href="graphnet/data/extractors/utilities/frames.html">graphnet.data.extractors.utilities.frames</a></li>
 <li><a href="graphnet/data/extractors/utilities/types.html">graphnet.data.extractors.utilities.types</a></li>
 <li><a href="graphnet/data/parquet/parquet_dataconverter.html">graphnet.data.parquet.parquet_dataconverter</a></li>
-<li><a href="graphnet/data/pipeline.html">graphnet.data.pipeline</a></li>
 <li><a href="graphnet/data/sqlite/sqlite_dataconverter.html">graphnet.data.sqlite.sqlite_dataconverter</a></li>
 <li><a href="graphnet/data/sqlite/sqlite_utilities.html">graphnet.data.sqlite.sqlite_utilities</a></li>
 <li><a href="graphnet/data/utilities/parquet_to_sqlite.html">graphnet.data.utilities.parquet_to_sqlite</a></li>
 <li><a href="graphnet/data/utilities/random.html">graphnet.data.utilities.random</a></li>
 <li><a href="graphnet/data/utilities/string_selection_resolver.html">graphnet.data.utilities.string_selection_resolver</a></li>
-<li><a href="graphnet/deployment/i3modules/graphnet_module.html">graphnet.deployment.i3modules.graphnet_module</a></li>
-<li><a href="graphnet/models/coarsening.html">graphnet.models.coarsening</a></li>
-<li><a href="graphnet/models/components/layers.html">graphnet.models.components.layers</a></li>
-<li><a href="graphnet/models/components/pool.html">graphnet.models.components.pool</a></li>
-<li><a href="graphnet/models/detector/detector.html">graphnet.models.detector.detector</a></li>
-<li><a href="graphnet/models/detector/icecube.html">graphnet.models.detector.icecube</a></li>
-<li><a href="graphnet/models/detector/prometheus.html">graphnet.models.detector.prometheus</a></li>
-<li><a href="graphnet/models/gnn/convnet.html">graphnet.models.gnn.convnet</a></li>
-<li><a href="graphnet/models/gnn/dynedge.html">graphnet.models.gnn.dynedge</a></li>
-<li><a href="graphnet/models/gnn/dynedge_jinst.html">graphnet.models.gnn.dynedge_jinst</a></li>
-<li><a href="graphnet/models/gnn/dynedge_kaggle_tito.html">graphnet.models.gnn.dynedge_kaggle_tito</a></li>
-<li><a href="graphnet/models/gnn/gnn.html">graphnet.models.gnn.gnn</a></li>
-<li><a href="graphnet/models/graphs/edges/edges.html">graphnet.models.graphs.edges.edges</a></li>
-<li><a href="graphnet/models/graphs/graph_definition.html">graphnet.models.graphs.graph_definition</a></li>
-<li><a href="graphnet/models/graphs/graphs.html">graphnet.models.graphs.graphs</a></li>
-<li><a href="graphnet/models/graphs/nodes/nodes.html">graphnet.models.graphs.nodes.nodes</a></li>
-<li><a href="graphnet/models/model.html">graphnet.models.model</a></li>
-<li><a href="graphnet/models/standard_model.html">graphnet.models.standard_model</a></li>
-<li><a href="graphnet/models/task/classification.html">graphnet.models.task.classification</a></li>
-<li><a href="graphnet/models/task/reconstruction.html">graphnet.models.task.reconstruction</a></li>
-<li><a href="graphnet/models/task/task.html">graphnet.models.task.task</a></li>
-<li><a href="graphnet/models/utils.html">graphnet.models.utils</a></li>
 <li><a href="graphnet/pisa/fitting.html">graphnet.pisa.fitting</a></li>
 <li><a href="graphnet/pisa/plotting.html">graphnet.pisa.plotting</a></li>
 <li><a href="graphnet/training/callbacks.html">graphnet.training.callbacks</a></li>
-<li><a href="graphnet/training/labels.html">graphnet.training.labels</a></li>
-<li><a href="graphnet/training/loss_functions.html">graphnet.training.loss_functions</a></li>
-<li><a href="graphnet/training/utils.html">graphnet.training.utils</a></li>
 <li><a href="graphnet/training/weight_fitting.html">graphnet.training.weight_fitting</a></li>
 <li><a href="graphnet/utilities/argparse.html">graphnet.utilities.argparse</a></li>
 <li><a href="graphnet/utilities/config/base_config.html">graphnet.utilities.config.base_config</a></li>

api/graphnet.data.dataloader.html

@@ -365,54 +365,11 @@
 
 
 <nav class="md-nav md-nav--secondary">
-    <label class="md-nav__title" for="__toc">"Contents"</label>
   <ul class="md-nav__list" data-md-scrollfix="">
-        <li class="md-nav__item"><a href="#api-graphnet-data-dataloader--page-root" class="md-nav__link">dataloader</a><nav class="md-nav">
-              <ul class="md-nav__list">
-        <li class="md-nav__item"><a href="#graphnet.data.dataloader.collate_fn" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">collate_fn()</span></code></a>
-        </li>
-        <li class="md-nav__item"><a href="#graphnet.data.dataloader.do_shuffle" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">do_shuffle()</span></code></a>
-        </li>
-        <li class="md-nav__item"><a href="#graphnet.data.dataloader.DataLoader" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DataLoader</span></code></a><nav class="md-nav">
-              <ul class="md-nav__list">
-        <li class="md-nav__item"><a href="#graphnet.data.dataloader.DataLoader.from_dataset_config" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">from_dataset_config()</span></code></a>
-        </li></ul>
-            </nav>
-        </li></ul>
-            </nav>
-        </li>
   </ul>
 </nav>
-      <ul class="md-nav__list"> 
-    <li class="md-nav__item">
-
-
-      <a href="#graphnet.data.dataloader.collate_fn" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">collate_fn()</span></code></a>
-
-
-    </li>
-    <li class="md-nav__item">
-
-
-      <a href="#graphnet.data.dataloader.do_shuffle" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">do_shuffle()</span></code></a>
-
-
-    </li>
-    <li class="md-nav__item">
-
-
-      <a href="#graphnet.data.dataloader.DataLoader" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DataLoader</span></code></a>
-      <ul class="md-nav__list"> 
-    <li class="md-nav__item">
-
-
-      <a href="#graphnet.data.dataloader.DataLoader.from_dataset_config" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">from_dataset_config()</span></code></a>
 
 
-    </li></ul>
-
-    </li></ul>
-
     </li>
     <li class="md-nav__item">
 
@@ -479,22 +436,7 @@
               <div class="md-sidebar__inner">
 
 <nav class="md-nav md-nav--secondary">
-    <label class="md-nav__title" for="__toc">"Contents"</label>
   <ul class="md-nav__list" data-md-scrollfix="">
-        <li class="md-nav__item"><a href="#api-graphnet-data-dataloader--page-root" class="md-nav__link">dataloader</a><nav class="md-nav">
-              <ul class="md-nav__list">
-        <li class="md-nav__item"><a href="#graphnet.data.dataloader.collate_fn" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">collate_fn()</span></code></a>
-        </li>
-        <li class="md-nav__item"><a href="#graphnet.data.dataloader.do_shuffle" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">do_shuffle()</span></code></a>
-        </li>
-        <li class="md-nav__item"><a href="#graphnet.data.dataloader.DataLoader" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DataLoader</span></code></a><nav class="md-nav">
-              <ul class="md-nav__list">
-        <li class="md-nav__item"><a href="#graphnet.data.dataloader.DataLoader.from_dataset_config" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">from_dataset_config()</span></code></a>
-        </li></ul>
-            </nav>
-        </li></ul>
-            </nav>
-        </li>
   </ul>
 </nav>
               </div>
@@ -504,73 +446,8 @@
         <div class="md-content">
           <article class="md-content__inner md-typeset" role="main">
 
-  <section id="module-graphnet.data.dataloader">
-<span id="dataloader"></span><h1 id="api-graphnet-data-dataloader--page-root">dataloader<a class="headerlink" href="#api-graphnet-data-dataloader--page-root" title="Link to this heading">¶</a></h1>
-<p>Base <cite>Dataloader</cite> class(es) used in <cite>graphnet</cite>.</p>
-<dl class="py function">
-<dt class="sig sig-object py" id="graphnet.data.dataloader.collate_fn">
-<span class="sig-prename descclassname"><span class="pre">graphnet.data.dataloader.</span></span><span class="sig-name descname"><span class="pre">collate_fn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">graphs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/graphnet/data/dataloader.html#collate_fn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#graphnet.data.dataloader.collate_fn" title="Link to this definition">¶</a></dt>
-<dd><p>Remove graphs with less than two DOM hits.</p>
-<p>Should not occur in “production.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Batch</span></code></p>
-</dd>
-<dt class="field-even">Parameters<span class="colon">:</span></dt>
-<dd class="field-even"><p><strong>graphs</strong> (<em>List</em><em>[</em><em>Data</em><em>]</em>) – </p>
-</dd>
-</dl>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="graphnet.data.dataloader.do_shuffle">
-<span class="sig-prename descclassname"><span class="pre">graphnet.data.dataloader.</span></span><span class="sig-name descname"><span class="pre">do_shuffle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">selection_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/graphnet/data/dataloader.html#do_shuffle"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#graphnet.data.dataloader.do_shuffle" title="Link to this definition">¶</a></dt>
-<dd><p>Check whether to shuffle selection with name <cite>selection_name</cite>.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
-</dd>
-<dt class="field-even">Parameters<span class="colon">:</span></dt>
-<dd class="field-even"><p><strong>selection_name</strong> (<em>str</em>) – </p>
-</dd>
-</dl>
-</dd></dl>
-<dl class="py class">
-<dt class="sig sig-object py" id="graphnet.data.dataloader.DataLoader">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">graphnet.data.dataloader.</span></span><span class="sig-name descname"><span class="pre">DataLoader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shuffle</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_workers</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persistent_workers</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">collate_fn=&lt;function</span> <span class="pre">collate_fn&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefetch_factor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/graphnet/data/dataloader.html#DataLoader"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#graphnet.data.dataloader.DataLoader" title="Link to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DataLoader</span></code></p>
-<p>Class for loading data from a <cite>Dataset</cite>.</p>
-<p>Construct <cite>DataLoader</cite>.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>dataset</strong> (<em>Dataset</em><em>[</em><em>T_co</em><em>]</em>) – </p></li>
-<li><p><strong>batch_size</strong> (<em>int</em><em> | </em><em>None</em>) – </p></li>
-<li><p><strong>shuffle</strong> (<em>bool</em>) – </p></li>
-<li><p><strong>num_workers</strong> (<em>int</em>) – </p></li>
-<li><p><strong>persistent_workers</strong> (<em>bool</em>) – </p></li>
-<li><p><strong>collate_fn</strong> (<em>Callable</em>) – </p></li>
-<li><p><strong>prefetch_factor</strong> (<em>int</em><em> | </em><em>None</em>) – </p></li>
-<li><p><strong>kwargs</strong> (<em>Any</em>) – </p></li>
-</ul>
-</dd>
-</dl>
-<dl class="py method">
-<dt class="sig sig-object py" id="graphnet.data.dataloader.DataLoader.from_dataset_config">
-<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dataset_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/graphnet/data/dataloader.html#DataLoader.from_dataset_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#graphnet.data.dataloader.DataLoader.from_dataset_config" title="Link to this definition">¶</a></dt>
-<dd><p>Construct <cite>DataLoader`s based on selections in `DatasetConfig</cite>.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#graphnet.data.dataloader.DataLoader" title="graphnet.data.dataloader.DataLoader"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataLoader</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#graphnet.data.dataloader.DataLoader" title="graphnet.data.dataloader.DataLoader"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataLoader</span></code></a>]]</p>
-</dd>
-<dt class="field-even">Parameters<span class="colon">:</span></dt>
-<dd class="field-even"><ul class="simple">
-<li><p><strong>config</strong> (<a class="reference internal" href="graphnet.utilities.config.dataset_config.html#graphnet.utilities.config.dataset_config.DatasetConfig" title="graphnet.utilities.config.dataset_config.DatasetConfig"><em>DatasetConfig</em></a>) – </p></li>
-<li><p><strong>kwargs</strong> (<em>Any</em>) – </p></li>
-</ul>
-</dd>
-</dl>
-</dd></dl>
-</dd></dl>
+  <section id="dataloader">
+<h1 id="api-graphnet-data-dataloader--page-root">dataloader<a class="headerlink" href="#api-graphnet-data-dataloader--page-root" title="Link to this heading">¶</a></h1>
 </section>