Built site for gh-pages

docs/api/cli.inference.html

@@ -536,7 +536,7 @@ gtag('config', 'G-9KYCVJBNMQ', { 'anonymize_ip': true});
 </tr>
 <tr class="even">
 <td><a href="#axolotl.cli.inference.do_inference">do_inference</a></td>
-<td>Runs inference on the command line in a loop. User input is accepted, a chat template</td>
+<td>Runs inference on the command line in a loop. User input is accepted, a chat</td>
 </tr>
 <tr class="odd">
 <td><a href="#axolotl.cli.inference.do_inference_gradio">do_inference_gradio</a></td>
@@ -589,9 +589,9 @@ gtag('config', 'G-9KYCVJBNMQ', { 'anonymize_ip': true});
 <section id="axolotl.cli.inference.do_inference" class="level3">
 <h3 class="anchored" data-anchor-id="axolotl.cli.inference.do_inference">do_inference</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.inference.do_inference(cfg, cli_args)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
-<p>Runs inference on the command line in a loop. User input is accepted, a chat template
-is (optionally) applied, and the model specified in the <code>axolotl</code> config is used to
-generate completions according to a default generation config.</p>
+<p>Runs inference on the command line in a loop. User input is accepted, a chat
+template is (optionally) applied, and the model specified in the <code>axolotl</code> config is
+used to generate completions according to a default generation config.</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">

docs/api/core.trainers.base.html

@@ -561,6 +561,10 @@ gtag('config', 'G-9KYCVJBNMQ', { 'anonymize_ip': true});
 <td><a href="#axolotl.core.trainers.base.AxolotlTrainer.push_to_hub">push_to_hub</a></td>
 <td>Overwrite the <code>push_to_hub</code> method in order to force-add the tags when pushing the</td>
 </tr>
+<tr class="odd">
+<td><a href="#axolotl.core.trainers.base.AxolotlTrainer.store_metrics">store_metrics</a></td>
+<td>Store metrics with specified reduction type.</td>
+</tr>
 </tbody>
 </table>
 <section id="axolotl.core.trainers.base.AxolotlTrainer.log" class="level5">
@@ -606,6 +610,47 @@ gtag('config', 'G-9KYCVJBNMQ', { 'anonymize_ip': true});
 <div class="sourceCode" id="cb3"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a>core.trainers.base.AxolotlTrainer.push_to_hub(<span class="op">*</span>args, <span class="op">**</span>kwargs)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 <p>Overwrite the <code>push_to_hub</code> method in order to force-add the tags when pushing the
 model on the Hub. Please refer to <code>~transformers.Trainer.push_to_hub</code> for more details.</p>
+</section>
+<section id="axolotl.core.trainers.base.AxolotlTrainer.store_metrics" class="level5">
+<h5 class="anchored" data-anchor-id="axolotl.core.trainers.base.AxolotlTrainer.store_metrics">store_metrics</h5>
+<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>core.trainers.base.AxolotlTrainer.store_metrics(</span>
+<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a>    metrics,</span>
+<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a>    train_eval<span class="op">=</span><span class="st">'train'</span>,</span>
+<span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a>    reduction<span class="op">=</span><span class="st">'mean'</span>,</span>
+<span id="cb4-5"><a href="#cb4-5" 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>Store metrics with specified reduction type.</p>
+<section id="parameters-1" class="level6 doc-section doc-section-parameters">
+<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-1">Parameters</h6>
+<table class="caption-top table">
+<colgroup>
+<col style="width: 6%">
+<col style="width: 35%">
+<col style="width: 50%">
+<col style="width: 6%">
+</colgroup>
+<thead>
+<tr class="header">
+<th>Name</th>
+<th>Type</th>
+<th>Description</th>
+<th>Default</th>
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
+<td>metrics</td>
+<td>dict[str, float] | dict[str, tuple[int | float, str]]</td>
+<td>Dictionary of metric names to values, or metric names to (value, reduction_type) tuples.</td>
+<td><em>required</em></td>
+</tr>
+<tr class="even">
+<td>train_eval</td>
+<td>Literal['train', 'eval']</td>
+<td>Whether this is for training or evaluation.</td>
+<td><code>'train'</code></td>
+</tr>
+</tbody>
+</table>
 
 
 </section>
@@ -613,6 +658,7 @@ model on the Hub. Please refer to <code>~transformers.Trainer.push_to_hub</code>
 </section>
 </section>
 </section>
+</section>
 
 </main> <!-- /main -->
 <script id="quarto-html-after-body" type="application/javascript">

docs/api/integrations.base.html

@@ -1047,9 +1047,9 @@ callbacks that require access to the model or trainer.</p>
 <h6 class="doc-section doc-section-returns anchored" data-anchor-id="returns-5">Returns</h6>
 <table class="caption-top table">
 <colgroup>
-<col style="width: 9%">
-<col style="width: 20%">
-<col style="width: 69%">
+<col style="width: 8%">
+<col style="width: 27%">
+<col style="width: 63%">
 </colgroup>
 <thead>
 <tr class="header">
@@ -1061,7 +1061,7 @@ callbacks that require access to the model or trainer.</p>
 <tbody>
 <tr class="odd">
 <td></td>
-<td>Trainer | None</td>
+<td>type[Trainer] | None</td>
 <td>The first non-<code>None</code> trainer class returned by a plugin.</td>
 </tr>
 </tbody>