Skip to content

Commit

Permalink
Deploying to gh-pages from @ 03332a9 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@kieranrcampbell
kieranrcampbell committed Jul 31, 2024
1 parent 48a0a2d commit 6e1856a
Show file tree
Hide file tree
Showing 4 changed files with 5,885 additions and 5,854 deletions.
4 changes: 2 additions & 2 deletions _modules/starling/starling.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h1>Source code for starling.starling</h1><div class="highlight"><pre>
<span class="kn">from</span> <span class="nn">pytorch_lightning.accelerators.accelerator</span> <span class="kn">import</span> <span class="n">Accelerator</span>
<span class="kn">from</span> <span class="nn">pytorch_lightning.callbacks</span> <span class="kn">import</span> <span class="n">Callback</span>
<span class="kn">from</span> <span class="nn">pytorch_lightning.loggers</span> <span class="kn">import</span> <span class="n">Logger</span>
<span class="kn">from</span> <span class="nn">pytorch_lightning.plugins</span> <span class="kn">import</span> <span class="n">PLUGIN_INPUT</span>
<span class="kn">from</span> <span class="nn">pytorch_lightning.plugins</span> <span class="kn">import</span> <span class="n">_PLUGIN_INPUT</span>
<span class="kn">from</span> <span class="nn">pytorch_lightning.profilers</span> <span class="kn">import</span> <span class="n">Profiler</span>
<span class="kn">from</span> <span class="nn">pytorch_lightning.strategies.strategy</span> <span class="kn">import</span> <span class="n">Strategy</span>
<span class="kn">from</span> <span class="nn">pytorch_lightning.trainer.connectors.accelerator_connector</span> <span class="kn">import</span> <span class="n">_LITERAL_WARN</span>
Expand Down Expand Up @@ -317,7 +317,7 @@ <h1>Source code for starling.starling</h1><div class="highlight"><pre>
<span class="n">profiler</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Profiler</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">detect_anomaly</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<span class="n">barebones</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<span class="n">plugins</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">PLUGIN_INPUT</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="n">PLUGIN_INPUT</span><span class="p">]]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">plugins</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">_PLUGIN_INPUT</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="n">_PLUGIN_INPUT</span><span class="p">]]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">sync_batchnorm</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<span class="n">reload_dataloaders_every_n_epochs</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">default_root_dir</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">_PATH</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion starling.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ <h1>Starling Class (ST)<a class="headerlink" href="#starling-class-st" title="Li
<li><p><strong>barebones</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – Whether to run in “barebones mode”, where all features that may impact raw speed are
disabled. This is meant for analyzing the Trainer overhead and is discouraged during regular training
runs.</p></li>
<li><p><strong>plugins</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">PrecisionPlugin</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterEnvironment</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CheckpointIO</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">LayerSync</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">PrecisionPlugin</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterEnvironment</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CheckpointIO</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">LayerSync</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]], <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]</span>) – Plugins allow modification of core behavior like ddp and amp, and enable custom lightning plugins.
<li><p><strong>plugins</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Precision</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterEnvironment</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CheckpointIO</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">LayerSync</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Precision</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterEnvironment</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CheckpointIO</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">LayerSync</span></code>]], <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>]</span>) – Plugins allow modification of core behavior like ddp and amp, and enable custom lightning plugins.
Defaults to <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p></li>
<li><p><strong>sync_batchnorm</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – Synchronize batch norm layers between process groups/whole world.
Defaults to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li>
Expand Down
Loading

0 comments on commit 6e1856a

Please sign in to comment.