diffusers/pr_9017/en/_app/immutable/nodes/139.79c8a2b3.js

import{s as Oe,n as Pe,o as ke}from"../chunks/scheduler.8c3d61f6.js";import{S as Ee,i as Le,g as d,s as r,r as l,A as Ie,h as a,f as t,c as i,j as D,u as p,x as H,k as T,y as s,a as u,v as m,d as f,t as h,w as g}from"../chunks/index.da70eac4.js";import{D as K}from"../chunks/Docstring.ee4b6913.js";import{H as ve,E as Me}from"../chunks/EditOnGithub.1e64e623.js";function qe($e){let _,R,B,W,y,J,w,xe='The Heun scheduler (Algorithm 1) is from the <a href="https://huggingface.co/papers/2206.00364" rel="nofollow">Elucidating the Design Space of Diffusion-Based Generative Models</a> paper by Karras et al. The scheduler is ported from the <a href="https://github.com/crowsonkb/k-diffusion" rel="nofollow">k-diffusion</a> library and created by <a href="https://github.com/crowsonkb/" rel="nofollow">Katherine Crowson</a>.',Q,C,X,o,O,ae,N,Se="Scheduler with Heun steps for discrete beta schedules.",ce,V,De=`This model inherits from <a href="/docs/diffusers/pr_9017/en/api/schedulers/overview#diffusers.SchedulerMixin">SchedulerMixin</a> and <a href="/docs/diffusers/pr_9017/en/api/configuration#diffusers.ConfigMixin">ConfigMixin</a>. Check the superclass documentation for the generic
methods the library implements for all schedulers such as loading and saving.`,ue,v,P,le,U,He=`Ensures interchangeability with schedulers that need to scale the denoising model input depending on the
current timestep.`,pe,$,k,me,A,Te="Sets the begin index for the scheduler. This function should be run from pipeline before the inference.",fe,x,E,he,z,ye="Sets the discrete timesteps used for the diffusion chain (to be run before inference).",ge,S,L,_e,F,we=`Predict the sample from the previous timestep by reversing the SDE. This function propagates the diffusion
process from the learned model outputs (most often the predicted noise).`,Y,I,Z,b,M,be,j,Ce="Base class for the output of a scheduler’s <code>step</code> function.",ee,q,te,G,se;return y=new ve({props:{title:"HeunDiscreteScheduler",local:"heundiscretescheduler",headingTag:"h1"}}),C=new ve({props:{title:"HeunDiscreteScheduler",local:"diffusers.HeunDiscreteScheduler",headingTag:"h2"}}),O=new K({props:{name:"class diffusers.HeunDiscreteScheduler",anchor:"diffusers.HeunDiscreteScheduler",parameters:[{name:"num_train_timesteps",val:": int = 1000"},{name:"beta_start",val:": float = 0.00085"},{name:"beta_end",val:": float = 0.012"},{name:"beta_schedule",val:": str = 'linear'"},{name:"trained_betas",val:": Union = None"},{name:"prediction_type",val:": str = 'epsilon'"},{name:"use_karras_sigmas",val:": Optional = False"},{name:"clip_sample",val:": Optional = False"},{name:"clip_sample_range",val:": float = 1.0"},{name:"timestep_spacing",val:": str = 'linspace'"},{name:"steps_offset",val:": int = 0"}],parametersDescription:[{anchor:"diffusers.HeunDiscreteScheduler.num_train_timesteps",description:`<strong>num_train_timesteps</strong> (<code>int</code>, defaults to 1000) &#x2014;
The number of diffusion steps to train the model.`,name:"num_train_timesteps"},{anchor:"diffusers.HeunDiscreteScheduler.beta_start",description:`<strong>beta_start</strong> (<code>float</code>, defaults to 0.0001) &#x2014;
The starting <code>beta</code> value of inference.`,name:"beta_start"},{anchor:"diffusers.HeunDiscreteScheduler.beta_end",description:`<strong>beta_end</strong> (<code>float</code>, defaults to 0.02) &#x2014;
The final <code>beta</code> value.`,name:"beta_end"},{anchor:"diffusers.HeunDiscreteScheduler.beta_schedule",description:`<strong>beta_schedule</strong> (<code>str</code>, defaults to <code>&quot;linear&quot;</code>) &#x2014;
The beta schedule, a mapping from a beta range to a sequence of betas for stepping the model. Choose from
<code>linear</code> or <code>scaled_linear</code>.`,name:"beta_schedule"},{anchor:"diffusers.HeunDiscreteScheduler.trained_betas",description:`<strong>trained_betas</strong> (<code>np.ndarray</code>, <em>optional</em>) &#x2014;
Pass an array of betas directly to the constructor to bypass <code>beta_start</code> and <code>beta_end</code>.`,name:"trained_betas"},{anchor:"diffusers.HeunDiscreteScheduler.prediction_type",description:`<strong>prediction_type</strong> (<code>str</code>, defaults to <code>epsilon</code>, <em>optional</em>) &#x2014;
Prediction type of the scheduler function; can be <code>epsilon</code> (predicts the noise of the diffusion process),
<code>sample</code> (directly predicts the noisy sample<code>) or </code>v_prediction\` (see section 2.4 of <a href="https://imagen.research.google/video/paper.pdf" rel="nofollow">Imagen
Video</a> paper).`,name:"prediction_type"},{anchor:"diffusers.HeunDiscreteScheduler.clip_sample",description:`<strong>clip_sample</strong> (<code>bool</code>, defaults to <code>True</code>) &#x2014;
Clip the predicted sample for numerical stability.`,name:"clip_sample"},{anchor:"diffusers.HeunDiscreteScheduler.clip_sample_range",description:`<strong>clip_sample_range</strong> (<code>float</code>, defaults to 1.0) &#x2014;
The maximum magnitude for sample clipping. Valid only when <code>clip_sample=True</code>.`,name:"clip_sample_range"},{anchor:"diffusers.HeunDiscreteScheduler.use_karras_sigmas",description:`<strong>use_karras_sigmas</strong> (<code>bool</code>, <em>optional</em>, defaults to <code>False</code>) &#x2014;
Whether to use Karras sigmas for step sizes in the noise schedule during the sampling process. If <code>True</code>,
the sigmas are determined according to a sequence of noise levels {&#x3C3;i}.`,name:"use_karras_sigmas"},{anchor:"diffusers.HeunDiscreteScheduler.timestep_spacing",description:`<strong>timestep_spacing</strong> (<code>str</code>, defaults to <code>&quot;linspace&quot;</code>) &#x2014;
The way the timesteps should be scaled. Refer to Table 2 of the <a href="https://huggingface.co/papers/2305.08891" rel="nofollow">Common Diffusion Noise Schedules and
Sample Steps are Flawed</a> for more information.`,name:"timestep_spacing"},{anchor:"diffusers.HeunDiscreteScheduler.steps_offset",description:`<strong>steps_offset</strong> (<code>int</code>, defaults to 0) &#x2014;
An offset added to the inference steps, as required by some model families.`,name:"steps_offset"}],source:"https://github.com/huggingface/diffusers/blob/vr_9017/src/diffusers/schedulers/scheduling_heun_discrete.py#L70"}}),P=new K({props:{name:"scale_model_input",anchor:"diffusers.HeunDiscreteScheduler.scale_model_input",parameters:[{name:"sample",val:": Tensor"},{name:"timestep",val:": Union"}],parametersDescription:[{anchor:"diffusers.HeunDiscreteScheduler.scale_model_input.sample",description:`<strong>sample</strong> (<code>torch.Tensor</code>) &#x2014;
The input sample.`,name:"sample"},{anchor:"diffusers.HeunDiscreteScheduler.scale_model_input.timestep",description:`<strong>timestep</strong> (<code>int</code>, <em>optional</em>) &#x2014;
The current timestep in the diffusion chain.`,name:"timestep"}],source:"https://github.com/huggingface/diffusers/blob/vr_9017/src/diffusers/schedulers/scheduling_heun_discrete.py#L199",returnDescription:`<script context="module">export const metadata = 'undefined';<\/script>


<p>A scaled input sample.</p>
`,returnType:`<script context="module">export const metadata = 'undefined';<\/script>


<p><code>torch.Tensor</code></p>
`}}),k=new K({props:{name:"set_begin_index",anchor:"diffusers.HeunDiscreteScheduler.set_begin_index",parameters:[{name:"begin_index",val:": int = 0"}],parametersDescription:[{anchor:"diffusers.HeunDiscreteScheduler.set_begin_index.begin_index",description:`<strong>begin_index</strong> (<code>int</code>) &#x2014;
The begin index for the scheduler.`,name:"begin_index"}],source:"https://github.com/huggingface/diffusers/blob/vr_9017/src/diffusers/schedulers/scheduling_heun_discrete.py#L189"}}),E=new K({props:{name:"set_timesteps",anchor:"diffusers.HeunDiscreteScheduler.set_timesteps",parameters:[{name:"num_inference_steps",val:": Optional = None"},{name:"device",val:": Union = None"},{name:"num_train_timesteps",val:": Optional = None"},{name:"timesteps",val:": Optional = None"}],parametersDescription:[{anchor:"diffusers.HeunDiscreteScheduler.set_timesteps.num_inference_steps",description:`<strong>num_inference_steps</strong> (<code>int</code>) &#x2014;
The number of diffusion steps used when generating samples with a pre-trained model.`,name:"num_inference_steps"},{anchor:"diffusers.HeunDiscreteScheduler.set_timesteps.device",description:`<strong>device</strong> (<code>str</code> or <code>torch.device</code>, <em>optional</em>) &#x2014;
The device to which the timesteps should be moved to. If <code>None</code>, the timesteps are not moved.`,name:"device"},{anchor:"diffusers.HeunDiscreteScheduler.set_timesteps.num_train_timesteps",description:`<strong>num_train_timesteps</strong> (<code>int</code>, <em>optional</em>) &#x2014;
The number of diffusion steps used when training the model. If <code>None</code>, the default
<code>num_train_timesteps</code> attribute is used.`,name:"num_train_timesteps"},{anchor:"diffusers.HeunDiscreteScheduler.set_timesteps.timesteps",description:`<strong>timesteps</strong> (<code>List[int]</code>, <em>optional</em>) &#x2014;
Custom timesteps used to support arbitrary spacing between timesteps. If <code>None</code>, timesteps will be
generated based on the <code>timestep_spacing</code> attribute. If <code>timesteps</code> is passed, <code>num_inference_steps</code>
must be <code>None</code>, and <code>timestep_spacing</code> attribute will be ignored.`,name:"timesteps"}],source:"https://github.com/huggingface/diffusers/blob/vr_9017/src/diffusers/schedulers/scheduling_heun_discrete.py#L225"}}),L=new K({props:{name:"step",anchor:"diffusers.HeunDiscreteScheduler.step",parameters:[{name:"model_output",val:": Union"},{name:"timestep",val:": Union"},{name:"sample",val:": Union"},{name:"return_dict",val:": bool = True"}],parametersDescription:[{anchor:"diffusers.HeunDiscreteScheduler.step.model_output",description:`<strong>model_output</strong> (<code>torch.Tensor</code>) &#x2014;
The direct output from learned diffusion model.`,name:"model_output"},{anchor:"diffusers.HeunDiscreteScheduler.step.timestep",description:`<strong>timestep</strong> (<code>float</code>) &#x2014;
The current discrete timestep in the diffusion chain.`,name:"timestep"},{anchor:"diffusers.HeunDiscreteScheduler.step.sample",description:`<strong>sample</strong> (<code>torch.Tensor</code>) &#x2014;
A current instance of a sample created by the diffusion process.`,name:"sample"},{anchor:"diffusers.HeunDiscreteScheduler.step.return_dict",description:`<strong>return_dict</strong> (<code>bool</code>) &#x2014;
Whether or not to return a <a href="/docs/diffusers/pr_9017/en/api/schedulers/edm_multistep_dpm_solver#diffusers.schedulers.scheduling_utils.SchedulerOutput">SchedulerOutput</a> or tuple.`,name:"return_dict"}],source:"https://github.com/huggingface/diffusers/blob/vr_9017/src/diffusers/schedulers/scheduling_heun_discrete.py#L370",returnDescription:`<script context="module">export const metadata = 'undefined';<\/script>


<p>If return_dict is <code>True</code>, <a
  href="/docs/diffusers/pr_9017/en/api/schedulers/edm_multistep_dpm_solver#diffusers.schedulers.scheduling_utils.SchedulerOutput"
>SchedulerOutput</a> is returned, otherwise a
tuple is returned where the first element is the sample tensor.</p>
`,returnType:`<script context="module">export const metadata = 'undefined';<\/script>


<p><a
  href="/docs/diffusers/pr_9017/en/api/schedulers/edm_multistep_dpm_solver#diffusers.schedulers.scheduling_utils.SchedulerOutput"
>SchedulerOutput</a> or <code>tuple</code></p>
`}}),I=new ve({props:{title:"SchedulerOutput",local:"diffusers.schedulers.scheduling_utils.SchedulerOutput",headingTag:"h2"}}),M=new K({props:{name:"class diffusers.schedulers.scheduling_utils.SchedulerOutput",anchor:"diffusers.schedulers.scheduling_utils.SchedulerOutput",parameters:[{name:"prev_sample",val:": Tensor"}],parametersDescription:[{anchor:"diffusers.schedulers.scheduling_utils.SchedulerOutput.prev_sample",description:`<strong>prev_sample</strong> (<code>torch.Tensor</code> of shape <code>(batch_size, num_channels, height, width)</code> for images) &#x2014;
Computed sample <code>(x_{t-1})</code> of previous timestep. <code>prev_sample</code> should be used as next model input in the
denoising loop.`,name:"prev_sample"}],source:"https://github.com/huggingface/diffusers/blob/vr_9017/src/diffusers/schedulers/scheduling_utils.py#L60"}}),q=new Me({props:{source:"https://github.com/huggingface/diffusers/blob/main/docs/source/en/api/schedulers/heun.md"}}),{c(){_=d("meta"),R=r(),B=d("p"),W=r(),l(y.$$.fragment),J=r(),w=d("p"),w.innerHTML=xe,Q=r(),l(C.$$.fragment),X=r(),o=d("div"),l(O.$$.fragment),ae=r(),N=d("p"),N.textContent=Se,ce=r(),V=d("p"),V.innerHTML=De,ue=r(),v=d("div"),l(P.$$.fragment),le=r(),U=d("p"),U.textContent=He,pe=r(),$=d("div"),l(k.$$.fragment),me=r(),A=d("p"),A.textContent=Te,fe=r(),x=d("div"),l(E.$$.fragment),he=r(),z=d("p"),z.textContent=ye,ge=r(),S=d("div"),l(L.$$.fragment),_e=r(),F=d("p"),F.textContent=we,Y=r(),l(I.$$.fragment),Z=r(),b=d("div"),l(M.$$.fragment),be=r(),j=d("p"),j.innerHTML=Ce,ee=r(),l(q.$$.fragment),te=r(),G=d("p"),this.h()},l(e){const n=Ie("svelte-u9bgzb",document.head);_=a(n,"META",{name:!0,content:!0}),n.forEach(t),R=i(e),B=a(e,"P",{}),D(B).forEach(t),W=i(e),p(y.$$.fragment,e),J=i(e),w=a(e,"P",{"data-svelte-h":!0}),H(w)!=="svelte-1r9m54f"&&(w.innerHTML=xe),Q=i(e),p(C.$$.fragment,e),X=i(e),o=a(e,"DIV",{class:!0});var c=D(o);p(O.$$.fragment,c),ae=i(c),N=a(c,"P",{"data-svelte-h":!0}),H(N)!=="svelte-1k165jq"&&(N.textContent=Se),ce=i(c),V=a(c,"P",{"data-svelte-h":!0}),H(V)!=="svelte-1i4yff5"&&(V.innerHTML=De),ue=i(c),v=a(c,"DIV",{class:!0});var ne=D(v);p(P.$$.fragment,ne),le=i(ne),U=a(ne,"P",{"data-svelte-h":!0}),H(U)!=="svelte-1rkfgpx"&&(U.textContent=He),ne.forEach(t),pe=i(c),$=a(c,"DIV",{class:!0});var re=D($);p(k.$$.fragment,re),me=i(re),A=a(re,"P",{"data-svelte-h":!0}),H(A)!=="svelte-1k141rk"&&(A.textContent=Te),re.forEach(t),fe=i(c),x=a(c,"DIV",{class:!0});var ie=D(x);p(E.$$.fragment,ie),he=i(ie),z=a(ie,"P",{"data-svelte-h":!0}),H(z)!=="svelte-1vzm9q"&&(z.textContent=ye),ie.forEach(t),ge=i(c),S=a(c,"DIV",{class:!0});var oe=D(S);p(L.$$.fragment,oe),_e=i(oe),F=a(oe,"P",{"data-svelte-h":!0}),H(F)!=="svelte-hi84tp"&&(F.textContent=we),oe.forEach(t),c.forEach(t),Y=i(e),p(I.$$.fragment,e),Z=i(e),b=a(e,"DIV",{class:!0});var de=D(b);p(M.$$.fragment,de),be=i(de),j=a(de,"P",{"data-svelte-h":!0}),H(j)!=="svelte-6ojmkw"&&(j.innerHTML=Ce),de.forEach(t),ee=i(e),p(q.$$.fragment,e),te=i(e),G=a(e,"P",{}),D(G).forEach(t),this.h()},h(){T(_,"name","hf:doc:metadata"),T(_,"content",Ne),T(v,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),T($,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),T(x,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),T(S,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),T(o,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),T(b,"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,n){s(document.head,_),u(e,R,n),u(e,B,n),u(e,W,n),m(y,e,n),u(e,J,n),u(e,w,n),u(e,Q,n),m(C,e,n),u(e,X,n),u(e,o,n),m(O,o,null),s(o,ae),s(o,N),s(o,ce),s(o,V),s(o,ue),s(o,v),m(P,v,null),s(v,le),s(v,U),s(o,pe),s(o,$),m(k,$,null),s($,me),s($,A),s(o,fe),s(o,x),m(E,x,null),s(x,he),s(x,z),s(o,ge),s(o,S),m(L,S,null),s(S,_e),s(S,F),u(e,Y,n),m(I,e,n),u(e,Z,n),u(e,b,n),m(M,b,null),s(b,be),s(b,j),u(e,ee,n),m(q,e,n),u(e,te,n),u(e,G,n),se=!0},p:Pe,i(e){se||(f(y.$$.fragment,e),f(C.$$.fragment,e),f(O.$$.fragment,e),f(P.$$.fragment,e),f(k.$$.fragment,e),f(E.$$.fragment,e),f(L.$$.fragment,e),f(I.$$.fragment,e),f(M.$$.fragment,e),f(q.$$.fragment,e),se=!0)},o(e){h(y.$$.fragment,e),h(C.$$.fragment,e),h(O.$$.fragment,e),h(P.$$.fragment,e),h(k.$$.fragment,e),h(E.$$.fragment,e),h(L.$$.fragment,e),h(I.$$.fragment,e),h(M.$$.fragment,e),h(q.$$.fragment,e),se=!1},d(e){e&&(t(R),t(B),t(W),t(J),t(w),t(Q),t(X),t(o),t(Y),t(Z),t(b),t(ee),t(te),t(G)),t(_),g(y,e),g(C,e),g(O),g(P),g(k),g(E),g(L),g(I,e),g(M),g(q,e)}}}const Ne='{"title":"HeunDiscreteScheduler","local":"heundiscretescheduler","sections":[{"title":"HeunDiscreteScheduler","local":"diffusers.HeunDiscreteScheduler","sections":[],"depth":2},{"title":"SchedulerOutput","local":"diffusers.schedulers.scheduling_utils.SchedulerOutput","sections":[],"depth":2}],"depth":1}';function Ve($e){return ke(()=>{new URLSearchParams(window.location.search).get("fw")}),[]}class je extends Ee{constructor(_){super(),Le(this,_,Ve,qe,Oe,{})}}export{je as component};