tocmo0nlord/axolotl
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Built site for gh-pages

Browse Source
This commit is contained in:
Quarto GHA Workflow Runner
2025-08-13 10:45:04 +00:00
parent 832b457557
commit 338b82519f
7 changed files with 255 additions and 1125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/api/cli.utils.train.html
View File

@@ -529,7 +529,7 @@ gtag('config', 'G-9KYCVJBNMQ', { 'anonymize_ip': true});
</tr>
<tr class="even">
<td><a href="#axolotl.cli.utils.train.generate_config_files">generate_config_files</a></td>
<td>Generate list of configuration files to process.</td>
<td>Generate list of configuration files to process. Yields a tuple of the configuration file name and a boolean indicating</td>
</tr>
<tr class="odd">
<td><a href="#axolotl.cli.utils.train.launch_training">launch_training</a></td>
@@ -597,7 +597,35 @@ gtag('config', 'G-9KYCVJBNMQ', { 'anonymize_ip': true});
<section id="axolotl.cli.utils.train.generate_config_files" class="level3">
<h3 class="anchored" data-anchor-id="axolotl.cli.utils.train.generate_config_files">generate_config_files</h3>
<div class="sourceCode" id="cb2"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a>cli.utils.train.generate_config_files(config, sweep)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>Generate list of configuration files to process.</p>
<p>Generate list of configuration files to process. Yields a tuple of the configuration file name and a boolean indicating
whether this is a group of configurations (i.e., a sweep).</p>
<section id="parameters-1" class="level4 doc-section doc-section-parameters">
<h4 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-1">Parameters</h4>
<table class="caption-top table">
<thead>
<tr class="header">
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>config</td>
<td>str</td>
<td>Base configuration file</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>sweep</td>
<td>str | None</td>
<td>Sweep configuration file</td>
<td><em>required</em></td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="axolotl.cli.utils.train.launch_training" class="level3">
<h3 class="anchored" data-anchor-id="axolotl.cli.utils.train.launch_training">launch_training</h3>
@@ -607,7 +635,8 @@ gtag('config', 'G-9KYCVJBNMQ', { 'anonymize_ip': true});
<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a> cloud,</span>
<span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a> kwargs,</span>
<span id="cb3-6"><a href="#cb3-6" aria-hidden="true" tabindex="-1"></a> launcher_args<span class="op">=</span><span class="va">None</span>,</span>
<span id="cb3-7"><a href="#cb3-7" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<span id="cb3-7"><a href="#cb3-7" aria-hidden="true" tabindex="-1"></a> use_exec<span class="op">=</span><span class="va">False</span>,</span>
<span id="cb3-8"><a href="#cb3-8" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>Execute training with the given configuration.</p>

12
docs/api/integrations.base.html
View File

@@ -689,7 +689,7 @@ training.</p>
</tr>
<tr class="odd">
<td><a href="#axolotl.integrations.base.BasePlugin.register">register</a></td>
<td>Registers the plugin with the given configuration.</td>
<td>Registers the plugin with the given configuration as an unparsed dict.</td>
</tr>
</tbody>
</table>
@@ -1469,16 +1469,10 @@ callbacks that require access to the model or trainer.</p>
<section id="axolotl.integrations.base.BasePlugin.register" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.BasePlugin.register">register</h5>
<div class="sourceCode" id="cb22"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb22-1"><a href="#cb22-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.register(cfg)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>Registers the plugin with the given configuration.</p>
<p>Registers the plugin with the given configuration as an unparsed dict.</p>
<section id="parameters-16" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-16">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 11%">
<col style="width: 19%">
<col style="width: 51%">
<col style="width: 17%">
</colgroup>
<thead>
<tr class="header">
<th>Name</th>
@@ -1490,7 +1484,7 @@ callbacks that require access to the model or trainer.</p>
<tbody>
<tr class="odd">
<td>cfg</td>
<td>DictDefault</td>
<td>dict</td>
<td>The configuration for the plugin.</td>
<td><em>required</em></td>
</tr>