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-07-30 19:52:35 +00:00
parent b1bf58e8e6
commit ca0e437362
17 changed files with 7424 additions and 1811 deletions
Download Patch File Download Diff File Expand all files Collapse all files

121
docs/api/cli.main.html
View File

@@ -560,16 +560,16 @@ gtag('config', 'G-9KYCVJBNMQ', { 'anonymize_ip': true});
</section>
<section id="axolotl.cli.main.evaluate" class="level3">
<h3 class="anchored" data-anchor-id="axolotl.cli.main.evaluate">evaluate</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.main.evaluate(config, accelerate, <span class="op">**</span>kwargs)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<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.main.evaluate(ctx, config, launcher, <span class="op">**</span>kwargs)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>Evaluate a model.</p>
<section id="parameters" class="level4 doc-section doc-section-parameters">
<h4 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters">Parameters</h4>
<table class="caption-top table">
<colgroup>
<col style="width: 10%">
<col style="width: 6%">
<col style="width: 73%">
<col style="width: 10%">
<col style="width: 8%">
<col style="width: 12%">
<col style="width: 70%">
<col style="width: 9%">
</colgroup>
<thead>
<tr class="header">
@@ -581,18 +581,24 @@ gtag('config', 'G-9KYCVJBNMQ', { 'anonymize_ip': true});
</thead>
<tbody>
<tr class="odd">
<td>ctx</td>
<td>click.Context</td>
<td>Click context for extra args.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>config</td>
<td>str</td>
<td>Path to <code>axolotl</code> config YAML file.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>accelerate</td>
<td>bool</td>
<td>Whether to use <code>accelerate</code> launcher.</td>
<tr class="odd">
<td>launcher</td>
<td>str</td>
<td>Launcher to use for multi-GPU evaluation (“accelerate”, “torchrun”, or “python”).</td>
<td><em>required</em></td>
</tr>
<tr class="odd">
<tr class="even">
<td>kwargs</td>
<td></td>
<td>Additional keyword arguments which correspond to CLI args or <code>axolotl</code> config options.</td>
@@ -645,16 +651,16 @@ gtag('config', 'G-9KYCVJBNMQ', { 'anonymize_ip': true});
</section>
<section id="axolotl.cli.main.inference" class="level3">
<h3 class="anchored" data-anchor-id="axolotl.cli.main.inference">inference</h3>
<div class="sourceCode" id="cb4"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a>cli.main.inference(config, accelerate, gradio, <span class="op">**</span>kwargs)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="sourceCode" id="cb4"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a>cli.main.inference(ctx, config, launcher, gradio, <span class="op">**</span>kwargs)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>Run inference with a trained model.</p>
<section id="parameters-2" class="level4 doc-section doc-section-parameters">
<h4 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-2">Parameters</h4>
<table class="caption-top table">
<colgroup>
<col style="width: 10%">
<col style="width: 6%">
<col style="width: 73%">
<col style="width: 10%">
<col style="width: 8%">
<col style="width: 12%">
<col style="width: 70%">
<col style="width: 9%">
</colgroup>
<thead>
<tr class="header">
@@ -666,24 +672,30 @@ gtag('config', 'G-9KYCVJBNMQ', { 'anonymize_ip': true});
</thead>
<tbody>
<tr class="odd">
<td>ctx</td>
<td>click.Context</td>
<td>Click context for extra args.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>config</td>
<td>str</td>
<td>Path to <code>axolotl</code> config YAML file.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>accelerate</td>
<td>bool</td>
<td>Whether to use <code>accelerate</code> launcher.</td>
<tr class="odd">
<td>launcher</td>
<td>str</td>
<td>Launcher to use for multi-GPU inference (“accelerate”, “torchrun”, or “python”).</td>
<td><em>required</em></td>
</tr>
<tr class="odd">
<tr class="even">
<td>gradio</td>
<td>bool</td>
<td>Whether to use Gradio browser interface or command line for inference.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<tr class="odd">
<td>kwargs</td>
<td></td>
<td>Additional keyword arguments which correspond to CLI args or <code>axolotl</code> config options.</td>
@@ -733,16 +745,16 @@ gtag('config', 'G-9KYCVJBNMQ', { 'anonymize_ip': true});
</section>
<section id="axolotl.cli.main.merge_sharded_fsdp_weights" class="level3">
<h3 class="anchored" data-anchor-id="axolotl.cli.main.merge_sharded_fsdp_weights">merge_sharded_fsdp_weights</h3>
<div class="sourceCode" id="cb6"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a>cli.main.merge_sharded_fsdp_weights(config, accelerate, <span class="op">**</span>kwargs)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="sourceCode" id="cb6"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a>cli.main.merge_sharded_fsdp_weights(ctx, config, launcher, <span class="op">**</span>kwargs)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>Merge sharded FSDP model weights.</p>
<section id="parameters-4" class="level4 doc-section doc-section-parameters">
<h4 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-4">Parameters</h4>
<table class="caption-top table">
<colgroup>
<col style="width: 10%">
<col style="width: 6%">
<col style="width: 73%">
<col style="width: 10%">
<col style="width: 8%">
<col style="width: 12%">
<col style="width: 70%">
<col style="width: 9%">
</colgroup>
<thead>
<tr class="header">
@@ -754,18 +766,24 @@ gtag('config', 'G-9KYCVJBNMQ', { 'anonymize_ip': true});
</thead>
<tbody>
<tr class="odd">
<td>ctx</td>
<td>click.Context</td>
<td>Click context for extra args.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>config</td>
<td>str</td>
<td>Path to <code>axolotl</code> config YAML file.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>accelerate</td>
<td>bool</td>
<td>Whether to use <code>accelerate</code> launcher.</td>
<tr class="odd">
<td>launcher</td>
<td>str</td>
<td>Launcher to use for weight merging (“accelerate”, “torchrun”, or “python”).</td>
<td><em>required</em></td>
</tr>
<tr class="odd">
<tr class="even">
<td>kwargs</td>
<td></td>
<td>Additional keyword arguments which correspond to CLI args or <code>axolotl</code> config options.</td>
@@ -821,15 +839,22 @@ gtag('config', 'G-9KYCVJBNMQ', { 'anonymize_ip': true});
</section>
<section id="axolotl.cli.main.train" class="level3">
<h3 class="anchored" data-anchor-id="axolotl.cli.main.train">train</h3>
<div class="sourceCode" id="cb8"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a>cli.main.train(config, accelerate, cloud<span class="op">=</span><span class="va">None</span>, sweep<span class="op">=</span><span class="va">None</span>, <span class="op">**</span>kwargs)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="sourceCode" id="cb8"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a>cli.main.train(</span>
<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a> ctx,</span>
<span id="cb8-3"><a href="#cb8-3" aria-hidden="true" tabindex="-1"></a> config,</span>
<span id="cb8-4"><a href="#cb8-4" aria-hidden="true" tabindex="-1"></a> launcher<span class="op">=</span><span class="st">'accelerate'</span>,</span>
<span id="cb8-5"><a href="#cb8-5" aria-hidden="true" tabindex="-1"></a> cloud<span class="op">=</span><span class="va">None</span>,</span>
<span id="cb8-6"><a href="#cb8-6" aria-hidden="true" tabindex="-1"></a> sweep<span class="op">=</span><span class="va">None</span>,</span>
<span id="cb8-7"><a href="#cb8-7" aria-hidden="true" tabindex="-1"></a> <span class="op">**</span>kwargs,</span>
<span id="cb8-8"><a href="#cb8-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>Train or fine-tune a model.</p>
<section id="parameters-6" class="level4 doc-section doc-section-parameters">
<h4 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-6">Parameters</h4>
<table class="caption-top table">
<colgroup>
<col style="width: 9%">
<col style="width: 13%">
<col style="width: 68%">
<col style="width: 5%">
<col style="width: 31%">
<col style="width: 52%">
<col style="width: 9%">
</colgroup>
<thead>
@@ -842,30 +867,36 @@ gtag('config', 'G-9KYCVJBNMQ', { 'anonymize_ip': true});
</thead>
<tbody>
<tr class="odd">
<td>ctx</td>
<td>click.Context</td>
<td>Click context for extra args.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>config</td>
<td>str</td>
<td>Path to <code>axolotl</code> config YAML file.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>accelerate</td>
<td>bool</td>
<td>Whether to use <code>accelerate</code> launcher.</td>
<td><em>required</em></td>
</tr>
<tr class="odd">
<td>launcher</td>
<td>Literal['accelerate', 'torchrun', 'python']</td>
<td>Launcher to use for multi-GPU training (“accelerate”, “torchrun”, or “python”).</td>
<td><code>'accelerate'</code></td>
</tr>
<tr class="even">
<td>cloud</td>
<td>Optional[str]</td>
<td>str | None</td>
<td>Path to a cloud accelerator configuration file</td>
<td><code>None</code></td>
</tr>
<tr class="even">
<tr class="odd">
<td>sweep</td>
<td>Optional[str]</td>
<td>str | None</td>
<td>Path to YAML config for sweeping hyperparameters.</td>
<td><code>None</code></td>
</tr>
<tr class="odd">
<tr class="even">
<td>kwargs</td>
<td></td>
<td>Additional keyword arguments which correspond to CLI args or <code>axolotl</code> config options.</td>