import{S as $i,i as Ei,s as Di,e as n,k as l,w as S,t as p,M as Pi,c as o,d as t,m as f,a,x as q,h as u,b as r,G as i,g as d,y as N,L as xi,q as O,o as U,B as H,v as Mi}from"../../../chunks/vendor-hf-doc-builder.js";import{D as yi}from"../../../chunks/Docstring-hf-doc-builder.js";import{I as se}from"../../../chunks/IconCopyLink-hf-doc-builder.js";function Li(Bt){let m,Le,v,D,le,B,tt,fe,it,ke,g,P,de,C,nt,pe,ot,Ae,x,at,z,rt,st,Te,K,lt,Ie,X,ue,ft,Se,M,dt,G,pt,ut,qe,_,L,ce,R,ct,he,ht,Ne,h,Oe,mt,Ue,vt,He,Be,w,k,me,V,gt,ve,_t,Ce,A,ge,b,_e,wt,bt,we,yt,$t,Z,Et,Dt,be,y,ye,Q,Pt,xt,$e,Ee,Mt,Lt,ee,kt,ze,$,T,De,j,At,Pe,Tt,Ge,E,I,xe,W,It,Me,St,Re,c,J,qt,Y,Nt,te,Ot,Ut,Ht,ie,F,Ve;return B=new se({}),C=new se({}),R=new se({}),V=new se({}),j=new se({}),W=new se({}),J=new yi({props:{name:"class diffusers.LDMPipeline",anchor:"diffusers.LDMPipeline",parameters:[{name:"vqvae",val:": VQModel"},{name:"unet",val:": UNet2DModel"},{name:"scheduler",val:": DDIMScheduler"}],parametersDescription:[{anchor:"diffusers.LDMPipeline.vqvae",description:`<strong>vqvae</strong> (<a href="/docs/diffusers/v0.18.2/en/api/models/vq#diffusers.VQModel">VQModel</a>) &#x2014;
Vector-quantized (VQ) Model to encode and decode images to and from latent representations.`,name:"vqvae"},{anchor:"diffusers.LDMPipeline.unet",description:'<strong>unet</strong> (<a href="/docs/diffusers/v0.18.2/en/api/models/unet2d#diffusers.UNet2DModel">UNet2DModel</a>) &#x2014; U-Net architecture to denoise the encoded image latents.',name:"unet"},{anchor:"diffusers.LDMPipeline.scheduler",description:`<strong>scheduler</strong> (<a href="/docs/diffusers/v0.18.2/en/api/schedulers/overview#diffusers.SchedulerMixin">SchedulerMixin</a>) &#x2014;
<a href="/docs/diffusers/v0.18.2/en/api/schedulers/ddim#diffusers.DDIMScheduler">DDIMScheduler</a> is to be used in combination with <code>unet</code> to denoise the encoded image latents.`,name:"scheduler"}],source:"https://github.com/huggingface/diffusers/blob/v0.18.2/src/diffusers/pipelines/latent_diffusion_uncond/pipeline_latent_diffusion_uncond.py#L26"}}),F=new yi({props:{name:"__call__",anchor:"diffusers.LDMPipeline.__call__",parameters:[{name:"batch_size",val:": int = 1"},{name:"generator",val:": typing.Union[torch._C.Generator, typing.List[torch._C.Generator], NoneType] = None"},{name:"eta",val:": float = 0.0"},{name:"num_inference_steps",val:": int = 50"},{name:"output_type",val:": typing.Optional[str] = 'pil'"},{name:"return_dict",val:": bool = True"},{name:"**kwargs",val:""}],parametersDescription:[{anchor:"diffusers.LDMPipeline.__call__.batch_size",description:`<strong>batch_size</strong> (<code>int</code>, <em>optional</em>, defaults to 1) &#x2014;
Number of images to generate.`,name:"batch_size"},{anchor:"diffusers.LDMPipeline.__call__.generator",description:`<strong>generator</strong> (<code>torch.Generator</code>, <em>optional</em>) &#x2014;
One or a list of <a href="https://pytorch.org/docs/stable/generated/torch.Generator.html" rel="nofollow">torch generator(s)</a>
to make generation deterministic.`,name:"generator"},{anchor:"diffusers.LDMPipeline.__call__.num_inference_steps",description:`<strong>num_inference_steps</strong> (<code>int</code>, <em>optional</em>, defaults to 50) &#x2014;
The number of denoising steps. More denoising steps usually lead to a higher quality image at the
expense of slower inference.`,name:"num_inference_steps"},{anchor:"diffusers.LDMPipeline.__call__.output_type",description:`<strong>output_type</strong> (<code>str</code>, <em>optional</em>, defaults to <code>&quot;pil&quot;</code>) &#x2014;
The output format of the generate image. Choose between
<a href="https://pillow.readthedocs.io/en/stable/" rel="nofollow">PIL</a>: <code>PIL.Image.Image</code> or <code>np.array</code>.`,name:"output_type"},{anchor:"diffusers.LDMPipeline.__call__.return_dict",description:`<strong>return_dict</strong> (<code>bool</code>, <em>optional</em>, defaults to <code>True</code>) &#x2014;
Whether or not to return a <a href="/docs/diffusers/v0.18.2/en/api/outputs#diffusers.ImagePipelineOutput">ImagePipelineOutput</a> instead of a plain tuple.`,name:"return_dict"}],source:"https://github.com/huggingface/diffusers/blob/v0.18.2/src/diffusers/pipelines/latent_diffusion_uncond/pipeline_latent_diffusion_uncond.py#L43",returnDescription:`
<p><code>~pipelines.utils.ImagePipelineOutput</code> if <code>return_dict</code> is
True, otherwise a \`tuple. When returning a tuple, the first element is a list with the generated images.</p>
`,returnType:`
<p><a
  href="/docs/diffusers/v0.18.2/en/api/outputs#diffusers.ImagePipelineOutput"
>ImagePipelineOutput</a> or <code>tuple</code></p>
`}}),{c(){m=n("meta"),Le=l(),v=n("h1"),D=n("a"),le=n("span"),S(B.$$.fragment),tt=l(),fe=n("span"),it=p("Unconditional Latent Diffusion"),ke=l(),g=n("h2"),P=n("a"),de=n("span"),S(C.$$.fragment),nt=l(),pe=n("span"),ot=p("Overview"),Ae=l(),x=n("p"),at=p("Unconditional Latent Diffusion was proposed in "),z=n("a"),rt=p("High-Resolution Image Synthesis with Latent Diffusion Models"),st=p(" by Robin Rombach, Andreas Blattmann, Dominik Lorenz, Patrick Esser, Bj\xF6rn Ommer."),Te=l(),K=n("p"),lt=p("The abstract of the paper is the following:"),Ie=l(),X=n("p"),ue=n("em"),ft=p("By decomposing the image formation process into a sequential application of denoising autoencoders, diffusion models (DMs) achieve state-of-the-art synthesis results on image data and beyond. Additionally, their formulation allows for a guiding mechanism to control the image generation process without retraining. However, since these models typically operate directly in pixel space, optimization of powerful DMs often consumes hundreds of GPU days and inference is expensive due to sequential evaluations. To enable DM training on limited computational resources while retaining their quality and flexibility, we apply them in the latent space of powerful pretrained autoencoders. In contrast to previous work, training diffusion models on such a representation allows for the first time to reach a near-optimal point between complexity reduction and detail preservation, greatly boosting visual fidelity. By introducing cross-attention layers into the model architecture, we turn diffusion models into powerful and flexible generators for general conditioning inputs such as text or bounding boxes and high-resolution synthesis becomes possible in a convolutional manner. Our latent diffusion models (LDMs) achieve a new state of the art for image inpainting and highly competitive performance on various tasks, including unconditional image generation, semantic scene synthesis, and super-resolution, while significantly reducing computational requirements compared to pixel-based DMs."),Se=l(),M=n("p"),dt=p("The original codebase can be found "),G=n("a"),pt=p("here"),ut=p("."),qe=l(),_=n("h2"),L=n("a"),ce=n("span"),S(R.$$.fragment),ct=l(),he=n("span"),ht=p("Tips:"),Ne=l(),h=n("ul"),Oe=n("li"),mt=l(),Ue=n("li"),vt=l(),He=n("li"),Be=l(),w=n("h2"),k=n("a"),me=n("span"),S(V.$$.fragment),gt=l(),ve=n("span"),_t=p("Available Pipelines:"),Ce=l(),A=n("table"),ge=n("thead"),b=n("tr"),_e=n("th"),wt=p("Pipeline"),bt=l(),we=n("th"),yt=p("Tasks"),$t=l(),Z=n("th"),Et=p("Colab"),Dt=l(),be=n("tbody"),y=n("tr"),ye=n("td"),Q=n("a"),Pt=p("pipeline_latent_diffusion_uncond.py"),xt=l(),$e=n("td"),Ee=n("em"),Mt=p("Unconditional Image Generation"),Lt=l(),ee=n("td"),kt=p("-"),ze=l(),$=n("h2"),T=n("a"),De=n("span"),S(j.$$.fragment),At=l(),Pe=n("span"),Tt=p("Examples:"),Ge=l(),E=n("h2"),I=n("a"),xe=n("span"),S(W.$$.fragment),It=l(),Me=n("span"),St=p("LDMPipeline"),Re=l(),c=n("div"),S(J.$$.fragment),qt=l(),Y=n("p"),Nt=p("This model inherits from "),te=n("a"),Ot=p("DiffusionPipeline"),Ut=p(`. Check the superclass documentation for the generic methods the
library implements for all the pipelines (such as downloading or saving, running on a particular device, etc.)`),Ht=l(),ie=n("div"),S(F.$$.fragment),this.h()},l(e){const s=Pi('[data-svelte="svelte-1phssyn"]',document.head);m=o(s,"META",{name:!0,content:!0}),s.forEach(t),Le=f(e),v=o(e,"H1",{class:!0});var Qe=a(v);D=o(Qe,"A",{id:!0,class:!0,href:!0});var Ct=a(D);le=o(Ct,"SPAN",{});var zt=a(le);q(B.$$.fragment,zt),zt.forEach(t),Ct.forEach(t),tt=f(Qe),fe=o(Qe,"SPAN",{});var Gt=a(fe);it=u(Gt,"Unconditional Latent Diffusion"),Gt.forEach(t),Qe.forEach(t),ke=f(e),g=o(e,"H2",{class:!0});var je=a(g);P=o(je,"A",{id:!0,class:!0,href:!0});var Rt=a(P);de=o(Rt,"SPAN",{});var Vt=a(de);q(C.$$.fragment,Vt),Vt.forEach(t),Rt.forEach(t),nt=f(je),pe=o(je,"SPAN",{});var Qt=a(pe);ot=u(Qt,"Overview"),Qt.forEach(t),je.forEach(t),Ae=f(e),x=o(e,"P",{});var We=a(x);at=u(We,"Unconditional Latent Diffusion was proposed in "),z=o(We,"A",{href:!0,rel:!0});var jt=a(z);rt=u(jt,"High-Resolution Image Synthesis with Latent Diffusion Models"),jt.forEach(t),st=u(We," by Robin Rombach, Andreas Blattmann, Dominik Lorenz, Patrick Esser, Bj\xF6rn Ommer."),We.forEach(t),Te=f(e),K=o(e,"P",{});var Wt=a(K);lt=u(Wt,"The abstract of the paper is the following:"),Wt.forEach(t),Ie=f(e),X=o(e,"P",{});var Jt=a(X);ue=o(Jt,"EM",{});var Yt=a(ue);ft=u(Yt,"By decomposing the image formation process into a sequential application of denoising autoencoders, diffusion models (DMs) achieve state-of-the-art synthesis results on image data and beyond. Additionally, their formulation allows for a guiding mechanism to control the image generation process without retraining. However, since these models typically operate directly in pixel space, optimization of powerful DMs often consumes hundreds of GPU days and inference is expensive due to sequential evaluations. To enable DM training on limited computational resources while retaining their quality and flexibility, we apply them in the latent space of powerful pretrained autoencoders. In contrast to previous work, training diffusion models on such a representation allows for the first time to reach a near-optimal point between complexity reduction and detail preservation, greatly boosting visual fidelity. By introducing cross-attention layers into the model architecture, we turn diffusion models into powerful and flexible generators for general conditioning inputs such as text or bounding boxes and high-resolution synthesis becomes possible in a convolutional manner. Our latent diffusion models (LDMs) achieve a new state of the art for image inpainting and highly competitive performance on various tasks, including unconditional image generation, semantic scene synthesis, and super-resolution, while significantly reducing computational requirements compared to pixel-based DMs."),Yt.forEach(t),Jt.forEach(t),Se=f(e),M=o(e,"P",{});var Je=a(M);dt=u(Je,"The original codebase can be found "),G=o(Je,"A",{href:!0,rel:!0});var Ft=a(G);pt=u(Ft,"here"),Ft.forEach(t),ut=u(Je,"."),Je.forEach(t),qe=f(e),_=o(e,"H2",{class:!0});var Ye=a(_);L=o(Ye,"A",{id:!0,class:!0,href:!0});var Kt=a(L);ce=o(Kt,"SPAN",{});var Xt=a(ce);q(R.$$.fragment,Xt),Xt.forEach(t),Kt.forEach(t),ct=f(Ye),he=o(Ye,"SPAN",{});var Zt=a(he);ht=u(Zt,"Tips:"),Zt.forEach(t),Ye.forEach(t),Ne=f(e),h=o(e,"UL",{});var ne=a(h);Oe=o(ne,"LI",{}),a(Oe).forEach(t),mt=f(ne),Ue=o(ne,"LI",{}),a(Ue).forEach(t),vt=f(ne),He=o(ne,"LI",{}),a(He).forEach(t),ne.forEach(t),Be=f(e),w=o(e,"H2",{class:!0});var Fe=a(w);k=o(Fe,"A",{id:!0,class:!0,href:!0});var ei=a(k);me=o(ei,"SPAN",{});var ti=a(me);q(V.$$.fragment,ti),ti.forEach(t),ei.forEach(t),gt=f(Fe),ve=o(Fe,"SPAN",{});var ii=a(ve);_t=u(ii,"Available Pipelines:"),ii.forEach(t),Fe.forEach(t),Ce=f(e),A=o(e,"TABLE",{});var Ke=a(A);ge=o(Ke,"THEAD",{});var ni=a(ge);b=o(ni,"TR",{});var oe=a(b);_e=o(oe,"TH",{});var oi=a(_e);wt=u(oi,"Pipeline"),oi.forEach(t),bt=f(oe),we=o(oe,"TH",{});var ai=a(we);yt=u(ai,"Tasks"),ai.forEach(t),$t=f(oe),Z=o(oe,"TH",{align:!0});var ri=a(Z);Et=u(ri,"Colab"),ri.forEach(t),oe.forEach(t),ni.forEach(t),Dt=f(Ke),be=o(Ke,"TBODY",{});var si=a(be);y=o(si,"TR",{});var ae=a(y);ye=o(ae,"TD",{});var li=a(ye);Q=o(li,"A",{href:!0,rel:!0});var fi=a(Q);Pt=u(fi,"pipeline_latent_diffusion_uncond.py"),fi.forEach(t),li.forEach(t),xt=f(ae),$e=o(ae,"TD",{});var di=a($e);Ee=o(di,"EM",{});var pi=a(Ee);Mt=u(pi,"Unconditional Image Generation"),pi.forEach(t),di.forEach(t),Lt=f(ae),ee=o(ae,"TD",{align:!0});var ui=a(ee);kt=u(ui,"-"),ui.forEach(t),ae.forEach(t),si.forEach(t),Ke.forEach(t),ze=f(e),$=o(e,"H2",{class:!0});var Xe=a($);T=o(Xe,"A",{id:!0,class:!0,href:!0});var ci=a(T);De=o(ci,"SPAN",{});var hi=a(De);q(j.$$.fragment,hi),hi.forEach(t),ci.forEach(t),At=f(Xe),Pe=o(Xe,"SPAN",{});var mi=a(Pe);Tt=u(mi,"Examples:"),mi.forEach(t),Xe.forEach(t),Ge=f(e),E=o(e,"H2",{class:!0});var Ze=a(E);I=o(Ze,"A",{id:!0,class:!0,href:!0});var vi=a(I);xe=o(vi,"SPAN",{});var gi=a(xe);q(W.$$.fragment,gi),gi.forEach(t),vi.forEach(t),It=f(Ze),Me=o(Ze,"SPAN",{});var _i=a(Me);St=u(_i,"LDMPipeline"),_i.forEach(t),Ze.forEach(t),Re=f(e),c=o(e,"DIV",{class:!0});var re=a(c);q(J.$$.fragment,re),qt=f(re),Y=o(re,"P",{});var et=a(Y);Nt=u(et,"This model inherits from "),te=o(et,"A",{href:!0});var wi=a(te);Ot=u(wi,"DiffusionPipeline"),wi.forEach(t),Ut=u(et,`. Check the superclass documentation for the generic methods the
library implements for all the pipelines (such as downloading or saving, running on a particular device, etc.)`),et.forEach(t),Ht=f(re),ie=o(re,"DIV",{class:!0});var bi=a(ie);q(F.$$.fragment,bi),bi.forEach(t),re.forEach(t),this.h()},h(){r(m,"name","hf:doc:metadata"),r(m,"content",JSON.stringify(ki)),r(D,"id","unconditional-latent-diffusion"),r(D,"class","header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full"),r(D,"href","#unconditional-latent-diffusion"),r(v,"class","relative group"),r(P,"id","overview"),r(P,"class","header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full"),r(P,"href","#overview"),r(g,"class","relative group"),r(z,"href","https://arxiv.org/abs/2112.10752"),r(z,"rel","nofollow"),r(G,"href","https://github.com/CompVis/latent-diffusion"),r(G,"rel","nofollow"),r(L,"id","tips"),r(L,"class","header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full"),r(L,"href","#tips"),r(_,"class","relative group"),r(k,"id","available-pipelines"),r(k,"class","header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full"),r(k,"href","#available-pipelines"),r(w,"class","relative group"),r(Z,"align","center"),r(Q,"href","https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/latent_diffusion_uncond/pipeline_latent_diffusion_uncond.py"),r(Q,"rel","nofollow"),r(ee,"align","center"),r(T,"id","examples"),r(T,"class","header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full"),r(T,"href","#examples"),r($,"class","relative group"),r(I,"id","diffusers.LDMPipeline"),r(I,"class","header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full"),r(I,"href","#diffusers.LDMPipeline"),r(E,"class","relative group"),r(te,"href","/docs/diffusers/v0.18.2/en/api/diffusion_pipeline#diffusers.DiffusionPipeline"),r(ie,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),r(c,"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,s){i(document.head,m),d(e,Le,s),d(e,v,s),i(v,D),i(D,le),N(B,le,null),i(v,tt),i(v,fe),i(fe,it),d(e,ke,s),d(e,g,s),i(g,P),i(P,de),N(C,de,null),i(g,nt),i(g,pe),i(pe,ot),d(e,Ae,s),d(e,x,s),i(x,at),i(x,z),i(z,rt),i(x,st),d(e,Te,s),d(e,K,s),i(K,lt),d(e,Ie,s),d(e,X,s),i(X,ue),i(ue,ft),d(e,Se,s),d(e,M,s),i(M,dt),i(M,G),i(G,pt),i(M,ut),d(e,qe,s),d(e,_,s),i(_,L),i(L,ce),N(R,ce,null),i(_,ct),i(_,he),i(he,ht),d(e,Ne,s),d(e,h,s),i(h,Oe),i(h,mt),i(h,Ue),i(h,vt),i(h,He),d(e,Be,s),d(e,w,s),i(w,k),i(k,me),N(V,me,null),i(w,gt),i(w,ve),i(ve,_t),d(e,Ce,s),d(e,A,s),i(A,ge),i(ge,b),i(b,_e),i(_e,wt),i(b,bt),i(b,we),i(we,yt),i(b,$t),i(b,Z),i(Z,Et),i(A,Dt),i(A,be),i(be,y),i(y,ye),i(ye,Q),i(Q,Pt),i(y,xt),i(y,$e),i($e,Ee),i(Ee,Mt),i(y,Lt),i(y,ee),i(ee,kt),d(e,ze,s),d(e,$,s),i($,T),i(T,De),N(j,De,null),i($,At),i($,Pe),i(Pe,Tt),d(e,Ge,s),d(e,E,s),i(E,I),i(I,xe),N(W,xe,null),i(E,It),i(E,Me),i(Me,St),d(e,Re,s),d(e,c,s),N(J,c,null),i(c,qt),i(c,Y),i(Y,Nt),i(Y,te),i(te,Ot),i(Y,Ut),i(c,Ht),i(c,ie),N(F,ie,null),Ve=!0},p:xi,i(e){Ve||(O(B.$$.fragment,e),O(C.$$.fragment,e),O(R.$$.fragment,e),O(V.$$.fragment,e),O(j.$$.fragment,e),O(W.$$.fragment,e),O(J.$$.fragment,e),O(F.$$.fragment,e),Ve=!0)},o(e){U(B.$$.fragment,e),U(C.$$.fragment,e),U(R.$$.fragment,e),U(V.$$.fragment,e),U(j.$$.fragment,e),U(W.$$.fragment,e),U(J.$$.fragment,e),U(F.$$.fragment,e),Ve=!1},d(e){t(m),e&&t(Le),e&&t(v),H(B),e&&t(ke),e&&t(g),H(C),e&&t(Ae),e&&t(x),e&&t(Te),e&&t(K),e&&t(Ie),e&&t(X),e&&t(Se),e&&t(M),e&&t(qe),e&&t(_),H(R),e&&t(Ne),e&&t(h),e&&t(Be),e&&t(w),H(V),e&&t(Ce),e&&t(A),e&&t(ze),e&&t($),H(j),e&&t(Ge),e&&t(E),H(W),e&&t(Re),e&&t(c),H(J),H(F)}}}const ki={local:"unconditional-latent-diffusion",sections:[{local:"overview",title:"Overview"},{local:"tips",title:"Tips:"},{local:"available-pipelines",title:"Available Pipelines:"},{local:"examples",title:"Examples:"},{local:"diffusers.LDMPipeline",title:"LDMPipeline"}],title:"Unconditional Latent Diffusion"};function Ai(Bt){return Mi(()=>{new URLSearchParams(window.location.search).get("fw")}),[]}class qi extends $i{constructor(m){super();Ei(this,m,Ai,Li,Di,{})}}export{qi as default,ki as metadata};
