import{s as wa,B as er,o as ba,n as rr}from"../chunks/scheduler.9991993c.js";import{S as $a,i as va,g as l,s as a,r as p,A as ya,h as m,f as t,c as n,j as z,u as d,x as w,k as $,y as o,a as i,v as h,d as u,t as g,w as f}from"../chunks/index.7fc9a5e7.js";import{D as M}from"../chunks/Docstring.ef7d0149.js";import{C as ar}from"../chunks/CodeBlock.e11cba92.js";import{E as tr}from"../chunks/ExampleCodeBlock.0db1a011.js";import{H as Z,E as xa}from"../chunks/EditOnGithub.84ab7f0e.js";function Ta(D){let c,A="Example:",x,_,v;return _=new ar({props:{code:"QWRhZmFjdG9yKG1vZGVsLnBhcmFtZXRlcnMoKSUyQyUyMHNjYWxlX3BhcmFtZXRlciUzREZhbHNlJTJDJTIwcmVsYXRpdmVfc3RlcCUzREZhbHNlJTJDJTIwd2FybXVwX2luaXQlM0RGYWxzZSUyQyUyMGxyJTNEMWUtMyk=",highlighted:'Adafactor(model.parameters(), scale_parameter=<span class="hljs-literal">False</span>, relative_step=<span class="hljs-literal">False</span>, warmup_init=<span class="hljs-literal">False</span>, lr=<span class="hljs-number">1e-3</span>)',wrap:!1}}),{c(){c=l("p"),c.textContent=A,x=a(),p(_.$$.fragment)},l(s){c=m(s,"P",{"data-svelte-h":!0}),w(c)!=="svelte-11lpom8"&&(c.textContent=A),x=n(s),d(_.$$.fragment,s)},m(s,T){i(s,c,T),i(s,x,T),h(_,s,T),v=!0},p:rr,i(s){v||(u(_.$$.fragment,s),v=!0)},o(s){g(_.$$.fragment,s),v=!1},d(s){s&&(t(c),t(x)),f(_,s)}}}function za(D){let c,A="Others reported the following combination to work well:",x,_,v;return _=new ar({props:{code:"QWRhZmFjdG9yKG1vZGVsLnBhcmFtZXRlcnMoKSUyQyUyMHNjYWxlX3BhcmFtZXRlciUzRFRydWUlMkMlMjByZWxhdGl2ZV9zdGVwJTNEVHJ1ZSUyQyUyMHdhcm11cF9pbml0JTNEVHJ1ZSUyQyUyMGxyJTNETm9uZSk=",highlighted:'Adafactor(model.parameters(), scale_parameter=<span class="hljs-literal">True</span>, relative_step=<span class="hljs-literal">True</span>, warmup_init=<span class="hljs-literal">True</span>, lr=<span class="hljs-literal">None</span>)',wrap:!1}}),{c(){c=l("p"),c.textContent=A,x=a(),p(_.$$.fragment)},l(s){c=m(s,"P",{"data-svelte-h":!0}),w(c)!=="svelte-mxeef1"&&(c.textContent=A),x=n(s),d(_.$$.fragment,s)},m(s,T){i(s,c,T),i(s,x,T),h(_,s,T),v=!0},p:rr,i(s){v||(u(_.$$.fragment,s),v=!0)},o(s){g(_.$$.fragment,s),v=!1},d(s){s&&(t(c),t(x)),f(_,s)}}}function Ma(D){let c,A="scheduler as following:",x,_,v;return _=new ar({props:{code:"ZnJvbSUyMHRyYW5zZm9ybWVycy5vcHRpbWl6YXRpb24lMjBpbXBvcnQlMjBBZGFmYWN0b3IlMkMlMjBBZGFmYWN0b3JTY2hlZHVsZSUwQSUwQW9wdGltaXplciUyMCUzRCUyMEFkYWZhY3Rvcihtb2RlbC5wYXJhbWV0ZXJzKCklMkMlMjBzY2FsZV9wYXJhbWV0ZXIlM0RUcnVlJTJDJTIwcmVsYXRpdmVfc3RlcCUzRFRydWUlMkMlMjB3YXJtdXBfaW5pdCUzRFRydWUlMkMlMjBsciUzRE5vbmUpJTBBbHJfc2NoZWR1bGVyJTIwJTNEJTIwQWRhZmFjdG9yU2NoZWR1bGUob3B0aW1pemVyKSUwQXRyYWluZXIlMjAlM0QlMjBUcmFpbmVyKC4uLiUyQyUyMG9wdGltaXplcnMlM0Qob3B0aW1pemVyJTJDJTIwbHJfc2NoZWR1bGVyKSk=",highlighted:`<span class="hljs-keyword">from</span> transformers.optimization <span class="hljs-keyword">import</span> Adafactor, AdafactorSchedule

optimizer = Adafactor(model.parameters(), scale_parameter=<span class="hljs-literal">True</span>, relative_step=<span class="hljs-literal">True</span>, warmup_init=<span class="hljs-literal">True</span>, lr=<span class="hljs-literal">None</span>)
lr_scheduler = AdafactorSchedule(optimizer)
trainer = Trainer(..., optimizers=(optimizer, lr_scheduler))`,wrap:!1}}),{c(){c=l("p"),c.textContent=A,x=a(),p(_.$$.fragment)},l(s){c=m(s,"P",{"data-svelte-h":!0}),w(c)!=="svelte-1eua222"&&(c.textContent=A),x=n(s),d(_.$$.fragment,s)},m(s,T){i(s,c,T),i(s,x,T),h(_,s,T),v=!0},p:rr,i(s){v||(u(_.$$.fragment,s),v=!0)},o(s){g(_.$$.fragment,s),v=!1},d(s){s&&(t(c),t(x)),f(_,s)}}}function Aa(D){let c,A="Usage:",x,_,v;return _=new ar({props:{code:"JTIzJTIwcmVwbGFjZSUyMEFkYW1XJTIwd2l0aCUyMEFkYWZhY3RvciUwQW9wdGltaXplciUyMCUzRCUyMEFkYWZhY3RvciglMEElMjAlMjAlMjAlMjBtb2RlbC5wYXJhbWV0ZXJzKCklMkMlMEElMjAlMjAlMjAlMjBsciUzRDFlLTMlMkMlMEElMjAlMjAlMjAlMjBlcHMlM0QoMWUtMzAlMkMlMjAxZS0zKSUyQyUwQSUyMCUyMCUyMCUyMGNsaXBfdGhyZXNob2xkJTNEMS4wJTJDJTBBJTIwJTIwJTIwJTIwZGVjYXlfcmF0ZSUzRC0wLjglMkMlMEElMjAlMjAlMjAlMjBiZXRhMSUzRE5vbmUlMkMlMEElMjAlMjAlMjAlMjB3ZWlnaHRfZGVjYXklM0QwLjAlMkMlMEElMjAlMjAlMjAlMjByZWxhdGl2ZV9zdGVwJTNERmFsc2UlMkMlMEElMjAlMjAlMjAlMjBzY2FsZV9wYXJhbWV0ZXIlM0RGYWxzZSUyQyUwQSUyMCUyMCUyMCUyMHdhcm11cF9pbml0JTNERmFsc2UlMkMlMEEp",highlighted:`<span class="hljs-comment"># replace AdamW with Adafactor</span>
optimizer = Adafactor(
    model.parameters(),
    lr=<span class="hljs-number">1e-3</span>,
    eps=(<span class="hljs-number">1e-30</span>, <span class="hljs-number">1e-3</span>),
    clip_threshold=<span class="hljs-number">1.0</span>,
    decay_rate=-<span class="hljs-number">0.8</span>,
    beta1=<span class="hljs-literal">None</span>,
    weight_decay=<span class="hljs-number">0.0</span>,
    relative_step=<span class="hljs-literal">False</span>,
    scale_parameter=<span class="hljs-literal">False</span>,
    warmup_init=<span class="hljs-literal">False</span>,
)`,wrap:!1}}),{c(){c=l("p"),c.textContent=A,x=a(),p(_.$$.fragment)},l(s){c=m(s,"P",{"data-svelte-h":!0}),w(c)!=="svelte-5wyjqd"&&(c.textContent=A),x=n(s),d(_.$$.fragment,s)},m(s,T){i(s,c,T),i(s,x,T),h(_,s,T),v=!0},p:rr,i(s){v||(u(_.$$.fragment,s),v=!0)},o(s){g(_.$$.fragment,s),v=!1},d(s){s&&(t(c),t(x)),f(_,s)}}}function Ca(D){let c,A,x,_,v,s,T,Pr="<code>.optimization</code> 模块提供了：",dt,ee,Vr="<li>一个带有固定权重衰减的优化器，可用于微调模型</li> <li>继承自 <code>_LRSchedule</code> 多个调度器：</li> <li>一个梯度累积类，用于累积多个批次的梯度</li>",ht,te,ut,W,re,nr,Ee,Gr=`Implements Adam algorithm with weight decay fix as introduced in <a href="https://arxiv.org/abs/1711.05101" rel="nofollow">Decoupled Weight Decay
Regularization</a>.`,or,H,ae,sr,ke,Jr="Performs a single optimization step.",gt,ne,ft,b,oe,ir,Ie,Nr=`AdaFactor pytorch implementation can be used as a drop in replacement for Adam original fairseq code:
<a href="https://github.com/pytorch/fairseq/blob/master/fairseq/optim/adafactor.py" rel="nofollow">https://github.com/pytorch/fairseq/blob/master/fairseq/optim/adafactor.py</a>`,lr,Fe,Zr=`Paper: <em>Adafactor: Adaptive Learning Rates with Sublinear Memory Cost</em> <a href="https://arxiv.org/abs/1804.04235" rel="nofollow">https://arxiv.org/abs/1804.04235</a> Note that
this optimizer internally adjusts the learning rate depending on the <code>scale_parameter</code>, <code>relative_step</code> and
<code>warmup_init</code> options. To use a manual (external) learning rate schedule you should set <code>scale_parameter=False</code> and
<code>relative_step=False</code>.`,mr,Pe,Hr="This implementation handles low-precision (FP16, bfloat) values, but we have not thoroughly tested.",cr,Ve,Sr='Recommended T5 finetuning settings (<a href="https://discuss.huggingface.co/t/t5-finetuning-tips/684/3" rel="nofollow">https://discuss.huggingface.co/t/t5-finetuning-tips/684/3</a>):',pr,Ge,qr='<li><p>Training without LR warmup or clip_threshold is not recommended.</p> <ul><li>use scheduled LR warm-up to fixed LR</li> <li>use clip_threshold=1.0 (<a href="https://arxiv.org/abs/1804.04235" rel="nofollow">https://arxiv.org/abs/1804.04235</a>)</li></ul></li> <li><p>Disable relative updates</p></li> <li><p>Use scale_parameter=False</p></li> <li><p>Additional optimizer operations like gradient clipping should not be used alongside Adafactor</p></li>',dr,S,hr,q,ur,Je,Br="When using <code>lr=None</code> with <code>Trainer</code> you will most likely need to use <code>AdafactorSchedule</code>",gr,B,fr,X,_r,O,se,wr,Ne,Xr="Performs a single optimization step",_t,ie,wt,C,le,br,Ze,Or=`Adam enables L2 weight decay and clip_by_global_norm on gradients. Just adding the square of the weights to the
loss function is <em>not</em> the correct way of using L2 regularization/weight decay with Adam, since that will interact
with the m and v parameters in strange ways as shown in <a href="https://arxiv.org/abs/1711.05101" rel="nofollow">Decoupled Weight Decay
Regularization</a>.`,$r,He,Yr=`Instead we want to decay the weights in a manner that doesn’t interact with the m/v parameters. This is equivalent
to adding the square of the weights to the loss with plain (non-momentum) SGD.`,vr,Y,me,yr,Se,Qr="Creates an optimizer from its config with WarmUp custom object.",bt,R,ce,xr,qe,Kr="Creates an optimizer with a learning rate schedule using a warmup phase followed by a linear decay.",$t,pe,vt,de,yt,L,he,Tr,Be,ea=`Scheduler names for the parameter <code>lr_scheduler_type</code> in <code>TrainingArguments</code>.
By default, it uses “linear”. Internally, this retrieves <code>get_linear_schedule_with_warmup</code> scheduler from <code>Trainer</code>.
Scheduler types:`,zr,Xe,ta="<li>“linear” = get_linear_schedule_with_warmup</li> <li>“cosine” = get_cosine_schedule_with_warmup</li> <li>“cosine_with_restarts” = get_cosine_with_hard_restarts_schedule_with_warmup</li> <li>“polynomial” = get_polynomial_decay_schedule_with_warmup</li> <li>“constant” =  get_constant_schedule</li> <li>“constant_with_warmup” = get_constant_schedule_with_warmup</li> <li>“inverse_sqrt” = get_inverse_sqrt_schedule</li> <li>“reduce_lr_on_plateau” = get_reduce_on_plateau_schedule</li> <li>“cosine_with_min_lr” = get_cosine_with_min_lr_schedule_with_warmup</li> <li>“warmup_stable_decay” = get_wsd_schedule</li>",xt,E,ue,Mr,Oe,ra="Unified API to get any scheduler from its name.",Tt,k,ge,Ar,Ye,aa="Create a schedule with a constant learning rate, using the learning rate set in optimizer.",zt,I,fe,Cr,Qe,na=`Create a schedule with a constant learning rate preceded by a warmup period during which the learning rate
increases linearly between 0 and the initial lr set in the optimizer.`,Mt,_e,oa,At,F,we,Wr,Ke,sa=`Create a schedule with a learning rate that decreases following the values of the cosine function between the
initial lr set in the optimizer to 0, after a warmup period during which it increases linearly between 0 and the
initial lr set in the optimizer.`,Ct,be,ia,Wt,P,$e,Lr,et,la=`Create a schedule with a learning rate that decreases following the values of the cosine function between the
initial lr set in the optimizer to 0, with several hard restarts, after a warmup period during which it increases
linearly between 0 and the initial lr set in the optimizer.`,Lt,ve,ma,jt,V,ye,jr,tt,ca=`Create a schedule with a learning rate that decreases linearly from the initial lr set in the optimizer to 0, after
a warmup period during which it increases linearly from 0 to the initial lr set in the optimizer.`,Ut,xe,pa,Dt,j,Te,Ur,rt,da=`Create a schedule with a learning rate that decreases as a polynomial decay from the initial lr set in the
optimizer to end lr defined by <em>lr_end</em>, after a warmup period during which it increases linearly from 0 to the
initial lr set in the optimizer.`,Dr,at,ha=`Note: <em>power</em> defaults to 1.0 as in the fairseq implementation, which in turn is based on the original BERT
implementation at
<a href="https://github.com/google-research/bert/blob/f39e881b169b9d53bea03d2d341b31707a6c052b/optimization.py#L37" rel="nofollow">https://github.com/google-research/bert/blob/f39e881b169b9d53bea03d2d341b31707a6c052b/optimization.py#L37</a>`,Rt,G,ze,Rr,nt,ua=`Create a schedule with an inverse square-root learning rate, from the initial lr set in the optimizer, after a
warmup period which increases lr linearly from 0 to the initial lr set in the optimizer.`,Et,Me,kt,J,Ae,Er,ot,ga="Applies a warmup schedule on a given learning rate decay schedule.",It,Ce,Ft,We,Pt,U,Le,kr,st,fa=`Gradient accumulation utility. When used with a distribution strategy, the accumulator should be called in a
replica context. Gradients will be accumulated locally on each replica and without synchronization. Users should
then call <code>.gradients</code>, scale the gradients if required, and pass the result to <code>apply_gradients</code>.`,Ir,Q,je,Fr,it,_a="Resets the accumulated gradients on the current replica.",Vt,Ue,Gt,pt,Jt;return v=new Z({props:{title:"Optimization",local:"optimization",headingTag:"h1"}}),te=new Z({props:{title:"AdamW (PyTorch)",local:"transformers.AdamW",headingTag:"h2"}}),re=new M({props:{name:"class transformers.AdamW",anchor:"transformers.AdamW",parameters:[{name:"params",val:": Iterable"},{name:"lr",val:": float = 0.001"},{name:"betas",val:": Tuple = (0.9, 0.999)"},{name:"eps",val:": float = 1e-06"},{name:"weight_decay",val:": float = 0.0"},{name:"correct_bias",val:": bool = True"},{name:"no_deprecation_warning",val:": bool = False"}],parametersDescription:[{anchor:"transformers.AdamW.params",description:`<strong>params</strong> (<code>Iterable[nn.parameter.Parameter]</code>) &#x2014;
Iterable of parameters to optimize or dictionaries defining parameter groups.`,name:"params"},{anchor:"transformers.AdamW.lr",description:`<strong>lr</strong> (<code>float</code>, <em>optional</em>, defaults to 0.001) &#x2014;
The learning rate to use.`,name:"lr"},{anchor:"transformers.AdamW.betas",description:`<strong>betas</strong> (<code>Tuple[float,float]</code>, <em>optional</em>, defaults to <code>(0.9, 0.999)</code>) &#x2014;
Adam&#x2019;s betas parameters (b1, b2).`,name:"betas"},{anchor:"transformers.AdamW.eps",description:`<strong>eps</strong> (<code>float</code>, <em>optional</em>, defaults to 1e-06) &#x2014;
Adam&#x2019;s epsilon for numerical stability.`,name:"eps"},{anchor:"transformers.AdamW.weight_decay",description:`<strong>weight_decay</strong> (<code>float</code>, <em>optional</em>, defaults to 0.0) &#x2014;
Decoupled weight decay to apply.`,name:"weight_decay"},{anchor:"transformers.AdamW.correct_bias",description:`<strong>correct_bias</strong> (<code>bool</code>, <em>optional</em>, defaults to <code>True</code>) &#x2014;
Whether or not to correct bias in Adam (for instance, in Bert TF repository they use <code>False</code>).`,name:"correct_bias"},{anchor:"transformers.AdamW.no_deprecation_warning",description:`<strong>no_deprecation_warning</strong> (<code>bool</code>, <em>optional</em>, defaults to <code>False</code>) &#x2014;
A flag used to disable the deprecation warning (set to <code>True</code> to disable the warning).`,name:"no_deprecation_warning"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization.py#L558"}}),ae=new M({props:{name:"step",anchor:"transformers.AdamW.step",parameters:[{name:"closure",val:": Callable = None"}],parametersDescription:[{anchor:"transformers.AdamW.step.closure",description:"<strong>closure</strong> (<code>Callable</code>, <em>optional</em>) &#x2014; A closure that reevaluates the model and returns the loss.",name:"closure"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization.py#L609"}}),ne=new Z({props:{title:"AdaFactor (PyTorch)",local:"transformers.Adafactor",headingTag:"h2"}}),oe=new M({props:{name:"class transformers.Adafactor",anchor:"transformers.Adafactor",parameters:[{name:"params",val:""},{name:"lr",val:" = None"},{name:"eps",val:" = (1e-30, 0.001)"},{name:"clip_threshold",val:" = 1.0"},{name:"decay_rate",val:" = -0.8"},{name:"beta1",val:" = None"},{name:"weight_decay",val:" = 0.0"},{name:"scale_parameter",val:" = True"},{name:"relative_step",val:" = True"},{name:"warmup_init",val:" = False"}],parametersDescription:[{anchor:"transformers.Adafactor.params",description:`<strong>params</strong> (<code>Iterable[nn.parameter.Parameter]</code>) &#x2014;
Iterable of parameters to optimize or dictionaries defining parameter groups.`,name:"params"},{anchor:"transformers.Adafactor.lr",description:`<strong>lr</strong> (<code>float</code>, <em>optional</em>) &#x2014;
The external learning rate.`,name:"lr"},{anchor:"transformers.Adafactor.eps",description:`<strong>eps</strong> (<code>Tuple[float, float]</code>, <em>optional</em>, defaults to <code>(1e-30, 0.001)</code>) &#x2014;
Regularization constants for square gradient and parameter scale respectively`,name:"eps"},{anchor:"transformers.Adafactor.clip_threshold",description:`<strong>clip_threshold</strong> (<code>float</code>, <em>optional</em>, defaults to 1.0) &#x2014;
Threshold of root mean square of final gradient update`,name:"clip_threshold"},{anchor:"transformers.Adafactor.decay_rate",description:`<strong>decay_rate</strong> (<code>float</code>, <em>optional</em>, defaults to -0.8) &#x2014;
Coefficient used to compute running averages of square`,name:"decay_rate"},{anchor:"transformers.Adafactor.beta1",description:`<strong>beta1</strong> (<code>float</code>, <em>optional</em>) &#x2014;
Coefficient used for computing running averages of gradient`,name:"beta1"},{anchor:"transformers.Adafactor.weight_decay",description:`<strong>weight_decay</strong> (<code>float</code>, <em>optional</em>, defaults to 0.0) &#x2014;
Weight decay (L2 penalty)`,name:"weight_decay"},{anchor:"transformers.Adafactor.scale_parameter",description:`<strong>scale_parameter</strong> (<code>bool</code>, <em>optional</em>, defaults to <code>True</code>) &#x2014;
If True, learning rate is scaled by root mean square`,name:"scale_parameter"},{anchor:"transformers.Adafactor.relative_step",description:`<strong>relative_step</strong> (<code>bool</code>, <em>optional</em>, defaults to <code>True</code>) &#x2014;
If True, time-dependent learning rate is computed instead of external learning rate`,name:"relative_step"},{anchor:"transformers.Adafactor.warmup_init",description:`<strong>warmup_init</strong> (<code>bool</code>, <em>optional</em>, defaults to <code>False</code>) &#x2014;
Time-dependent learning rate computation depends on whether warm-up initialization is being used`,name:"warmup_init"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization.py#L672"}}),S=new tr({props:{anchor:"transformers.Adafactor.example",$$slots:{default:[Ta]},$$scope:{ctx:D}}}),q=new tr({props:{anchor:"transformers.Adafactor.example-2",$$slots:{default:[za]},$$scope:{ctx:D}}}),B=new tr({props:{anchor:"transformers.Adafactor.example-3",$$slots:{default:[Ma]},$$scope:{ctx:D}}}),X=new tr({props:{anchor:"transformers.Adafactor.example-4",$$slots:{default:[Aa]},$$scope:{ctx:D}}}),se=new M({props:{name:"step",anchor:"transformers.Adafactor.step",parameters:[{name:"closure",val:" = None"}],parametersDescription:[{anchor:"transformers.Adafactor.step.closure",description:`<strong>closure</strong> (callable, optional) &#x2014; A closure that reevaluates the model
and returns the loss.`,name:"closure"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization.py#L818"}}),ie=new Z({props:{title:"AdamWeightDecay (TensorFlow)",local:"transformers.AdamWeightDecay",headingTag:"h2"}}),le=new M({props:{name:"class transformers.AdamWeightDecay",anchor:"transformers.AdamWeightDecay",parameters:[{name:"learning_rate",val:": Union = 0.001"},{name:"beta_1",val:": float = 0.9"},{name:"beta_2",val:": float = 0.999"},{name:"epsilon",val:": float = 1e-07"},{name:"amsgrad",val:": bool = False"},{name:"weight_decay_rate",val:": float = 0.0"},{name:"include_in_weight_decay",val:": Optional = None"},{name:"exclude_from_weight_decay",val:": Optional = None"},{name:"name",val:": str = 'AdamWeightDecay'"},{name:"**kwargs",val:""}],parametersDescription:[{anchor:"transformers.AdamWeightDecay.learning_rate",description:`<strong>learning_rate</strong> (<code>Union[float, LearningRateSchedule]</code>, <em>optional</em>, defaults to 0.001) &#x2014;
The learning rate to use or a schedule.`,name:"learning_rate"},{anchor:"transformers.AdamWeightDecay.beta_1",description:`<strong>beta_1</strong> (<code>float</code>, <em>optional</em>, defaults to 0.9) &#x2014;
The beta1 parameter in Adam, which is the exponential decay rate for the 1st momentum estimates.`,name:"beta_1"},{anchor:"transformers.AdamWeightDecay.beta_2",description:`<strong>beta_2</strong> (<code>float</code>, <em>optional</em>, defaults to 0.999) &#x2014;
The beta2 parameter in Adam, which is the exponential decay rate for the 2nd momentum estimates.`,name:"beta_2"},{anchor:"transformers.AdamWeightDecay.epsilon",description:`<strong>epsilon</strong> (<code>float</code>, <em>optional</em>, defaults to 1e-07) &#x2014;
The epsilon parameter in Adam, which is a small constant for numerical stability.`,name:"epsilon"},{anchor:"transformers.AdamWeightDecay.amsgrad",description:`<strong>amsgrad</strong> (<code>bool</code>, <em>optional</em>, defaults to <code>False</code>) &#x2014;
Whether to apply AMSGrad variant of this algorithm or not, see <a href="https://arxiv.org/abs/1904.09237" rel="nofollow">On the Convergence of Adam and
Beyond</a>.`,name:"amsgrad"},{anchor:"transformers.AdamWeightDecay.weight_decay_rate",description:`<strong>weight_decay_rate</strong> (<code>float</code>, <em>optional</em>, defaults to 0.0) &#x2014;
The weight decay to apply.`,name:"weight_decay_rate"},{anchor:"transformers.AdamWeightDecay.include_in_weight_decay",description:`<strong>include_in_weight_decay</strong> (<code>List[str]</code>, <em>optional</em>) &#x2014;
List of the parameter names (or re patterns) to apply weight decay to. If none is passed, weight decay is
applied to all parameters by default (unless they are in <code>exclude_from_weight_decay</code>).`,name:"include_in_weight_decay"},{anchor:"transformers.AdamWeightDecay.exclude_from_weight_decay",description:`<strong>exclude_from_weight_decay</strong> (<code>List[str]</code>, <em>optional</em>) &#x2014;
List of the parameter names (or re patterns) to exclude from applying weight decay to. If a
<code>include_in_weight_decay</code> is passed, the names in it will supersede this list.`,name:"exclude_from_weight_decay"},{anchor:"transformers.AdamWeightDecay.name",description:`<strong>name</strong> (<code>str</code>, <em>optional</em>, defaults to <code>&quot;AdamWeightDecay&quot;</code>) &#x2014;
Optional name for the operations created when applying gradients.`,name:"name"},{anchor:"transformers.AdamWeightDecay.kwargs",description:`<strong>kwargs</strong> (<code>Dict[str, Any]</code>, <em>optional</em>) &#x2014;
Keyword arguments. Allowed to be {<code>clipnorm</code>, <code>clipvalue</code>, <code>lr</code>, <code>decay</code>}. <code>clipnorm</code> is clip gradients by
norm; <code>clipvalue</code> is clip gradients by value, <code>decay</code> is included for backward compatibility to allow time
inverse decay of learning rate. <code>lr</code> is included for backward compatibility, recommended to use
<code>learning_rate</code> instead.`,name:"kwargs"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization_tf.py#L180"}}),me=new M({props:{name:"from_config",anchor:"transformers.AdamWeightDecay.from_config",parameters:[{name:"config",val:""}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization_tf.py#L237"}}),ce=new M({props:{name:"transformers.create_optimizer",anchor:"transformers.create_optimizer",parameters:[{name:"init_lr",val:": float"},{name:"num_train_steps",val:": int"},{name:"num_warmup_steps",val:": int"},{name:"min_lr_ratio",val:": float = 0.0"},{name:"adam_beta1",val:": float = 0.9"},{name:"adam_beta2",val:": float = 0.999"},{name:"adam_epsilon",val:": float = 1e-08"},{name:"adam_clipnorm",val:": Optional = None"},{name:"adam_global_clipnorm",val:": Optional = None"},{name:"weight_decay_rate",val:": float = 0.0"},{name:"power",val:": float = 1.0"},{name:"include_in_weight_decay",val:": Optional = None"}],parametersDescription:[{anchor:"transformers.create_optimizer.init_lr",description:`<strong>init_lr</strong> (<code>float</code>) &#x2014;
The desired learning rate at the end of the warmup phase.`,name:"init_lr"},{anchor:"transformers.create_optimizer.num_train_steps",description:`<strong>num_train_steps</strong> (<code>int</code>) &#x2014;
The total number of training steps.`,name:"num_train_steps"},{anchor:"transformers.create_optimizer.num_warmup_steps",description:`<strong>num_warmup_steps</strong> (<code>int</code>) &#x2014;
The number of warmup steps.`,name:"num_warmup_steps"},{anchor:"transformers.create_optimizer.min_lr_ratio",description:`<strong>min_lr_ratio</strong> (<code>float</code>, <em>optional</em>, defaults to 0) &#x2014;
The final learning rate at the end of the linear decay will be <code>init_lr * min_lr_ratio</code>.`,name:"min_lr_ratio"},{anchor:"transformers.create_optimizer.adam_beta1",description:`<strong>adam_beta1</strong> (<code>float</code>, <em>optional</em>, defaults to 0.9) &#x2014;
The beta1 to use in Adam.`,name:"adam_beta1"},{anchor:"transformers.create_optimizer.adam_beta2",description:`<strong>adam_beta2</strong> (<code>float</code>, <em>optional</em>, defaults to 0.999) &#x2014;
The beta2 to use in Adam.`,name:"adam_beta2"},{anchor:"transformers.create_optimizer.adam_epsilon",description:`<strong>adam_epsilon</strong> (<code>float</code>, <em>optional</em>, defaults to 1e-8) &#x2014;
The epsilon to use in Adam.`,name:"adam_epsilon"},{anchor:"transformers.create_optimizer.adam_clipnorm",description:`<strong>adam_clipnorm</strong> (<code>float</code>, <em>optional</em>, defaults to <code>None</code>) &#x2014;
If not <code>None</code>, clip the gradient norm for each weight tensor to this value.`,name:"adam_clipnorm"},{anchor:"transformers.create_optimizer.adam_global_clipnorm",description:`<strong>adam_global_clipnorm</strong> (<code>float</code>, <em>optional</em>, defaults to <code>None</code>) &#x2014;
If not <code>None</code>, clip gradient norm to this value. When using this argument, the norm is computed over all
weight tensors, as if they were concatenated into a single vector.`,name:"adam_global_clipnorm"},{anchor:"transformers.create_optimizer.weight_decay_rate",description:`<strong>weight_decay_rate</strong> (<code>float</code>, <em>optional</em>, defaults to 0) &#x2014;
The weight decay to use.`,name:"weight_decay_rate"},{anchor:"transformers.create_optimizer.power",description:`<strong>power</strong> (<code>float</code>, <em>optional</em>, defaults to 1.0) &#x2014;
The power to use for PolynomialDecay.`,name:"power"},{anchor:"transformers.create_optimizer.include_in_weight_decay",description:`<strong>include_in_weight_decay</strong> (<code>List[str]</code>, <em>optional</em>) &#x2014;
List of the parameter names (or re patterns) to apply weight decay to. If none is passed, weight decay is
applied to all parameters except bias and layer norm parameters.`,name:"include_in_weight_decay"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization_tf.py#L96"}}),pe=new Z({props:{title:"Schedules",local:"schedules",headingTag:"h2"}}),de=new Z({props:{title:"Learning Rate Schedules (Pytorch)",local:"transformers.SchedulerType",headingTag:"h3"}}),he=new M({props:{name:"class transformers.SchedulerType",anchor:"transformers.SchedulerType",parameters:[{name:"value",val:""},{name:"names",val:" = None"},{name:"module",val:" = None"},{name:"qualname",val:" = None"},{name:"type",val:" = None"},{name:"start",val:" = 1"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/trainer_utils.py#L418"}}),ue=new M({props:{name:"transformers.get_scheduler",anchor:"transformers.get_scheduler",parameters:[{name:"name",val:": Union"},{name:"optimizer",val:": Optimizer"},{name:"num_warmup_steps",val:": Optional = None"},{name:"num_training_steps",val:": Optional = None"},{name:"scheduler_specific_kwargs",val:": Optional = None"}],parametersDescription:[{anchor:"transformers.get_scheduler.name",description:`<strong>name</strong> (<code>str</code> or <code>SchedulerType</code>) &#x2014;
The name of the scheduler to use.`,name:"name"},{anchor:"transformers.get_scheduler.optimizer",description:`<strong>optimizer</strong> (<code>torch.optim.Optimizer</code>) &#x2014;
The optimizer that will be used during training.`,name:"optimizer"},{anchor:"transformers.get_scheduler.num_warmup_steps",description:`<strong>num_warmup_steps</strong> (<code>int</code>, <em>optional</em>) &#x2014;
The number of warmup steps to do. This is not required by all schedulers (hence the argument being
optional), the function will raise an error if it&#x2019;s unset and the scheduler type requires it.`,name:"num_warmup_steps"},{anchor:"transformers.get_scheduler.num_training_steps",description:`<strong>num_training_steps</strong> (\`int&#x201C;, <em>optional</em>) &#x2014;
The number of training steps to do. This is not required by all schedulers (hence the argument being
optional), the function will raise an error if it&#x2019;s unset and the scheduler type requires it.`,name:"num_training_steps"},{anchor:"transformers.get_scheduler.scheduler_specific_kwargs",description:`<strong>scheduler_specific_kwargs</strong> (<code>dict</code>, <em>optional</em>) &#x2014;
Extra parameters for schedulers such as cosine with restarts. Mismatched scheduler types and scheduler
parameters will cause the scheduler function to raise a TypeError.`,name:"scheduler_specific_kwargs"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization.py#L471"}}),ge=new M({props:{name:"transformers.get_constant_schedule",anchor:"transformers.get_constant_schedule",parameters:[{name:"optimizer",val:": Optimizer"},{name:"last_epoch",val:": int = -1"}],parametersDescription:[{anchor:"transformers.get_constant_schedule.optimizer",description:`<strong>optimizer</strong> (<code>~torch.optim.Optimizer</code>) &#x2014;
The optimizer for which to schedule the learning rate.`,name:"optimizer"},{anchor:"transformers.get_constant_schedule.last_epoch",description:`<strong>last_epoch</strong> (<code>int</code>, <em>optional</em>, defaults to -1) &#x2014;
The index of the last epoch when resuming training.`,name:"last_epoch"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization.py#L40",returnDescription:`<script context="module">export const metadata = 'undefined';<\/script>


<p><code>torch.optim.lr_scheduler.LambdaLR</code> with the appropriate schedule.</p>
`}}),fe=new M({props:{name:"transformers.get_constant_schedule_with_warmup",anchor:"transformers.get_constant_schedule_with_warmup",parameters:[{name:"optimizer",val:": Optimizer"},{name:"num_warmup_steps",val:": int"},{name:"last_epoch",val:": int = -1"}],parametersDescription:[{anchor:"transformers.get_constant_schedule_with_warmup.optimizer",description:`<strong>optimizer</strong> (<code>~torch.optim.Optimizer</code>) &#x2014;
The optimizer for which to schedule the learning rate.`,name:"optimizer"},{anchor:"transformers.get_constant_schedule_with_warmup.num_warmup_steps",description:`<strong>num_warmup_steps</strong> (<code>int</code>) &#x2014;
The number of steps for the warmup phase.`,name:"num_warmup_steps"},{anchor:"transformers.get_constant_schedule_with_warmup.last_epoch",description:`<strong>last_epoch</strong> (<code>int</code>, <em>optional</em>, defaults to -1) &#x2014;
The index of the last epoch when resuming training.`,name:"last_epoch"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization.py#L81",returnDescription:`<script context="module">export const metadata = 'undefined';<\/script>


<p><code>torch.optim.lr_scheduler.LambdaLR</code> with the appropriate schedule.</p>
`}}),we=new M({props:{name:"transformers.get_cosine_schedule_with_warmup",anchor:"transformers.get_cosine_schedule_with_warmup",parameters:[{name:"optimizer",val:": Optimizer"},{name:"num_warmup_steps",val:": int"},{name:"num_training_steps",val:": int"},{name:"num_cycles",val:": float = 0.5"},{name:"last_epoch",val:": int = -1"}],parametersDescription:[{anchor:"transformers.get_cosine_schedule_with_warmup.optimizer",description:`<strong>optimizer</strong> (<code>~torch.optim.Optimizer</code>) &#x2014;
The optimizer for which to schedule the learning rate.`,name:"optimizer"},{anchor:"transformers.get_cosine_schedule_with_warmup.num_warmup_steps",description:`<strong>num_warmup_steps</strong> (<code>int</code>) &#x2014;
The number of steps for the warmup phase.`,name:"num_warmup_steps"},{anchor:"transformers.get_cosine_schedule_with_warmup.num_training_steps",description:`<strong>num_training_steps</strong> (<code>int</code>) &#x2014;
The total number of training steps.`,name:"num_training_steps"},{anchor:"transformers.get_cosine_schedule_with_warmup.num_cycles",description:`<strong>num_cycles</strong> (<code>float</code>, <em>optional</em>, defaults to 0.5) &#x2014;
The number of waves in the cosine schedule (the defaults is to just decrease from the max value to 0
following a half-cosine).`,name:"num_cycles"},{anchor:"transformers.get_cosine_schedule_with_warmup.last_epoch",description:`<strong>last_epoch</strong> (<code>int</code>, <em>optional</em>, defaults to -1) &#x2014;
The index of the last epoch when resuming training.`,name:"last_epoch"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization.py#L144",returnDescription:`<script context="module">export const metadata = 'undefined';<\/script>


<p><code>torch.optim.lr_scheduler.LambdaLR</code> with the appropriate schedule.</p>
`}}),$e=new M({props:{name:"transformers.get_cosine_with_hard_restarts_schedule_with_warmup",anchor:"transformers.get_cosine_with_hard_restarts_schedule_with_warmup",parameters:[{name:"optimizer",val:": Optimizer"},{name:"num_warmup_steps",val:": int"},{name:"num_training_steps",val:": int"},{name:"num_cycles",val:": int = 1"},{name:"last_epoch",val:": int = -1"}],parametersDescription:[{anchor:"transformers.get_cosine_with_hard_restarts_schedule_with_warmup.optimizer",description:`<strong>optimizer</strong> (<code>~torch.optim.Optimizer</code>) &#x2014;
The optimizer for which to schedule the learning rate.`,name:"optimizer"},{anchor:"transformers.get_cosine_with_hard_restarts_schedule_with_warmup.num_warmup_steps",description:`<strong>num_warmup_steps</strong> (<code>int</code>) &#x2014;
The number of steps for the warmup phase.`,name:"num_warmup_steps"},{anchor:"transformers.get_cosine_with_hard_restarts_schedule_with_warmup.num_training_steps",description:`<strong>num_training_steps</strong> (<code>int</code>) &#x2014;
The total number of training steps.`,name:"num_training_steps"},{anchor:"transformers.get_cosine_with_hard_restarts_schedule_with_warmup.num_cycles",description:`<strong>num_cycles</strong> (<code>int</code>, <em>optional</em>, defaults to 1) &#x2014;
The number of hard restarts to use.`,name:"num_cycles"},{anchor:"transformers.get_cosine_with_hard_restarts_schedule_with_warmup.last_epoch",description:`<strong>last_epoch</strong> (<code>int</code>, <em>optional</em>, defaults to -1) &#x2014;
The index of the last epoch when resuming training.`,name:"last_epoch"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization.py#L189",returnDescription:`<script context="module">export const metadata = 'undefined';<\/script>


<p><code>torch.optim.lr_scheduler.LambdaLR</code> with the appropriate schedule.</p>
`}}),ye=new M({props:{name:"transformers.get_linear_schedule_with_warmup",anchor:"transformers.get_linear_schedule_with_warmup",parameters:[{name:"optimizer",val:""},{name:"num_warmup_steps",val:""},{name:"num_training_steps",val:""},{name:"last_epoch",val:" = -1"}],parametersDescription:[{anchor:"transformers.get_linear_schedule_with_warmup.optimizer",description:`<strong>optimizer</strong> (<code>~torch.optim.Optimizer</code>) &#x2014;
The optimizer for which to schedule the learning rate.`,name:"optimizer"},{anchor:"transformers.get_linear_schedule_with_warmup.num_warmup_steps",description:`<strong>num_warmup_steps</strong> (<code>int</code>) &#x2014;
The number of steps for the warmup phase.`,name:"num_warmup_steps"},{anchor:"transformers.get_linear_schedule_with_warmup.num_training_steps",description:`<strong>num_training_steps</strong> (<code>int</code>) &#x2014;
The total number of training steps.`,name:"num_training_steps"},{anchor:"transformers.get_linear_schedule_with_warmup.last_epoch",description:`<strong>last_epoch</strong> (<code>int</code>, <em>optional</em>, defaults to -1) &#x2014;
The index of the last epoch when resuming training.`,name:"last_epoch"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization.py#L108",returnDescription:`<script context="module">export const metadata = 'undefined';<\/script>


<p><code>torch.optim.lr_scheduler.LambdaLR</code> with the appropriate schedule.</p>
`}}),Te=new M({props:{name:"transformers.get_polynomial_decay_schedule_with_warmup",anchor:"transformers.get_polynomial_decay_schedule_with_warmup",parameters:[{name:"optimizer",val:""},{name:"num_warmup_steps",val:""},{name:"num_training_steps",val:""},{name:"lr_end",val:" = 1e-07"},{name:"power",val:" = 1.0"},{name:"last_epoch",val:" = -1"}],parametersDescription:[{anchor:"transformers.get_polynomial_decay_schedule_with_warmup.optimizer",description:`<strong>optimizer</strong> (<code>~torch.optim.Optimizer</code>) &#x2014;
The optimizer for which to schedule the learning rate.`,name:"optimizer"},{anchor:"transformers.get_polynomial_decay_schedule_with_warmup.num_warmup_steps",description:`<strong>num_warmup_steps</strong> (<code>int</code>) &#x2014;
The number of steps for the warmup phase.`,name:"num_warmup_steps"},{anchor:"transformers.get_polynomial_decay_schedule_with_warmup.num_training_steps",description:`<strong>num_training_steps</strong> (<code>int</code>) &#x2014;
The total number of training steps.`,name:"num_training_steps"},{anchor:"transformers.get_polynomial_decay_schedule_with_warmup.lr_end",description:`<strong>lr_end</strong> (<code>float</code>, <em>optional</em>, defaults to 1e-7) &#x2014;
The end LR.`,name:"lr_end"},{anchor:"transformers.get_polynomial_decay_schedule_with_warmup.power",description:`<strong>power</strong> (<code>float</code>, <em>optional</em>, defaults to 1.0) &#x2014;
Power factor.`,name:"power"},{anchor:"transformers.get_polynomial_decay_schedule_with_warmup.last_epoch",description:`<strong>last_epoch</strong> (<code>int</code>, <em>optional</em>, defaults to -1) &#x2014;
The index of the last epoch when resuming training.`,name:"last_epoch"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization.py#L243",returnDescription:`<script context="module">export const metadata = 'undefined';<\/script>


<p><code>torch.optim.lr_scheduler.LambdaLR</code> with the appropriate schedule.</p>
`}}),ze=new M({props:{name:"transformers.get_inverse_sqrt_schedule",anchor:"transformers.get_inverse_sqrt_schedule",parameters:[{name:"optimizer",val:": Optimizer"},{name:"num_warmup_steps",val:": int"},{name:"timescale",val:": int = None"},{name:"last_epoch",val:": int = -1"}],parametersDescription:[{anchor:"transformers.get_inverse_sqrt_schedule.optimizer",description:`<strong>optimizer</strong> (<code>~torch.optim.Optimizer</code>) &#x2014;
The optimizer for which to schedule the learning rate.`,name:"optimizer"},{anchor:"transformers.get_inverse_sqrt_schedule.num_warmup_steps",description:`<strong>num_warmup_steps</strong> (<code>int</code>) &#x2014;
The number of steps for the warmup phase.`,name:"num_warmup_steps"},{anchor:"transformers.get_inverse_sqrt_schedule.timescale",description:`<strong>timescale</strong> (<code>int</code>, <em>optional</em>, defaults to <code>num_warmup_steps</code>) &#x2014;
Time scale.`,name:"timescale"},{anchor:"transformers.get_inverse_sqrt_schedule.last_epoch",description:`<strong>last_epoch</strong> (<code>int</code>, <em>optional</em>, defaults to -1) &#x2014;
The index of the last epoch when resuming training.`,name:"last_epoch"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization.py#L297",returnDescription:`<script context="module">export const metadata = 'undefined';<\/script>


<p><code>torch.optim.lr_scheduler.LambdaLR</code> with the appropriate schedule.</p>
`}}),Me=new Z({props:{title:"Warmup (TensorFlow)",local:"transformers.WarmUp",headingTag:"h3"}}),Ae=new M({props:{name:"class transformers.WarmUp",anchor:"transformers.WarmUp",parameters:[{name:"initial_learning_rate",val:": float"},{name:"decay_schedule_fn",val:": Callable"},{name:"warmup_steps",val:": int"},{name:"power",val:": float = 1.0"},{name:"name",val:": str = None"}],parametersDescription:[{anchor:"transformers.WarmUp.initial_learning_rate",description:`<strong>initial_learning_rate</strong> (<code>float</code>) &#x2014;
The initial learning rate for the schedule after the warmup (so this will be the learning rate at the end
of the warmup).`,name:"initial_learning_rate"},{anchor:"transformers.WarmUp.decay_schedule_fn",description:`<strong>decay_schedule_fn</strong> (<code>Callable</code>) &#x2014;
The schedule function to apply after the warmup for the rest of training.`,name:"decay_schedule_fn"},{anchor:"transformers.WarmUp.warmup_steps",description:`<strong>warmup_steps</strong> (<code>int</code>) &#x2014;
The number of steps for the warmup part of training.`,name:"warmup_steps"},{anchor:"transformers.WarmUp.power",description:`<strong>power</strong> (<code>float</code>, <em>optional</em>, defaults to 1.0) &#x2014;
The power to use for the polynomial warmup (defaults is a linear warmup).`,name:"power"},{anchor:"transformers.WarmUp.name",description:`<strong>name</strong> (<code>str</code>, <em>optional</em>) &#x2014;
Optional name prefix for the returned tensors during the schedule.`,name:"name"}],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization_tf.py#L38"}}),Ce=new Z({props:{title:"Gradient Strategies",local:"gradient-strategies",headingTag:"h2"}}),We=new Z({props:{title:"GradientAccumulator (TensorFlow)",local:"transformers.GradientAccumulator",headingTag:"h3"}}),Le=new M({props:{name:"class transformers.GradientAccumulator",anchor:"transformers.GradientAccumulator",parameters:[],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization_tf.py#L310"}}),je=new M({props:{name:"reset",anchor:"transformers.GradientAccumulator.reset",parameters:[],source:"https://github.com/huggingface/transformers/blob/main/src/transformers/optimization_tf.py#L372"}}),Ue=new xa({props:{source:"https://github.com/huggingface/transformers/blob/main/docs/source/zh/main_classes/optimizer_schedules.md"}}),{c(){c=l("meta"),A=a(),x=l("p"),_=a(),p(v.$$.fragment),s=a(),T=l("p"),T.innerHTML=Pr,dt=a(),ee=l("ul"),ee.innerHTML=Vr,ht=a(),p(te.$$.fragment),ut=a(),W=l("div"),p(re.$$.fragment),nr=a(),Ee=l("p"),Ee.innerHTML=Gr,or=a(),H=l("div"),p(ae.$$.fragment),sr=a(),ke=l("p"),ke.textContent=Jr,gt=a(),p(ne.$$.fragment),ft=a(),b=l("div"),p(oe.$$.fragment),ir=a(),Ie=l("p"),Ie.innerHTML=Nr,lr=a(),Fe=l("p"),Fe.innerHTML=Zr,mr=a(),Pe=l("p"),Pe.textContent=Hr,cr=a(),Ve=l("p"),Ve.innerHTML=Sr,pr=a(),Ge=l("ul"),Ge.innerHTML=qr,dr=a(),p(S.$$.fragment),hr=a(),p(q.$$.fragment),ur=a(),Je=l("p"),Je.innerHTML=Br,gr=a(),p(B.$$.fragment),fr=a(),p(X.$$.fragment),_r=a(),O=l("div"),p(se.$$.fragment),wr=a(),Ne=l("p"),Ne.textContent=Xr,_t=a(),p(ie.$$.fragment),wt=a(),C=l("div"),p(le.$$.fragment),br=a(),Ze=l("p"),Ze.innerHTML=Or,$r=a(),He=l("p"),He.textContent=Yr,vr=a(),Y=l("div"),p(me.$$.fragment),yr=a(),Se=l("p"),Se.textContent=Qr,bt=a(),R=l("div"),p(ce.$$.fragment),xr=a(),qe=l("p"),qe.textContent=Kr,$t=a(),p(pe.$$.fragment),vt=a(),p(de.$$.fragment),yt=a(),L=l("div"),p(he.$$.fragment),Tr=a(),Be=l("p"),Be.innerHTML=ea,zr=a(),Xe=l("ul"),Xe.innerHTML=ta,xt=a(),E=l("div"),p(ue.$$.fragment),Mr=a(),Oe=l("p"),Oe.textContent=ra,Tt=a(),k=l("div"),p(ge.$$.fragment),Ar=a(),Ye=l("p"),Ye.textContent=aa,zt=a(),I=l("div"),p(fe.$$.fragment),Cr=a(),Qe=l("p"),Qe.textContent=na,Mt=a(),_e=l("img"),At=a(),F=l("div"),p(we.$$.fragment),Wr=a(),Ke=l("p"),Ke.textContent=sa,Ct=a(),be=l("img"),Wt=a(),P=l("div"),p($e.$$.fragment),Lr=a(),et=l("p"),et.textContent=la,Lt=a(),ve=l("img"),jt=a(),V=l("div"),p(ye.$$.fragment),jr=a(),tt=l("p"),tt.textContent=ca,Ut=a(),xe=l("img"),Dt=a(),j=l("div"),p(Te.$$.fragment),Ur=a(),rt=l("p"),rt.innerHTML=da,Dr=a(),at=l("p"),at.innerHTML=ha,Rt=a(),G=l("div"),p(ze.$$.fragment),Rr=a(),nt=l("p"),nt.textContent=ua,Et=a(),p(Me.$$.fragment),kt=a(),J=l("div"),p(Ae.$$.fragment),Er=a(),ot=l("p"),ot.textContent=ga,It=a(),p(Ce.$$.fragment),Ft=a(),p(We.$$.fragment),Pt=a(),U=l("div"),p(Le.$$.fragment),kr=a(),st=l("p"),st.innerHTML=fa,Ir=a(),Q=l("div"),p(je.$$.fragment),Fr=a(),it=l("p"),it.textContent=_a,Vt=a(),p(Ue.$$.fragment),Gt=a(),pt=l("p"),this.h()},l(e){const r=ya("svelte-u9bgzb",document.head);c=m(r,"META",{name:!0,content:!0}),r.forEach(t),A=n(e),x=m(e,"P",{}),z(x).forEach(t),_=n(e),d(v.$$.fragment,e),s=n(e),T=m(e,"P",{"data-svelte-h":!0}),w(T)!=="svelte-1p2ld9z"&&(T.innerHTML=Pr),dt=n(e),ee=m(e,"UL",{"data-svelte-h":!0}),w(ee)!=="svelte-p818uy"&&(ee.innerHTML=Vr),ht=n(e),d(te.$$.fragment,e),ut=n(e),W=m(e,"DIV",{class:!0});var N=z(W);d(re.$$.fragment,N),nr=n(N),Ee=m(N,"P",{"data-svelte-h":!0}),w(Ee)!=="svelte-b86q21"&&(Ee.innerHTML=Gr),or=n(N),H=m(N,"DIV",{class:!0});var De=z(H);d(ae.$$.fragment,De),sr=n(De),ke=m(De,"P",{"data-svelte-h":!0}),w(ke)!=="svelte-1gr03w4"&&(ke.textContent=Jr),De.forEach(t),N.forEach(t),gt=n(e),d(ne.$$.fragment,e),ft=n(e),b=m(e,"DIV",{class:!0});var y=z(b);d(oe.$$.fragment,y),ir=n(y),Ie=m(y,"P",{"data-svelte-h":!0}),w(Ie)!=="svelte-114ll6r"&&(Ie.innerHTML=Nr),lr=n(y),Fe=m(y,"P",{"data-svelte-h":!0}),w(Fe)!=="svelte-9bvrpy"&&(Fe.innerHTML=Zr),mr=n(y),Pe=m(y,"P",{"data-svelte-h":!0}),w(Pe)!=="svelte-1dxk71o"&&(Pe.textContent=Hr),cr=n(y),Ve=m(y,"P",{"data-svelte-h":!0}),w(Ve)!=="svelte-kc6644"&&(Ve.innerHTML=Sr),pr=n(y),Ge=m(y,"UL",{"data-svelte-h":!0}),w(Ge)!=="svelte-p81jc"&&(Ge.innerHTML=qr),dr=n(y),d(S.$$.fragment,y),hr=n(y),d(q.$$.fragment,y),ur=n(y),Je=m(y,"P",{"data-svelte-h":!0}),w(Je)!=="svelte-w4e00h"&&(Je.innerHTML=Br),gr=n(y),d(B.$$.fragment,y),fr=n(y),d(X.$$.fragment,y),_r=n(y),O=m(y,"DIV",{class:!0});var Re=z(O);d(se.$$.fragment,Re),wr=n(Re),Ne=m(Re,"P",{"data-svelte-h":!0}),w(Ne)!=="svelte-6lkj7q"&&(Ne.textContent=Xr),Re.forEach(t),y.forEach(t),_t=n(e),d(ie.$$.fragment,e),wt=n(e),C=m(e,"DIV",{class:!0});var K=z(C);d(le.$$.fragment,K),br=n(K),Ze=m(K,"P",{"data-svelte-h":!0}),w(Ze)!=="svelte-towids"&&(Ze.innerHTML=Or),$r=n(K),He=m(K,"P",{"data-svelte-h":!0}),w(He)!=="svelte-id029h"&&(He.textContent=Yr),vr=n(K),Y=m(K,"DIV",{class:!0});var Nt=z(Y);d(me.$$.fragment,Nt),yr=n(Nt),Se=m(Nt,"P",{"data-svelte-h":!0}),w(Se)!=="svelte-3iict9"&&(Se.textContent=Qr),Nt.forEach(t),K.forEach(t),bt=n(e),R=m(e,"DIV",{class:!0});var Zt=z(R);d(ce.$$.fragment,Zt),xr=n(Zt),qe=m(Zt,"P",{"data-svelte-h":!0}),w(qe)!=="svelte-16qojcu"&&(qe.textContent=Kr),Zt.forEach(t),$t=n(e),d(pe.$$.fragment,e),vt=n(e),d(de.$$.fragment,e),yt=n(e),L=m(e,"DIV",{class:!0});var lt=z(L);d(he.$$.fragment,lt),Tr=n(lt),Be=m(lt,"P",{"data-svelte-h":!0}),w(Be)!=="svelte-1u50d1g"&&(Be.innerHTML=ea),zr=n(lt),Xe=m(lt,"UL",{"data-svelte-h":!0}),w(Xe)!=="svelte-1i9daf3"&&(Xe.innerHTML=ta),lt.forEach(t),xt=n(e),E=m(e,"DIV",{class:!0});var Ht=z(E);d(ue.$$.fragment,Ht),Mr=n(Ht),Oe=m(Ht,"P",{"data-svelte-h":!0}),w(Oe)!=="svelte-1oh310h"&&(Oe.textContent=ra),Ht.forEach(t),Tt=n(e),k=m(e,"DIV",{class:!0});var St=z(k);d(ge.$$.fragment,St),Ar=n(St),Ye=m(St,"P",{"data-svelte-h":!0}),w(Ye)!=="svelte-cadr4a"&&(Ye.textContent=aa),St.forEach(t),zt=n(e),I=m(e,"DIV",{class:!0});var qt=z(I);d(fe.$$.fragment,qt),Cr=n(qt),Qe=m(qt,"P",{"data-svelte-h":!0}),w(Qe)!=="svelte-1lj8vcj"&&(Qe.textContent=na),qt.forEach(t),Mt=n(e),_e=m(e,"IMG",{alt:!0,src:!0}),At=n(e),F=m(e,"DIV",{class:!0});var Bt=z(F);d(we.$$.fragment,Bt),Wr=n(Bt),Ke=m(Bt,"P",{"data-svelte-h":!0}),w(Ke)!=="svelte-1lhkhz0"&&(Ke.textContent=sa),Bt.forEach(t),Ct=n(e),be=m(e,"IMG",{alt:!0,src:!0}),Wt=n(e),P=m(e,"DIV",{class:!0});var Xt=z(P);d($e.$$.fragment,Xt),Lr=n(Xt),et=m(Xt,"P",{"data-svelte-h":!0}),w(et)!=="svelte-1pclsvt"&&(et.textContent=la),Xt.forEach(t),Lt=n(e),ve=m(e,"IMG",{alt:!0,src:!0}),jt=n(e),V=m(e,"DIV",{class:!0});var Ot=z(V);d(ye.$$.fragment,Ot),jr=n(Ot),tt=m(Ot,"P",{"data-svelte-h":!0}),w(tt)!=="svelte-17q4ov5"&&(tt.textContent=ca),Ot.forEach(t),Ut=n(e),xe=m(e,"IMG",{alt:!0,src:!0}),Dt=n(e),j=m(e,"DIV",{class:!0});var mt=z(j);d(Te.$$.fragment,mt),Ur=n(mt),rt=m(mt,"P",{"data-svelte-h":!0}),w(rt)!=="svelte-1y55gjq"&&(rt.innerHTML=da),Dr=n(mt),at=m(mt,"P",{"data-svelte-h":!0}),w(at)!=="svelte-1tn0l2l"&&(at.innerHTML=ha),mt.forEach(t),Rt=n(e),G=m(e,"DIV",{class:!0});var Yt=z(G);d(ze.$$.fragment,Yt),Rr=n(Yt),nt=m(Yt,"P",{"data-svelte-h":!0}),w(nt)!=="svelte-yp2yn6"&&(nt.textContent=ua),Yt.forEach(t),Et=n(e),d(Me.$$.fragment,e),kt=n(e),J=m(e,"DIV",{class:!0});var Qt=z(J);d(Ae.$$.fragment,Qt),Er=n(Qt),ot=m(Qt,"P",{"data-svelte-h":!0}),w(ot)!=="svelte-1mfn66a"&&(ot.textContent=ga),Qt.forEach(t),It=n(e),d(Ce.$$.fragment,e),Ft=n(e),d(We.$$.fragment,e),Pt=n(e),U=m(e,"DIV",{class:!0});var ct=z(U);d(Le.$$.fragment,ct),kr=n(ct),st=m(ct,"P",{"data-svelte-h":!0}),w(st)!=="svelte-8tkiw"&&(st.innerHTML=fa),Ir=n(ct),Q=m(ct,"DIV",{class:!0});var Kt=z(Q);d(je.$$.fragment,Kt),Fr=n(Kt),it=m(Kt,"P",{"data-svelte-h":!0}),w(it)!=="svelte-v0y289"&&(it.textContent=_a),Kt.forEach(t),ct.forEach(t),Vt=n(e),d(Ue.$$.fragment,e),Gt=n(e),pt=m(e,"P",{}),z(pt).forEach(t),this.h()},h(){$(c,"name","hf:doc:metadata"),$(c,"content",Wa),$(H,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(W,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(O,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(b,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(Y,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(C,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(R,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(L,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(E,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(k,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(I,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(_e,"alt",""),er(_e.src,oa="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/warmup_constant_schedule.png")||$(_e,"src",oa),$(F,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(be,"alt",""),er(be.src,ia="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/warmup_cosine_schedule.png")||$(be,"src",ia),$(P,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(ve,"alt",""),er(ve.src,ma="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/warmup_cosine_hard_restarts_schedule.png")||$(ve,"src",ma),$(V,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(xe,"alt",""),er(xe.src,pa="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/warmup_linear_schedule.png")||$(xe,"src",pa),$(j,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(G,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(J,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(Q,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),$(U,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8")},m(e,r){o(document.head,c),i(e,A,r),i(e,x,r),i(e,_,r),h(v,e,r),i(e,s,r),i(e,T,r),i(e,dt,r),i(e,ee,r),i(e,ht,r),h(te,e,r),i(e,ut,r),i(e,W,r),h(re,W,null),o(W,nr),o(W,Ee),o(W,or),o(W,H),h(ae,H,null),o(H,sr),o(H,ke),i(e,gt,r),h(ne,e,r),i(e,ft,r),i(e,b,r),h(oe,b,null),o(b,ir),o(b,Ie),o(b,lr),o(b,Fe),o(b,mr),o(b,Pe),o(b,cr),o(b,Ve),o(b,pr),o(b,Ge),o(b,dr),h(S,b,null),o(b,hr),h(q,b,null),o(b,ur),o(b,Je),o(b,gr),h(B,b,null),o(b,fr),h(X,b,null),o(b,_r),o(b,O),h(se,O,null),o(O,wr),o(O,Ne),i(e,_t,r),h(ie,e,r),i(e,wt,r),i(e,C,r),h(le,C,null),o(C,br),o(C,Ze),o(C,$r),o(C,He),o(C,vr),o(C,Y),h(me,Y,null),o(Y,yr),o(Y,Se),i(e,bt,r),i(e,R,r),h(ce,R,null),o(R,xr),o(R,qe),i(e,$t,r),h(pe,e,r),i(e,vt,r),h(de,e,r),i(e,yt,r),i(e,L,r),h(he,L,null),o(L,Tr),o(L,Be),o(L,zr),o(L,Xe),i(e,xt,r),i(e,E,r),h(ue,E,null),o(E,Mr),o(E,Oe),i(e,Tt,r),i(e,k,r),h(ge,k,null),o(k,Ar),o(k,Ye),i(e,zt,r),i(e,I,r),h(fe,I,null),o(I,Cr),o(I,Qe),i(e,Mt,r),i(e,_e,r),i(e,At,r),i(e,F,r),h(we,F,null),o(F,Wr),o(F,Ke),i(e,Ct,r),i(e,be,r),i(e,Wt,r),i(e,P,r),h($e,P,null),o(P,Lr),o(P,et),i(e,Lt,r),i(e,ve,r),i(e,jt,r),i(e,V,r),h(ye,V,null),o(V,jr),o(V,tt),i(e,Ut,r),i(e,xe,r),i(e,Dt,r),i(e,j,r),h(Te,j,null),o(j,Ur),o(j,rt),o(j,Dr),o(j,at),i(e,Rt,r),i(e,G,r),h(ze,G,null),o(G,Rr),o(G,nt),i(e,Et,r),h(Me,e,r),i(e,kt,r),i(e,J,r),h(Ae,J,null),o(J,Er),o(J,ot),i(e,It,r),h(Ce,e,r),i(e,Ft,r),h(We,e,r),i(e,Pt,r),i(e,U,r),h(Le,U,null),o(U,kr),o(U,st),o(U,Ir),o(U,Q),h(je,Q,null),o(Q,Fr),o(Q,it),i(e,Vt,r),h(Ue,e,r),i(e,Gt,r),i(e,pt,r),Jt=!0},p(e,[r]){const N={};r&2&&(N.$$scope={dirty:r,ctx:e}),S.$set(N);const De={};r&2&&(De.$$scope={dirty:r,ctx:e}),q.$set(De);const y={};r&2&&(y.$$scope={dirty:r,ctx:e}),B.$set(y);const Re={};r&2&&(Re.$$scope={dirty:r,ctx:e}),X.$set(Re)},i(e){Jt||(u(v.$$.fragment,e),u(te.$$.fragment,e),u(re.$$.fragment,e),u(ae.$$.fragment,e),u(ne.$$.fragment,e),u(oe.$$.fragment,e),u(S.$$.fragment,e),u(q.$$.fragment,e),u(B.$$.fragment,e),u(X.$$.fragment,e),u(se.$$.fragment,e),u(ie.$$.fragment,e),u(le.$$.fragment,e),u(me.$$.fragment,e),u(ce.$$.fragment,e),u(pe.$$.fragment,e),u(de.$$.fragment,e),u(he.$$.fragment,e),u(ue.$$.fragment,e),u(ge.$$.fragment,e),u(fe.$$.fragment,e),u(we.$$.fragment,e),u($e.$$.fragment,e),u(ye.$$.fragment,e),u(Te.$$.fragment,e),u(ze.$$.fragment,e),u(Me.$$.fragment,e),u(Ae.$$.fragment,e),u(Ce.$$.fragment,e),u(We.$$.fragment,e),u(Le.$$.fragment,e),u(je.$$.fragment,e),u(Ue.$$.fragment,e),Jt=!0)},o(e){g(v.$$.fragment,e),g(te.$$.fragment,e),g(re.$$.fragment,e),g(ae.$$.fragment,e),g(ne.$$.fragment,e),g(oe.$$.fragment,e),g(S.$$.fragment,e),g(q.$$.fragment,e),g(B.$$.fragment,e),g(X.$$.fragment,e),g(se.$$.fragment,e),g(ie.$$.fragment,e),g(le.$$.fragment,e),g(me.$$.fragment,e),g(ce.$$.fragment,e),g(pe.$$.fragment,e),g(de.$$.fragment,e),g(he.$$.fragment,e),g(ue.$$.fragment,e),g(ge.$$.fragment,e),g(fe.$$.fragment,e),g(we.$$.fragment,e),g($e.$$.fragment,e),g(ye.$$.fragment,e),g(Te.$$.fragment,e),g(ze.$$.fragment,e),g(Me.$$.fragment,e),g(Ae.$$.fragment,e),g(Ce.$$.fragment,e),g(We.$$.fragment,e),g(Le.$$.fragment,e),g(je.$$.fragment,e),g(Ue.$$.fragment,e),Jt=!1},d(e){e&&(t(A),t(x),t(_),t(s),t(T),t(dt),t(ee),t(ht),t(ut),t(W),t(gt),t(ft),t(b),t(_t),t(wt),t(C),t(bt),t(R),t($t),t(vt),t(yt),t(L),t(xt),t(E),t(Tt),t(k),t(zt),t(I),t(Mt),t(_e),t(At),t(F),t(Ct),t(be),t(Wt),t(P),t(Lt),t(ve),t(jt),t(V),t(Ut),t(xe),t(Dt),t(j),t(Rt),t(G),t(Et),t(kt),t(J),t(It),t(Ft),t(Pt),t(U),t(Vt),t(Gt),t(pt)),t(c),f(v,e),f(te,e),f(re),f(ae),f(ne,e),f(oe),f(S),f(q),f(B),f(X),f(se),f(ie,e),f(le),f(me),f(ce),f(pe,e),f(de,e),f(he),f(ue),f(ge),f(fe),f(we),f($e),f(ye),f(Te),f(ze),f(Me,e),f(Ae),f(Ce,e),f(We,e),f(Le),f(je),f(Ue,e)}}}const Wa='{"title":"Optimization","local":"optimization","sections":[{"title":"AdamW (PyTorch)","local":"transformers.AdamW","sections":[],"depth":2},{"title":"AdaFactor (PyTorch)","local":"transformers.Adafactor","sections":[],"depth":2},{"title":"AdamWeightDecay (TensorFlow)","local":"transformers.AdamWeightDecay","sections":[],"depth":2},{"title":"Schedules","local":"schedules","sections":[{"title":"Learning Rate Schedules (Pytorch)","local":"transformers.SchedulerType","sections":[],"depth":3},{"title":"Warmup (TensorFlow)","local":"transformers.WarmUp","sections":[],"depth":3}],"depth":2},{"title":"Gradient Strategies","local":"gradient-strategies","sections":[{"title":"GradientAccumulator (TensorFlow)","local":"transformers.GradientAccumulator","sections":[],"depth":3}],"depth":2}],"depth":1}';function La(D){return ba(()=>{new URLSearchParams(window.location.search).get("fw")}),[]}class Ia extends $a{constructor(c){super(),va(this,c,La,Ca,wa,{})}}export{Ia as component};
