diff --git a/.nojekyll b/.nojekyll index 2b1d454b3..178731cea 100644 --- a/.nojekyll +++ b/.nojekyll @@ -1 +1 @@ -8efe4c4d \ No newline at end of file +62d50f63 \ No newline at end of file diff --git a/docs/api/integrations.base.html b/docs/api/integrations.base.html index b30b9b7db..1530bb9f0 100644 --- a/docs/api/integrations.base.html +++ b/docs/api/integrations.base.html @@ -921,38 +921,42 @@ training.
integrations.base.BasePlugin.post_lora_load(cfg, model)Performs actions after LoRA weights are loaded.
+integrations.base.BasePlugin.on_rollouts_scored(
+ cfg,
+ trainer,
+ prompts,
+ completions,
+ rewards,
+ advantages,
+)Called after rollouts are scored during online RL (GRPO/PPO).
+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.
| Name | +Type | +Description | +Default | +
|---|---|---|---|
| cfg | +DictDefault | +The axolotl configuration. | +required | +
| trainer | ++ | The trainer instance. | +required | +
| prompts | +list[str] | +List of prompt texts (one per sample). | +required | +
| completions | +list[str] | +List of completion texts (one per sample). | +required | +
| rewards | +dict[str, list[float]] | +Dict mapping reward function name to list of reward values. | +required | +
| advantages | +list[float] | +List of advantage values (one per sample). | +required | +
integrations.base.BasePlugin.post_lora_load(cfg, model)Performs actions after LoRA weights are loaded.
+| Calls the load_datasets method of each registered plugin. | |
| on_rollouts_scored | +Calls the on_rollouts_scored method of all registered plugins. | +
| post_lora_load | Calls the post_lora_load method of all registered plugins. |
| post_model_build | Calls the post_model_build method of all registered plugins after the |
| post_model_load | Calls the post_model_load method of all registered plugins after the model |
| post_train | Calls the post_train method of all registered plugins. |
| post_train_unload | Calls the post_train_unload method of all registered plugins. |
| post_trainer_create | Calls the post_trainer_create method of all registered plugins. |
| pre_lora_load | Calls the pre_lora_load method of all registered plugins. |
| pre_model_load | Calls the pre_model_load method of all registered plugins. |
| register | Registers a new plugin by its name. |
integrations.base.PluginManager.add_callbacks_post_trainer(cfg, trainer)integrations.base.PluginManager.add_callbacks_post_trainer(cfg, trainer)Calls the add_callbacks_post_trainer method of all registered plugins.
integrations.base.PluginManager.post_lora_load(cfg, model)Calls the post_lora_load method of all registered plugins.
| Name | -Type | -Description | -Default | -
|---|---|---|---|
| cfg | -DictDefault | -The configuration for the plugins. | -required | -
| model | -PreTrainedModel | PeftModel | -The loaded model. | -required | -
integrations.base.PluginManager.post_model_build(cfg, model)Calls the post_model_build method of all registered plugins after the
-model has been built / loaded, but before any adapters have been applied.
integrations.base.PluginManager.on_rollouts_scored(
+ cfg,
+ trainer,
+ prompts,
+ completions,
+ rewards,
+ advantages,
+)Calls the on_rollouts_scored method of all registered plugins.
| required | ||||||
| model | -PreTrainedModel | -The loaded model. | +trainer | ++ | The trainer instance. | +required | +
| prompts | +list[str] | +List of prompt texts. | +required | +|||
| completions | +list[str] | +List of completion texts. | +required | +|||
| rewards | +dict[str, list[float]] | +Dict mapping reward function name to list of rewards. | +required | +|||
| advantages | +list[float] | +List of advantage values. | required |
integrations.base.PluginManager.post_model_load(cfg, model)Calls the post_model_load method of all registered plugins after the model
-has been loaded inclusive of any adapters.
integrations.base.PluginManager.post_lora_load(cfg, model)Calls the post_lora_load method of all registered plugins.
integrations.base.PluginManager.post_train(cfg, model)Calls the post_train method of all registered plugins.
+integrations.base.PluginManager.post_model_build(cfg, model)Calls the post_model_build method of all registered plugins after the
+model has been built / loaded, but before any adapters have been applied.
| Name | +Type | +Description | +Default | +
|---|---|---|---|
| cfg | +DictDefault | +The configuration for the plugins. | +required | +
| model | +PreTrainedModel | +The loaded model. | +required | +
integrations.base.PluginManager.post_model_load(cfg, model)Calls the post_model_load method of all registered plugins after the model
+has been loaded inclusive of any adapters.
| Name | +Type | +Description | +Default | +
|---|---|---|---|
| cfg | +DictDefault | +The configuration for the plugins. | +required | +
| model | +PreTrainedModel | PeftModel | +The loaded model. | +required | +
integrations.base.PluginManager.post_train(cfg, model)Calls the post_train method of all registered plugins.
+integrations.base.load_plugin(plugin_name)integrations.base.load_plugin(plugin_name)Loads a plugin based on the given plugin name.
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.
-