Deploying to gh-pages from @ 65ec11c 🚀

_modules/index.html

@@ -397,7 +397,9 @@ <h1 id="modules-index--page-root">All modules for which code is available</h1>
 <li><a href="graphnet/datasets/test_dataset.html">graphnet.datasets.test_dataset</a></li>
 <li><a href="graphnet/deployment/deployer.html">graphnet.deployment.deployer</a></li>
 <li><a href="graphnet/deployment/deployment_module.html">graphnet.deployment.deployment_module</a></li>
+<li><a href="graphnet/deployment/i3modules/deprecated_methods.html">graphnet.deployment.i3modules.deprecated_methods</a></li>
 <li><a href="graphnet/deployment/icecube/cleaning_module.html">graphnet.deployment.icecube.cleaning_module</a></li>
+<li><a href="graphnet/deployment/icecube/i3deployer.html">graphnet.deployment.icecube.i3deployer</a></li>
 <li><a href="graphnet/deployment/icecube/inference_module.html">graphnet.deployment.icecube.inference_module</a></li>
 <li><a href="graphnet/exceptions/exceptions.html">graphnet.exceptions.exceptions</a></li>
 <li><a href="graphnet/models/coarsening.html">graphnet.models.coarsening</a></li>

api/graphnet.deployment.i3modules.deprecated_methods.html

@@ -363,11 +363,25 @@
 
 
 <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-deployment-i3modules-deprecated-methods--page-root" class="md-nav__link">deprecated_methods</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#graphnet.deployment.i3modules.deprecated_methods.GraphNeTI3Deployer" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">GraphNeTI3Deployer</span></code></a>
+        </li></ul>
+            </nav>
+        </li>
   </ul>
 </nav>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+
+
+      <a href="#graphnet.deployment.i3modules.deprecated_methods.GraphNeTI3Deployer" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">GraphNeTI3Deployer</span></code></a>
 
 
+    </li></ul>
+
     </li></ul>
 
     </li>
@@ -443,7 +457,14 @@
               <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-deployment-i3modules-deprecated-methods--page-root" class="md-nav__link">deprecated_methods</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#graphnet.deployment.i3modules.deprecated_methods.GraphNeTI3Deployer" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">GraphNeTI3Deployer</span></code></a>
+        </li></ul>
+            </nav>
+        </li>
   </ul>
 </nav>
               </div>
@@ -453,8 +474,31 @@
         <div class="md-content">
           <article class="md-content__inner md-typeset" role="main">
 
-  <section id="deprecated-methods">
-<h1 id="api-graphnet-deployment-i3modules-deprecated-methods--page-root">deprecated_methods<a class="headerlink" href="#api-graphnet-deployment-i3modules-deprecated-methods--page-root" title="Link to this heading">¶</a></h1>
+  <section id="module-graphnet.deployment.i3modules.deprecated_methods">
+<span id="deprecated-methods"></span><h1 id="api-graphnet-deployment-i3modules-deprecated-methods--page-root">deprecated_methods<a class="headerlink" href="#api-graphnet-deployment-i3modules-deprecated-methods--page-root" title="Link to this heading">¶</a></h1>
+<p>Contains deprecated methods.</p>
+<dl class="py class">
+<dt class="sig sig-object py" id="graphnet.deployment.i3modules.deprecated_methods.GraphNeTI3Deployer">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">graphnet.deployment.i3modules.deprecated_methods.</span></span><span class="sig-name descname"><span class="pre">GraphNeTI3Deployer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">graphnet_modules</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gcd_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_workers</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/graphnet/deployment/i3modules/deprecated_methods.html#GraphNeTI3Deployer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#graphnet.deployment.i3modules.deprecated_methods.GraphNeTI3Deployer" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="graphnet.deployment.icecube.i3deployer.html#graphnet.deployment.icecube.i3deployer.I3Deployer" title="graphnet.deployment.icecube.i3deployer.I3Deployer"><code class="xref py py-class docutils literal notranslate"><span class="pre">I3Deployer</span></code></a></p>
+<p>Class has been renamed to <cite>I3Deployer</cite>.</p>
+<p>Please use <cite>I3Deployer</cite> instead.</p>
+<p>Initialize <cite>GraphNeTI3Deployer</cite>.</p>
+<p>Will apply <cite>DeploymentModules</cite> to files in the order in which they
+appear in <cite>modules</cite>. Each module is run independently.</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>graphnet_modules</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="graphnet.deployment.icecube.inference_module.html#graphnet.deployment.icecube.inference_module.I3InferenceModule" title="graphnet.deployment.icecube.inference_module.I3InferenceModule"><code class="xref py py-class docutils literal notranslate"><span class="pre">I3InferenceModule</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="graphnet.deployment.icecube.inference_module.html#graphnet.deployment.icecube.inference_module.I3InferenceModule" title="graphnet.deployment.icecube.inference_module.I3InferenceModule"><code class="xref py py-class docutils literal notranslate"><span class="pre">I3InferenceModule</span></code></a>]]</span>) – List of <cite>DeploymentModules</cite>.
+Order of appearence in the list determines order
+of deployment.</p></li>
+<li><p><strong>gcd_file</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – path to gcd file.</p></li>
+<li><p><strong>n_workers</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>, default: <code class="docutils literal notranslate"><span class="pre">1</span></code>) – Number of workers. The deployer will divide the number
+of input files across workers. Defaults to 1.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
 </section>
 
 

api/graphnet.deployment.i3modules.html

@@ -452,12 +452,19 @@
         <div class="md-content">
           <article class="md-content__inner md-typeset" role="main">
 
-  <section id="i3modules">
-<h1 id="api-graphnet-deployment-i3modules--page-root">i3modules<a class="headerlink" href="#api-graphnet-deployment-i3modules--page-root" title="Link to this heading">¶</a></h1>
+  <section id="module-graphnet.deployment.i3modules">
+<span id="i3modules"></span><h1 id="api-graphnet-deployment-i3modules--page-root">i3modules<a class="headerlink" href="#api-graphnet-deployment-i3modules--page-root" title="Link to this heading">¶</a></h1>
+<p>Collection of I3Modules.</p>
+<p>This module contains various I3Modules which allow for running GNN model
+inference as part of an icetray reconstruction chain, for different IceCube
+detector configurations.</p>
 <p><h2> Submodules </h2></p>
 <div class="toctree-wrapper compound">
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="graphnet.deployment.i3modules.deprecated_methods.html">deprecated_methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="graphnet.deployment.i3modules.deprecated_methods.html">deprecated_methods</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="graphnet.deployment.i3modules.deprecated_methods.html#graphnet.deployment.i3modules.deprecated_methods.GraphNeTI3Deployer"><code class="docutils literal notranslate"><span class="pre">GraphNeTI3Deployer</span></code></a></li>
+</ul>
+</li>
 </ul>
 </div>
 </section>

api/graphnet.deployment.icecube.html

@@ -466,16 +466,20 @@
         <div class="md-content">
           <article class="md-content__inner md-typeset" role="main">
 
-  <section id="icecube">
-<h1 id="api-graphnet-deployment-icecube--page-root">icecube<a class="headerlink" href="#api-graphnet-deployment-icecube--page-root" title="Link to this heading">¶</a></h1>
+  <section id="module-graphnet.deployment.icecube">
+<span id="icecube"></span><h1 id="api-graphnet-deployment-icecube--page-root">icecube<a class="headerlink" href="#api-graphnet-deployment-icecube--page-root" title="Link to this heading">¶</a></h1>
+<p>Deployment modules specific to IceCube.</p>
 <p><h2> Submodules </h2></p>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="graphnet.deployment.icecube.cleaning_module.html">cleaning_module</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="graphnet.deployment.icecube.cleaning_module.html#graphnet.deployment.icecube.cleaning_module.I3PulseCleanerModule"><code class="docutils literal notranslate"><span class="pre">I3PulseCleanerModule</span></code></a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="graphnet.deployment.icecube.i3deployer.html">i3deployer</a></li>
+<li class="toctree-l1"><a class="reference internal" href="graphnet.deployment.icecube.i3deployer.html">i3deployer</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="graphnet.deployment.icecube.i3deployer.html#graphnet.deployment.icecube.i3deployer.I3Deployer"><code class="docutils literal notranslate"><span class="pre">I3Deployer</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="graphnet.deployment.icecube.inference_module.html">inference_module</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="graphnet.deployment.icecube.inference_module.html#graphnet.deployment.icecube.inference_module.I3InferenceModule"><code class="docutils literal notranslate"><span class="pre">I3InferenceModule</span></code></a></li>
 </ul>

api/graphnet.deployment.icecube.i3deployer.html

@@ -377,11 +377,25 @@
 
 
 <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-deployment-icecube-i3deployer--page-root" class="md-nav__link">i3deployer</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#graphnet.deployment.icecube.i3deployer.I3Deployer" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">I3Deployer</span></code></a>
+        </li></ul>
+            </nav>
+        </li>
   </ul>
 </nav>
+      <ul class="md-nav__list"> 
+    <li class="md-nav__item">
+
+
+      <a href="#graphnet.deployment.icecube.i3deployer.I3Deployer" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">I3Deployer</span></code></a>
 
 
+    </li></ul>
+
     </li>
     <li class="md-nav__item">
 
@@ -457,7 +471,14 @@
               <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-deployment-icecube-i3deployer--page-root" class="md-nav__link">i3deployer</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#graphnet.deployment.icecube.i3deployer.I3Deployer" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">I3Deployer</span></code></a>
+        </li></ul>
+            </nav>
+        </li>
   </ul>
 </nav>
               </div>
@@ -467,8 +488,31 @@
         <div class="md-content">
           <article class="md-content__inner md-typeset" role="main">
 
-  <section id="i3deployer">
-<h1 id="api-graphnet-deployment-icecube-i3deployer--page-root">i3deployer<a class="headerlink" href="#api-graphnet-deployment-icecube-i3deployer--page-root" title="Link to this heading">¶</a></h1>
+  <section id="module-graphnet.deployment.icecube.i3deployer">
+<span id="i3deployer"></span><h1 id="api-graphnet-deployment-icecube-i3deployer--page-root">i3deployer<a class="headerlink" href="#api-graphnet-deployment-icecube-i3deployer--page-root" title="Link to this heading">¶</a></h1>
+<p>Contains an IceCube-specific implementation of Deployer.</p>
+<dl class="py class">
+<dt class="sig sig-object py" id="graphnet.deployment.icecube.i3deployer.I3Deployer">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">graphnet.deployment.icecube.i3deployer.</span></span><span class="sig-name descname"><span class="pre">I3Deployer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">modules</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gcd_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_workers</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/graphnet/deployment/icecube/i3deployer.html#I3Deployer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#graphnet.deployment.icecube.i3deployer.I3Deployer" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="graphnet.deployment.deployer.html#graphnet.deployment.deployer.Deployer" title="graphnet.deployment.deployer.Deployer"><code class="xref py py-class docutils literal notranslate"><span class="pre">Deployer</span></code></a></p>
+<p>A generic baseclass for applying <cite>DeploymentModules</cite> to analysis files.</p>
+<p>Modules are applied in the order that they appear in <cite>modules</cite>.</p>
+<p>Initialize <cite>Deployer</cite>.</p>
+<p>Will apply <cite>DeploymentModules</cite> to files in the order in which they
+appear in <cite>modules</cite>. Each module is run independently.</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>modules</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="graphnet.deployment.icecube.inference_module.html#graphnet.deployment.icecube.inference_module.I3InferenceModule" title="graphnet.deployment.icecube.inference_module.I3InferenceModule"><code class="xref py py-class docutils literal notranslate"><span class="pre">I3InferenceModule</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="graphnet.deployment.icecube.inference_module.html#graphnet.deployment.icecube.inference_module.I3InferenceModule" title="graphnet.deployment.icecube.inference_module.I3InferenceModule"><code class="xref py py-class docutils literal notranslate"><span class="pre">I3InferenceModule</span></code></a>]]</span>) – List of <cite>DeploymentModules</cite>.
+Order of appearence in the list determines order
+of deployment.</p></li>
+<li><p><strong>gcd_file</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – path to gcd file.</p></li>
+<li><p><strong>n_workers</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>, default: <code class="docutils literal notranslate"><span class="pre">1</span></code>) – Number of workers. The deployer will divide the number
+of input files across workers. Defaults to 1.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
 </section>