trl/pr_5313/en/_app/immutable/nodes/20.CFbmZPzP.js

import"../chunks/DsnmJJEf.js";import{i as f,h as k,C as M,H as u,D as y,E as C,s as v,a as x}from"../chunks/ChUdhzCR.js";import{p as W,o as U,s as e,f as i,a as r,b as Z,c as j,d as t,r as Y,n as w}from"../chunks/BxrqFSCq.js";import{E as J}from"../chunks/6U88GyHj.js";const T='{"title":"MergeModelCallback","local":"trl.experimental.merge_model_callback.MergeModelCallback","sections":[],"depth":1}';var E=t('<meta name="hf:doc:metadata"/>'),F=t("<p>Example:</p> <!>",1),B=t(`<p></p> <!> <!> <div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"><!> <p>A <a href="https://huggingface.co/docs/transformers/main/en/main_classes/callback#transformers.TrainerCallback" rel="nofollow">TrainerCallback</a> that merges the policy model (the model being trained) with another model based
on a merge configuration.</p> <!></div> <!> <p></p>`,1);function H(d,p){W(p,!1),U(()=>{new URLSearchParams(window.location.search).get("fw")}),f();var n=B();k("lqpjul",a=>{var o=E();v(o,"content",T),r(a,o)});var c=e(i(n),2);M(c,{containerStyle:"float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"});var s=e(c,2);u(s,{title:"MergeModelCallback",local:"trl.experimental.merge_model_callback.MergeModelCallback",headingTag:"h1"});var l=e(s,2),m=j(l);y(m,{name:"class trl.experimental.merge_model_callback.MergeModelCallback",anchor:"trl.experimental.merge_model_callback.MergeModelCallback",source:"https://github.com/huggingface/trl/blob/vr_5313/trl/experimental/merge_model_callback.py#L294",parameters:[{name:"merge_config",val:": MergeConfig | None = None"},{name:"merge_at_every_checkpoint",val:": bool = False"},{name:"push_to_hub",val:": bool = False"}],parametersDescription:[{anchor:"trl.experimental.merge_model_callback.MergeModelCallback.merge_config",description:`<strong>merge_config</strong> (<code>experimental.merge_model_callback.MergeConfig</code>, <em>optional</em>) &#x2014;
Configuration used for the merging process. If not provided, the default
<code>MergeConfig</code> is used.`,name:"merge_config"},{anchor:"trl.experimental.merge_model_callback.MergeModelCallback.merge_at_every_checkpoint",description:`<strong>merge_at_every_checkpoint</strong> (<code>bool</code>, <em>optional</em>, defaults to <code>False</code>) &#x2014;
Whether to merge the model at every checkpoint.`,name:"merge_at_every_checkpoint"},{anchor:"trl.experimental.merge_model_callback.MergeModelCallback.push_to_hub",description:`<strong>push_to_hub</strong> (<code>bool</code>, <em>optional</em>, defaults to <code>False</code>) &#x2014;
Whether to push the merged model to the Hub after merging.`,name:"push_to_hub"}]});var h=e(m,4);J(h,{anchor:"trl.experimental.merge_model_callback.MergeModelCallback.example",children:(a,o)=>{var g=F(),_=e(i(g),2);x(_,{code:"ZnJvbSUyMHRybC5leHBlcmltZW50YWwubWVyZ2VfbW9kZWxfY2FsbGJhY2slMjBpbXBvcnQlMjBNZXJnZUNvbmZpZyUyQyUyME1lcmdlTW9kZWxDYWxsYmFjayUwQSUwQWNvbmZpZyUyMCUzRCUyME1lcmdlQ29uZmlnKCklMEFtZXJnZV9jYWxsYmFjayUyMCUzRCUyME1lcmdlTW9kZWxDYWxsYmFjayhjb25maWcpJTBBdHJhaW5lciUyMCUzRCUyMERQT1RyYWluZXIoLi4uJTJDJTIwY2FsbGJhY2tzJTNEJTVCbWVyZ2VfY2FsbGJhY2slNUQp",highlighted:`<span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> trl.experimental.merge_model_callback <span class="hljs-keyword">import</span> MergeConfig, MergeModelCallback

<span class="hljs-meta">&gt;&gt;&gt; </span>config = MergeConfig()
<span class="hljs-meta">&gt;&gt;&gt; </span>merge_callback = MergeModelCallback(config)
<span class="hljs-meta">&gt;&gt;&gt; </span>trainer = DPOTrainer(..., callbacks=[merge_callback])`,lang:"python",wrap:!1}),r(a,g)},$$slots:{default:!0}}),Y(l);var b=e(l,2);C(b,{source:"https://github.com/huggingface/trl/blob/main/docs/source/merge_model_callback.md"}),w(2),r(d,n),Z()}export{H as component};