Deploying to gh-pages from @ 3fb6d79 🚀

_modules/index.html

@@ -71,7 +71,8 @@
            <div itemprop="articleBody">
 
   <h1>All modules for which code is available</h1>
-<ul><li><a href="sc2_replay_reader/sampler.html">sc2_replay_reader.sampler</a></li>
+<ul><li><a href="sc2_replay_reader/example.html">sc2_replay_reader.example</a></li>
+<li><a href="sc2_replay_reader/sampler.html">sc2_replay_reader.sampler</a></li>
 </ul>
 
            </div>

dataloading.html

@@ -62,7 +62,13 @@
 </li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="#pytorch-example">PyTorch Example</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#pytorch-example">PyTorch Example</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#sc2_replay_reader.example.SC2Dataset"><code class="docutils literal notranslate"><span class="pre">SC2Dataset</span></code></a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#sc2_replay_reader.example.SC2Dataset.load_from_parser"><code class="docutils literal notranslate"><span class="pre">SC2Dataset.load_from_parser()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="benchmark.html">Benchmarks</a></li>
@@ -210,6 +216,37 @@ <h2>ReplaySampler<a class="headerlink" href="#replaysampler" title="Link to this
 </section>
 <section id="pytorch-example">
 <h2>PyTorch Example<a class="headerlink" href="#pytorch-example" title="Link to this heading"></a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="sc2_replay_reader.example.SC2Dataset">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sc2_replay_reader.example.</span></span><span class="sig-name descname"><span class="pre">SC2Dataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sampler</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#sc2_replay_reader.sampler.ReplaySampler" title="sc2_replay_reader.sampler.ReplaySampler"><span class="pre">ReplaySampler</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">features</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timepoints</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">TimeRange</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">TimeRange(min=0,</span> <span class="pre">max=30,</span> <span class="pre">step=0.5)</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/sc2_replay_reader/example.html#SC2Dataset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sc2_replay_reader.example.SC2Dataset" title="Link to this definition"></a></dt>
+<dd><p>Example PyTorch Dataset for StarCraft II Data.</p>
+<p>This sample dataloader reads a replay around the timepoint range specified and returns
+the requested [scalar, minimap] features and the game outcome from the player POV.</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>sampler</strong> (<a class="reference internal" href="#sc2_replay_reader.sampler.ReplaySampler" title="sc2_replay_reader.sampler.ReplaySampler"><em>ReplaySampler</em></a>) – Sampler that yields a replay file and index in that file.</p></li>
+<li><p><strong>features</strong> (<em>list</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – List of step data features to use. (default: [minimaps, scalars])</p></li>
+<li><p><strong>timepoints</strong> (<em>TimeRange</em>) – Timepoints in the replay to sample from.</p></li>
+</ul>
+</dd>
+</dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="sc2_replay_reader.example.SC2Dataset.load_from_parser">
+<span class="sig-name descname"><span class="pre">load_from_parser</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/sc2_replay_reader/example.html#SC2Dataset.load_from_parser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sc2_replay_reader.example.SC2Dataset.load_from_parser" title="Link to this definition"></a></dt>
+<dd><p>Sample from data currently in parser</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>observation data, True if valid mask, and game outcome</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>dict [str, Tensor]</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
 </section>
 </section>
 

genindex.html

@@ -78,6 +78,7 @@ <h1 id="index">Index</h1>
  | <a href="#C"><strong>C</strong></a>
  | <a href="#F"><strong>F</strong></a>
  | <a href="#G"><strong>G</strong></a>
+ | <a href="#L"><strong>L</strong></a>
  | <a href="#R"><strong>R</strong></a>
  | <a href="#S"><strong>S</strong></a>
 
@@ -1098,6 +1099,14 @@ <h2 id="G">G</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="L">L</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="dataloading.html#sc2_replay_reader.example.SC2Dataset.load_from_parser">load_from_parser() (sc2_replay_reader.example.SC2Dataset method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -1119,6 +1128,8 @@ <h2 id="S">S</h2>
       </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="dataloading.html#sc2_replay_reader.example.SC2Dataset">SC2Dataset (class in sc2_replay_reader.example)</a>
+</li>
       <li><a href="dataloading.html#sc2_replay_reader.sampler.SQLSampler">SQLSampler (class in sc2_replay_reader.sampler)</a>
 </li>
   </ul></td>