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
2026-03-25 15:27:19 +00:00
parent 1d736a2a49
commit 857c949129
4 changed files with 536 additions and 387 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -921,38 +921,42 @@ training.</p>
<td>Loads and preprocesses the dataset for training.</td>
</tr>
<tr class="odd">
<td><a href="#axolotl.integrations.base.BasePlugin.on_rollouts_scored">on_rollouts_scored</a></td>
<td>Called after rollouts are scored during online RL (GRPO/PPO).</td>
</tr>
<tr class="even">
<td><a href="#axolotl.integrations.base.BasePlugin.post_lora_load">post_lora_load</a></td>
<td>Performs actions after LoRA weights are loaded.</td>
</tr>
<tr class="even">
<tr class="odd">
<td><a href="#axolotl.integrations.base.BasePlugin.post_model_build">post_model_build</a></td>
<td>Performs actions after the model is built/loaded, but before any adapters are applied.</td>
</tr>
<tr class="odd">
<tr class="even">
<td><a href="#axolotl.integrations.base.BasePlugin.post_model_load">post_model_load</a></td>
<td>Performs actions after the model is loaded.</td>
</tr>
<tr class="even">
<tr class="odd">
<td><a href="#axolotl.integrations.base.BasePlugin.post_train">post_train</a></td>
<td>Performs actions after training is complete.</td>
</tr>
<tr class="odd">
<tr class="even">
<td><a href="#axolotl.integrations.base.BasePlugin.post_train_unload">post_train_unload</a></td>
<td>Performs actions after training is complete and the model is unloaded.</td>
</tr>
<tr class="even">
<tr class="odd">
<td><a href="#axolotl.integrations.base.BasePlugin.post_trainer_create">post_trainer_create</a></td>
<td>Performs actions after the trainer is created.</td>
</tr>
<tr class="odd">
<tr class="even">
<td><a href="#axolotl.integrations.base.BasePlugin.pre_lora_load">pre_lora_load</a></td>
<td>Performs actions before LoRA weights are loaded.</td>
</tr>
<tr class="even">
<tr class="odd">
<td><a href="#axolotl.integrations.base.BasePlugin.pre_model_load">pre_model_load</a></td>
<td>Performs actions before the model is loaded.</td>
</tr>
<tr class="odd">
<tr class="even">
<td><a href="#axolotl.integrations.base.BasePlugin.register">register</a></td>
<td>Registers the plugin with the given configuration as an unparsed dict.</td>
</tr>
@@ -1445,14 +1449,86 @@ callbacks that require access to the model or trainer.</p>
</table>
</section>
</section>
<section id="axolotl.integrations.base.BasePlugin.post_lora_load" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.BasePlugin.post_lora_load">post_lora_load</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb14"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.post_lora_load(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Performs actions after LoRA weights are loaded.</p>
<section id="axolotl.integrations.base.BasePlugin.on_rollouts_scored" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.BasePlugin.on_rollouts_scored">on_rollouts_scored</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb14"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.on_rollouts_scored(</span>
<span id="cb14-2"><a href="#cb14-2" aria-hidden="true" tabindex="-1"></a> cfg,</span>
<span id="cb14-3"><a href="#cb14-3" aria-hidden="true" tabindex="-1"></a> trainer,</span>
<span id="cb14-4"><a href="#cb14-4" aria-hidden="true" tabindex="-1"></a> prompts,</span>
<span id="cb14-5"><a href="#cb14-5" aria-hidden="true" tabindex="-1"></a> completions,</span>
<span id="cb14-6"><a href="#cb14-6" aria-hidden="true" tabindex="-1"></a> rewards,</span>
<span id="cb14-7"><a href="#cb14-7" aria-hidden="true" tabindex="-1"></a> advantages,</span>
<span id="cb14-8"><a href="#cb14-8" aria-hidden="true" tabindex="-1"></a>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Called after rollouts are scored during online RL (GRPO/PPO).</p>
<p>Provides access to the full scored rollout data for logging, trace
storage, or analysis. Called once per scoring step with all samples
from that step.</p>
<section id="parameters-8" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-8">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 11%">
<col style="width: 24%">
<col style="width: 53%">
<col style="width: 10%">
</colgroup>
<thead>
<tr class="header">
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>cfg</td>
<td>DictDefault</td>
<td>The axolotl configuration.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>trainer</td>
<td></td>
<td>The trainer instance.</td>
<td><em>required</em></td>
</tr>
<tr class="odd">
<td>prompts</td>
<td>list[str]</td>
<td>List of prompt texts (one per sample).</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>completions</td>
<td>list[str]</td>
<td>List of completion texts (one per sample).</td>
<td><em>required</em></td>
</tr>
<tr class="odd">
<td>rewards</td>
<td>dict[str, list[float]]</td>
<td>Dict mapping reward function name to list of reward values.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>advantages</td>
<td>list[float]</td>
<td>List of advantage values (one per sample).</td>
<td><em>required</em></td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="axolotl.integrations.base.BasePlugin.post_lora_load" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.BasePlugin.post_lora_load">post_lora_load</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb15"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.post_lora_load(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Performs actions after LoRA weights are loaded.</p>
<section id="parameters-9" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-9">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 9%">
<col style="width: 35%">
<col style="width: 41%">
@@ -1485,10 +1561,10 @@ callbacks that require access to the model or trainer.</p>
</section>
<section id="axolotl.integrations.base.BasePlugin.post_model_build" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.BasePlugin.post_model_build">post_model_build</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb15"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.post_model_build(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb16"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.post_model_build(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Performs actions after the model is built/loaded, but before any adapters are applied.</p>
<section id="parameters-9" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-9">Parameters</h6>
<section id="parameters-10" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-10">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 11%">
@@ -1517,10 +1593,10 @@ callbacks that require access to the model or trainer.</p>
</section>
<section id="axolotl.integrations.base.BasePlugin.post_model_load" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.BasePlugin.post_model_load">post_model_load</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb16"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.post_model_load(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb17"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb17-1"><a href="#cb17-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.post_model_load(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Performs actions after the model is loaded.</p>
<section id="parameters-10" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-10">Parameters</h6>
<section id="parameters-11" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-11">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 9%">
@@ -1555,10 +1631,10 @@ callbacks that require access to the model or trainer.</p>
</section>
<section id="axolotl.integrations.base.BasePlugin.post_train" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.BasePlugin.post_train">post_train</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb17"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb17-1"><a href="#cb17-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.post_train(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb18"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb18-1"><a href="#cb18-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.post_train(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Performs actions after training is complete.</p>
<section id="parameters-11" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-11">Parameters</h6>
<section id="parameters-12" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-12">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 10%">
@@ -1593,10 +1669,10 @@ callbacks that require access to the model or trainer.</p>
</section>
<section id="axolotl.integrations.base.BasePlugin.post_train_unload" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.BasePlugin.post_train_unload">post_train_unload</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb18"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb18-1"><a href="#cb18-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.post_train_unload(cfg)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb19"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb19-1"><a href="#cb19-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.post_train_unload(cfg)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Performs actions after training is complete and the model is unloaded.</p>
<section id="parameters-12" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-12">Parameters</h6>
<section id="parameters-13" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-13">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 11%">
@@ -1625,10 +1701,10 @@ callbacks that require access to the model or trainer.</p>
</section>
<section id="axolotl.integrations.base.BasePlugin.post_trainer_create" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.BasePlugin.post_trainer_create">post_trainer_create</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb19"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb19-1"><a href="#cb19-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.post_trainer_create(cfg, trainer)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb20"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb20-1"><a href="#cb20-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.post_trainer_create(cfg, trainer)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Performs actions after the trainer is created.</p>
<section id="parameters-13" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-13">Parameters</h6>
<section id="parameters-14" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-14">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 13%">
@@ -1663,10 +1739,10 @@ callbacks that require access to the model or trainer.</p>
</section>
<section id="axolotl.integrations.base.BasePlugin.pre_lora_load" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.BasePlugin.pre_lora_load">pre_lora_load</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb20"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb20-1"><a href="#cb20-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.pre_lora_load(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb21"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb21-1"><a href="#cb21-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.pre_lora_load(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Performs actions before LoRA weights are loaded.</p>
<section id="parameters-14" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-14">Parameters</h6>
<section id="parameters-15" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-15">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 11%">
@@ -1701,10 +1777,10 @@ callbacks that require access to the model or trainer.</p>
</section>
<section id="axolotl.integrations.base.BasePlugin.pre_model_load" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.BasePlugin.pre_model_load">pre_model_load</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb21"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb21-1"><a href="#cb21-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.pre_model_load(cfg)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><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.pre_model_load(cfg)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Performs actions before the model is loaded.</p>
<section id="parameters-15" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-15">Parameters</h6>
<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%">
@@ -1733,10 +1809,10 @@ callbacks that require access to the model or trainer.</p>
</section>
<section id="axolotl.integrations.base.BasePlugin.register" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.BasePlugin.register">register</h5>
<div class="code-copy-outer-scaffold"><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></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb23"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb23-1"><a href="#cb23-1" aria-hidden="true" tabindex="-1"></a>integrations.base.BasePlugin.register(cfg)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<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>
<section id="parameters-17" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-17">Parameters</h6>
<table class="caption-top table">
<thead>
<tr class="header">
@@ -1761,7 +1837,7 @@ callbacks that require access to the model or trainer.</p>
</section>
<section id="axolotl.integrations.base.PluginManager" class="level3">
<h3 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager">PluginManager</h3>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb23"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb23-1"><a href="#cb23-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager()</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb24"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb24-1"><a href="#cb24-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager()</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>The <code>PluginManager</code> class is responsible for loading and managing plugins. It
should be a singleton so it can be accessed from anywhere in the codebase.</p>
<section id="attributes" class="level4 doc-section doc-section-attributes">
@@ -1845,38 +1921,42 @@ should be a singleton so it can be accessed from anywhere in the codebase.</p>
<td>Calls the load_datasets method of each registered plugin.</td>
</tr>
<tr class="even">
<td><a href="#axolotl.integrations.base.PluginManager.on_rollouts_scored">on_rollouts_scored</a></td>
<td>Calls the on_rollouts_scored method of all registered plugins.</td>
</tr>
<tr class="odd">
<td><a href="#axolotl.integrations.base.PluginManager.post_lora_load">post_lora_load</a></td>
<td>Calls the <code>post_lora_load</code> method of all registered plugins.</td>
</tr>
<tr class="odd">
<tr class="even">
<td><a href="#axolotl.integrations.base.PluginManager.post_model_build">post_model_build</a></td>
<td>Calls the <code>post_model_build</code> method of all registered plugins after the</td>
</tr>
<tr class="even">
<tr class="odd">
<td><a href="#axolotl.integrations.base.PluginManager.post_model_load">post_model_load</a></td>
<td>Calls the <code>post_model_load</code> method of all registered plugins after the model</td>
</tr>
<tr class="odd">
<tr class="even">
<td><a href="#axolotl.integrations.base.PluginManager.post_train">post_train</a></td>
<td>Calls the post_train method of all registered plugins.</td>
</tr>
<tr class="even">
<tr class="odd">
<td><a href="#axolotl.integrations.base.PluginManager.post_train_unload">post_train_unload</a></td>
<td>Calls the post_train_unload method of all registered plugins.</td>
</tr>
<tr class="odd">
<tr class="even">
<td><a href="#axolotl.integrations.base.PluginManager.post_trainer_create">post_trainer_create</a></td>
<td>Calls the <code>post_trainer_create</code> method of all registered plugins.</td>
</tr>
<tr class="even">
<tr class="odd">
<td><a href="#axolotl.integrations.base.PluginManager.pre_lora_load">pre_lora_load</a></td>
<td>Calls the <code>pre_lora_load</code> method of all registered plugins.</td>
</tr>
<tr class="odd">
<tr class="even">
<td><a href="#axolotl.integrations.base.PluginManager.pre_model_load">pre_model_load</a></td>
<td>Calls the pre_model_load method of all registered plugins.</td>
</tr>
<tr class="even">
<tr class="odd">
<td><a href="#axolotl.integrations.base.PluginManager.register">register</a></td>
<td>Registers a new plugin by its name.</td>
</tr>
@@ -1884,10 +1964,10 @@ should be a singleton so it can be accessed from anywhere in the codebase.</p>
</table>
<section id="axolotl.integrations.base.PluginManager.add_callbacks_post_trainer" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.add_callbacks_post_trainer">add_callbacks_post_trainer</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb24"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb24-1"><a href="#cb24-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.add_callbacks_post_trainer(cfg, trainer)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb25"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb25-1"><a href="#cb25-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.add_callbacks_post_trainer(cfg, trainer)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the <code>add_callbacks_post_trainer</code> method of all registered plugins.</p>
<section id="parameters-17" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-17">Parameters</h6>
<section id="parameters-18" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-18">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 12%">
@@ -1946,10 +2026,10 @@ should be a singleton so it can be accessed from anywhere in the codebase.</p>
</section>
<section id="axolotl.integrations.base.PluginManager.add_callbacks_pre_trainer" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.add_callbacks_pre_trainer">add_callbacks_pre_trainer</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb25"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb25-1"><a href="#cb25-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.add_callbacks_pre_trainer(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb26"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb26-1"><a href="#cb26-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.add_callbacks_pre_trainer(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the add_callbacks_pre_trainer method of all registered plugins.</p>
<section id="parameters-18" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-18">Parameters</h6>
<section id="parameters-19" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-19">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 10%">
@@ -2008,15 +2088,15 @@ should be a singleton so it can be accessed from anywhere in the codebase.</p>
</section>
<section id="axolotl.integrations.base.PluginManager.create_lr_scheduler" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.create_lr_scheduler">create_lr_scheduler</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb26"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb26-1"><a href="#cb26-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.create_lr_scheduler(</span>
<span id="cb26-2"><a href="#cb26-2" aria-hidden="true" tabindex="-1"></a> trainer,</span>
<span id="cb26-3"><a href="#cb26-3" aria-hidden="true" tabindex="-1"></a> optimizer,</span>
<span id="cb26-4"><a href="#cb26-4" aria-hidden="true" tabindex="-1"></a> num_training_steps,</span>
<span id="cb26-5"><a href="#cb26-5" aria-hidden="true" tabindex="-1"></a>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb27"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb27-1"><a href="#cb27-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.create_lr_scheduler(</span>
<span id="cb27-2"><a href="#cb27-2" aria-hidden="true" tabindex="-1"></a> trainer,</span>
<span id="cb27-3"><a href="#cb27-3" aria-hidden="true" tabindex="-1"></a> optimizer,</span>
<span id="cb27-4"><a href="#cb27-4" aria-hidden="true" tabindex="-1"></a> num_training_steps,</span>
<span id="cb27-5"><a href="#cb27-5" aria-hidden="true" tabindex="-1"></a>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the <code>create_lr_scheduler</code> method of all registered plugins and returns
the first non-<code>None</code> scheduler.</p>
<section id="parameters-19" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-19">Parameters</h6>
<section id="parameters-20" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-20">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 16%">
@@ -2075,11 +2155,11 @@ the first non-<code>None</code> scheduler.</p>
</section>
<section id="axolotl.integrations.base.PluginManager.create_optimizer" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.create_optimizer">create_optimizer</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb27"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb27-1"><a href="#cb27-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.create_optimizer(trainer)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb28"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb28-1"><a href="#cb28-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.create_optimizer(trainer)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the <code>create_optimizer</code> method of all registered plugins and returns
the first non-<code>None</code> optimizer.</p>
<section id="parameters-20" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-20">Parameters</h6>
<section id="parameters-21" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-21">Parameters</h6>
<table class="caption-top table">
<thead>
<tr class="header">
@@ -2126,7 +2206,7 @@ the first non-<code>None</code> optimizer.</p>
</section>
<section id="axolotl.integrations.base.PluginManager.get_collator_cls_and_kwargs" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.get_collator_cls_and_kwargs">get_collator_cls_and_kwargs</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb28"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb28-1"><a href="#cb28-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.get_collator_cls_and_kwargs(cfg, is_eval<span class="op">=</span><span class="va">False</span>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb29"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb29-1"><a href="#cb29-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.get_collator_cls_and_kwargs(cfg, is_eval<span class="op">=</span><span class="va">False</span>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the get_collator_cls_and_kwargs method of all registered plugins and returns the first non-None collator class.</p>
<p>Parameters:
cfg (dict): The configuration for the plugins.
@@ -2136,7 +2216,7 @@ object: The collator class, or None if none was found.</p>
</section>
<section id="axolotl.integrations.base.PluginManager.get_input_args" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.get_input_args">get_input_args</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb29"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb29-1"><a href="#cb29-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.get_input_args()</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb30"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb30-1"><a href="#cb30-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.get_input_args()</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Returns a list of Pydantic classes for all registered plugins’ input arguments.’</p>
<section id="returns-12" class="level6 doc-section doc-section-returns">
<h6 class="doc-section doc-section-returns anchored" data-anchor-id="returns-12">Returns</h6>
@@ -2165,17 +2245,17 @@ object: The collator class, or None if none was found.</p>
</section>
<section id="axolotl.integrations.base.PluginManager.get_instance" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.get_instance">get_instance</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb30"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb30-1"><a href="#cb30-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.get_instance()</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb31"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb31-1"><a href="#cb31-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.get_instance()</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Returns the singleton instance of PluginManager. If the instance doesn’t
exist, it creates a new one.</p>
</section>
<section id="axolotl.integrations.base.PluginManager.get_trainer_cls" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.get_trainer_cls">get_trainer_cls</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb31"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb31-1"><a href="#cb31-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.get_trainer_cls(cfg)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb32"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb32-1"><a href="#cb32-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.get_trainer_cls(cfg)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the <code>get_trainer_cls</code> method of all registered plugins and returns the
first non-<code>None</code> trainer class.</p>
<section id="parameters-21" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-21">Parameters</h6>
<section id="parameters-22" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-22">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 11%">
@@ -2228,7 +2308,7 @@ first non-<code>None</code> trainer class.</p>
</section>
<section id="axolotl.integrations.base.PluginManager.get_training_args" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.get_training_args">get_training_args</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb32"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb32-1"><a href="#cb32-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.get_training_args(cfg)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb33"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb33-1"><a href="#cb33-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.get_training_args(cfg)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the get_training_args method of all registered plugins and returns the combined training arguments.</p>
<p>Parameters:
cfg (dict): The configuration for the plugins.</p>
@@ -2237,17 +2317,17 @@ object: The training arguments</p>
</section>
<section id="axolotl.integrations.base.PluginManager.get_training_args_mixin" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.get_training_args_mixin">get_training_args_mixin</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb33"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb33-1"><a href="#cb33-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.get_training_args_mixin()</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb34"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb34-1"><a href="#cb34-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.get_training_args_mixin()</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Returns a list of dataclasses for all registered plugins’ training args mixins’</p>
<p>Returns:
list[str]: A list of dataclsses</p>
</section>
<section id="axolotl.integrations.base.PluginManager.load_datasets" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.load_datasets">load_datasets</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb34"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb34-1"><a href="#cb34-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.load_datasets(cfg, preprocess<span class="op">=</span><span class="va">False</span>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb35"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb35-1"><a href="#cb35-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.load_datasets(cfg, preprocess<span class="op">=</span><span class="va">False</span>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the load_datasets method of each registered plugin.</p>
<section id="parameters-22" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-22">Parameters</h6>
<section id="parameters-23" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-23">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 13%">
@@ -2304,57 +2384,25 @@ list[str]: A list of dataclsses</p>
</table>
</section>
</section>
<section id="axolotl.integrations.base.PluginManager.post_lora_load" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.post_lora_load">post_lora_load</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb35"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb35-1"><a href="#cb35-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.post_lora_load(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the <code>post_lora_load</code> method of all registered plugins.</p>
<section id="parameters-23" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-23">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 9%">
<col style="width: 34%">
<col style="width: 41%">
<col style="width: 13%">
</colgroup>
<thead>
<tr class="header">
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>cfg</td>
<td>DictDefault</td>
<td>The configuration for the plugins.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>model</td>
<td>PreTrainedModel | PeftModel</td>
<td>The loaded model.</td>
<td><em>required</em></td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="axolotl.integrations.base.PluginManager.post_model_build" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.post_model_build">post_model_build</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb36"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb36-1"><a href="#cb36-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.post_model_build(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the <code>post_model_build</code> method of all registered plugins after the
model has been built / loaded, but before any adapters have been applied.</p>
<section id="axolotl.integrations.base.PluginManager.on_rollouts_scored" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.on_rollouts_scored">on_rollouts_scored</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb36"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb36-1"><a href="#cb36-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.on_rollouts_scored(</span>
<span id="cb36-2"><a href="#cb36-2" aria-hidden="true" tabindex="-1"></a> cfg,</span>
<span id="cb36-3"><a href="#cb36-3" aria-hidden="true" tabindex="-1"></a> trainer,</span>
<span id="cb36-4"><a href="#cb36-4" aria-hidden="true" tabindex="-1"></a> prompts,</span>
<span id="cb36-5"><a href="#cb36-5" aria-hidden="true" tabindex="-1"></a> completions,</span>
<span id="cb36-6"><a href="#cb36-6" aria-hidden="true" tabindex="-1"></a> rewards,</span>
<span id="cb36-7"><a href="#cb36-7" aria-hidden="true" tabindex="-1"></a> advantages,</span>
<span id="cb36-8"><a href="#cb36-8" aria-hidden="true" tabindex="-1"></a>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the on_rollouts_scored method of all registered plugins.</p>
<section id="parameters-24" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-24">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 10%">
<col style="width: 23%">
<col style="width: 49%">
<col style="width: 16%">
<col style="width: 12%">
<col style="width: 25%">
<col style="width: 50%">
<col style="width: 11%">
</colgroup>
<thead>
<tr class="header">
@@ -2372,20 +2420,43 @@ model has been built / loaded, but before any adapters have been applied.</p>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>model</td>
<td>PreTrainedModel</td>
<td>The loaded model.</td>
<td>trainer</td>
<td></td>
<td>The trainer instance.</td>
<td><em>required</em></td>
</tr>
<tr class="odd">
<td>prompts</td>
<td>list[str]</td>
<td>List of prompt texts.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>completions</td>
<td>list[str]</td>
<td>List of completion texts.</td>
<td><em>required</em></td>
</tr>
<tr class="odd">
<td>rewards</td>
<td>dict[str, list[float]]</td>
<td>Dict mapping reward function name to list of rewards.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>advantages</td>
<td>list[float]</td>
<td>List of advantage values.</td>
<td><em>required</em></td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="axolotl.integrations.base.PluginManager.post_model_load" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.post_model_load">post_model_load</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb37"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb37-1"><a href="#cb37-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.post_model_load(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the <code>post_model_load</code> method of all registered plugins after the model
has been loaded inclusive of any adapters.</p>
<section id="axolotl.integrations.base.PluginManager.post_lora_load" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.post_lora_load">post_lora_load</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb37"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb37-1"><a href="#cb37-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.post_lora_load(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the <code>post_lora_load</code> method of all registered plugins.</p>
<section id="parameters-25" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-25">Parameters</h6>
<table class="caption-top table">
@@ -2420,14 +2491,92 @@ has been loaded inclusive of any adapters.</p>
</table>
</section>
</section>
<section id="axolotl.integrations.base.PluginManager.post_train" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.post_train">post_train</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb38"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb38-1"><a href="#cb38-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.post_train(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the post_train method of all registered plugins.</p>
<section id="axolotl.integrations.base.PluginManager.post_model_build" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.post_model_build">post_model_build</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb38"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb38-1"><a href="#cb38-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.post_model_build(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the <code>post_model_build</code> method of all registered plugins after the
model has been built / loaded, but before any adapters have been applied.</p>
<section id="parameters-26" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-26">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 10%">
<col style="width: 23%">
<col style="width: 49%">
<col style="width: 16%">
</colgroup>
<thead>
<tr class="header">
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>cfg</td>
<td>DictDefault</td>
<td>The configuration for the plugins.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>model</td>
<td>PreTrainedModel</td>
<td>The loaded model.</td>
<td><em>required</em></td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="axolotl.integrations.base.PluginManager.post_model_load" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.post_model_load">post_model_load</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb39"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb39-1"><a href="#cb39-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.post_model_load(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the <code>post_model_load</code> method of all registered plugins after the model
has been loaded inclusive of any adapters.</p>
<section id="parameters-27" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-27">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 9%">
<col style="width: 34%">
<col style="width: 41%">
<col style="width: 13%">
</colgroup>
<thead>
<tr class="header">
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>cfg</td>
<td>DictDefault</td>
<td>The configuration for the plugins.</td>
<td><em>required</em></td>
</tr>
<tr class="even">
<td>model</td>
<td>PreTrainedModel | PeftModel</td>
<td>The loaded model.</td>
<td><em>required</em></td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="axolotl.integrations.base.PluginManager.post_train" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.post_train">post_train</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb40"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb40-1"><a href="#cb40-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.post_train(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the post_train method of all registered plugins.</p>
<section id="parameters-28" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-28">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 9%">
<col style="width: 34%">
<col style="width: 41%">
@@ -2460,10 +2609,10 @@ has been loaded inclusive of any adapters.</p>
</section>
<section id="axolotl.integrations.base.PluginManager.post_train_unload" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.post_train_unload">post_train_unload</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb39"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb39-1"><a href="#cb39-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.post_train_unload(cfg)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb41"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb41-1"><a href="#cb41-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.post_train_unload(cfg)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the post_train_unload method of all registered plugins.</p>
<section id="parameters-27" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-27">Parameters</h6>
<section id="parameters-29" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-29">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 11%">
@@ -2492,10 +2641,10 @@ has been loaded inclusive of any adapters.</p>
</section>
<section id="axolotl.integrations.base.PluginManager.post_trainer_create" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.post_trainer_create">post_trainer_create</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb40"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb40-1"><a href="#cb40-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.post_trainer_create(cfg, trainer)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb42"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb42-1"><a href="#cb42-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.post_trainer_create(cfg, trainer)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the <code>post_trainer_create</code> method of all registered plugins.</p>
<section id="parameters-28" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-28">Parameters</h6>
<section id="parameters-30" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-30">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 12%">
@@ -2530,10 +2679,10 @@ has been loaded inclusive of any adapters.</p>
</section>
<section id="axolotl.integrations.base.PluginManager.pre_lora_load" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.pre_lora_load">pre_lora_load</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb41"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb41-1"><a href="#cb41-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.pre_lora_load(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb43"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb43-1"><a href="#cb43-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.pre_lora_load(cfg, model)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the <code>pre_lora_load</code> method of all registered plugins.</p>
<section id="parameters-29" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-29">Parameters</h6>
<section id="parameters-31" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-31">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 10%">
@@ -2568,10 +2717,10 @@ has been loaded inclusive of any adapters.</p>
</section>
<section id="axolotl.integrations.base.PluginManager.pre_model_load" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.pre_model_load">pre_model_load</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb42"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb42-1"><a href="#cb42-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.pre_model_load(cfg)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb44"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb44-1"><a href="#cb44-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.pre_model_load(cfg)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Calls the pre_model_load method of all registered plugins.</p>
<section id="parameters-30" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-30">Parameters</h6>
<section id="parameters-32" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-32">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 11%">
@@ -2600,10 +2749,10 @@ has been loaded inclusive of any adapters.</p>
</section>
<section id="axolotl.integrations.base.PluginManager.register" class="level5">
<h5 class="anchored" data-anchor-id="axolotl.integrations.base.PluginManager.register">register</h5>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb43"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb43-1"><a href="#cb43-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.register(plugin_name)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb45"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb45-1"><a href="#cb45-1" aria-hidden="true" tabindex="-1"></a>integrations.base.PluginManager.register(plugin_name)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Registers a new plugin by its name.</p>
<section id="parameters-31" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-31">Parameters</h6>
<section id="parameters-33" class="level6 doc-section doc-section-parameters">
<h6 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-33">Parameters</h6>
<table class="caption-top table">
<colgroup>
<col style="width: 17%">
@@ -2670,13 +2819,13 @@ has been loaded inclusive of any adapters.</p>
</table>
<section id="axolotl.integrations.base.load_plugin" class="level3">
<h3 class="anchored" data-anchor-id="axolotl.integrations.base.load_plugin">load_plugin</h3>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb44"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb44-1"><a href="#cb44-1" aria-hidden="true" tabindex="-1"></a>integrations.base.load_plugin(plugin_name)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb46"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb46-1"><a href="#cb46-1" aria-hidden="true" tabindex="-1"></a>integrations.base.load_plugin(plugin_name)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
<p>Loads a plugin based on the given plugin name.</p>
<p>The plugin name should be in the format “module_name.class_name”. This function
splits the plugin name into module and class, imports the module, retrieves the
class from the module, and creates an instance of the class.</p>
<section id="parameters-32" class="level4 doc-section doc-section-parameters">
<h4 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-32">Parameters</h4>
<section id="parameters-34" class="level4 doc-section doc-section-parameters">
<h4 class="doc-section doc-section-parameters anchored" data-anchor-id="parameters-34">Parameters</h4>
<table class="caption-top table">
<colgroup>
<col style="width: 10%">