Buckets:
| import{s as Ne,o as Qe,n as Ee}from"../chunks/scheduler.8c3d61f6.js";import{S as We,i as Re,g as l,s as a,r as m,A as qe,h as p,f as n,c as s,j as O,u,x as w,k as K,y as T,a as o,v as f,d as g,t as _,w as h}from"../chunks/index.da70eac4.js";import{T as ze}from"../chunks/Tip.1d9b8c37.js";import{D as xe}from"../chunks/Docstring.567bc132.js";import{C as ye}from"../chunks/CodeBlock.a9c4becf.js";import{E as Ye}from"../chunks/ExampleCodeBlock.15b54358.js";import{H as be,E as Ve}from"../chunks/index.5d4ab994.js";function He(V){let r,U='AuraFlow can be quite expensive to run on consumer hardware devices. However, you can perform a suite of optimizations to run it faster and in a more memory-friendly manner. Check out <a href="https://huggingface.co/blog/sd3#memory-optimizations-for-sd3" rel="nofollow">this section</a> for more details.';return{c(){r=l("p"),r.innerHTML=U},l(d){r=p(d,"P",{"data-svelte-h":!0}),w(r)!=="svelte-q1wg22"&&(r.innerHTML=U)},m(d,c){o(d,r,c)},p:Ee,d(d){d&&n(r)}}}function Le(V){let r,U="Examples:",d,c,b;return c=new ye({props:{code:"aW1wb3J0JTIwdG9yY2glMEFmcm9tJTIwZGlmZnVzZXJzJTIwaW1wb3J0JTIwQXVyYUZsb3dQaXBlbGluZSUwQSUwQXBpcGUlMjAlM0QlMjBBdXJhRmxvd1BpcGVsaW5lLmZyb21fcHJldHJhaW5lZCglMjJmYWwlMkZBdXJhRmxvdyUyMiUyQyUyMHRvcmNoX2R0eXBlJTNEdG9yY2guZmxvYXQxNiklMEFwaXBlJTIwJTNEJTIwcGlwZS50byglMjJjdWRhJTIyKSUwQXByb21wdCUyMCUzRCUyMCUyMkElMjBjYXQlMjBob2xkaW5nJTIwYSUyMHNpZ24lMjB0aGF0JTIwc2F5cyUyMGhlbGxvJTIwd29ybGQlMjIlMEFpbWFnZSUyMCUzRCUyMHBpcGUocHJvbXB0KS5pbWFnZXMlNUIwJTVEJTBBaW1hZ2Uuc2F2ZSglMjJhdXJhX2Zsb3cucG5nJTIyKQ==",highlighted:`<span class="hljs-meta">>>> </span><span class="hljs-keyword">import</span> torch | |
| <span class="hljs-meta">>>> </span><span class="hljs-keyword">from</span> diffusers <span class="hljs-keyword">import</span> AuraFlowPipeline | |
| <span class="hljs-meta">>>> </span>pipe = AuraFlowPipeline.from_pretrained(<span class="hljs-string">"fal/AuraFlow"</span>, torch_dtype=torch.float16) | |
| <span class="hljs-meta">>>> </span>pipe = pipe.to(<span class="hljs-string">"cuda"</span>) | |
| <span class="hljs-meta">>>> </span>prompt = <span class="hljs-string">"A cat holding a sign that says hello world"</span> | |
| <span class="hljs-meta">>>> </span>image = pipe(prompt).images[<span class="hljs-number">0</span>] | |
| <span class="hljs-meta">>>> </span>image.save(<span class="hljs-string">"aura_flow.png"</span>)`,wrap:!1}}),{c(){r=l("p"),r.textContent=U,d=a(),m(c.$$.fragment)},l(i){r=p(i,"P",{"data-svelte-h":!0}),w(r)!=="svelte-kvfsh7"&&(r.textContent=U),d=s(i),u(c.$$.fragment,i)},m(i,M){o(i,r,M),o(i,d,M),f(c,i,M),b=!0},p:Ee,i(i){b||(g(c.$$.fragment,i),b=!0)},o(i){_(c.$$.fragment,i),b=!1},d(i){i&&(n(r),n(d)),h(c,i)}}}function Se(V){let r,U,d,c,b,i,M,ke='AuraFlow is inspired by <a href="../pipelines/stable_diffusion/stable_diffusion_3">Stable Diffusion 3</a> and is by far the largest text-to-image generation model that comes with an Apache 2.0 license. This model achieves state-of-the-art results on the <a href="https://github.com/djghosh13/geneval" rel="nofollow">GenEval</a> benchmark.',ee,$,Ze='It was developed by the Fal team and more details about it can be found in <a href="https://blog.fal.ai/auraflow/" rel="nofollow">this blog post</a>.',te,x,ne,A,oe,C,$e="Quantization helps reduce the memory requirements of very large models by storing model weights in a lower precision data type. However, quantization may have varying impact on video quality depending on the video model.",ae,I,Ae='Refer to the <a href="../../quantization/overview">Quantization</a> overview to learn more about supported quantization backends and selecting a quantization backend that supports your use case. The example below demonstrates how to load a quantized <a href="/docs/diffusers/pr_11335/en/api/pipelines/aura_flow#diffusers.AuraFlowPipeline">AuraFlowPipeline</a> for inference with bitsandbytes.',se,j,re,B,Ce='Loading <a href="https://huggingface.co/docs/diffusers/quantization/gguf" rel="nofollow">GGUF checkpoints</a> are also supported:',ie,G,le,P,pe,X,Ie='AuraFlow can be compiled with <code>torch.compile()</code> to speed up inference latency even for different resolutions. First, install PyTorch nightly following the instructions from <a href="https://pytorch.org/" rel="nofollow">here</a>. The snippet below shows the changes needed to enable this:',de,E,ce,N,je="This enables from 100% (on low resolutions) to a 30% (on 1536x1536 resolution) speed improvements.",me,Q,Be='Thanks to <a href="https://github.com/huggingface/diffusers/pull/11297/" rel="nofollow">AstraliteHeart</a> who helped us rewrite the <a href="/docs/diffusers/pr_11335/en/api/models/aura_flow_transformer2d#diffusers.AuraFlowTransformer2DModel">AuraFlowTransformer2DModel</a> class so that the above works for different resolutions (<a href="https://github.com/huggingface/diffusers/pull/11297/" rel="nofollow">PR</a>).',ue,W,fe,J,R,Te,y,q,Me,H,Ge="Function invoked when calling the pipeline for generation.",Je,k,ve,L,Pe=`Returns: <a href="/docs/diffusers/pr_11335/en/api/pipelines/stable_unclip#diffusers.ImagePipelineOutput">ImagePipelineOutput</a> or <code>tuple</code>: | |
| If <code>return_dict</code> is <code>True</code>, <a href="/docs/diffusers/pr_11335/en/api/pipelines/stable_unclip#diffusers.ImagePipelineOutput">ImagePipelineOutput</a> is returned, otherwise a <code>tuple</code> is returned | |
| where the first element is a list with the generated images.`,Ue,Z,z,Fe,S,Xe="Encodes the prompt into text encoder hidden states.",ge,Y,_e,D,he;return b=new be({props:{title:"AuraFlow",local:"auraflow",headingTag:"h1"}}),x=new ze({props:{$$slots:{default:[He]},$$scope:{ctx:V}}}),A=new be({props:{title:"Quantization",local:"quantization",headingTag:"h2"}}),j=new ye({props:{code:"aW1wb3J0JTIwdG9yY2glMEFmcm9tJTIwZGlmZnVzZXJzJTIwaW1wb3J0JTIwQml0c0FuZEJ5dGVzQ29uZmlnJTIwYXMlMjBEaWZmdXNlcnNCaXRzQW5kQnl0ZXNDb25maWclMkMlMjBBdXJhRmxvd1RyYW5zZm9ybWVyMkRNb2RlbCUyQyUyMEF1cmFGbG93UGlwZWxpbmUlMEFmcm9tJTIwdHJhbnNmb3JtZXJzJTIwaW1wb3J0JTIwQml0c0FuZEJ5dGVzQ29uZmlnJTIwYXMlMjBCaXRzQW5kQnl0ZXNDb25maWclMkMlMjBUNUVuY29kZXJNb2RlbCUwQSUwQXF1YW50X2NvbmZpZyUyMCUzRCUyMEJpdHNBbmRCeXRlc0NvbmZpZyhsb2FkX2luXzhiaXQlM0RUcnVlKSUwQXRleHRfZW5jb2Rlcl84Yml0JTIwJTNEJTIwVDVFbmNvZGVyTW9kZWwuZnJvbV9wcmV0cmFpbmVkKCUwQSUyMCUyMCUyMCUyMCUyMmZhbCUyRkF1cmFGbG93JTIyJTJDJTBBJTIwJTIwJTIwJTIwc3ViZm9sZGVyJTNEJTIydGV4dF9lbmNvZGVyJTIyJTJDJTBBJTIwJTIwJTIwJTIwcXVhbnRpemF0aW9uX2NvbmZpZyUzRHF1YW50X2NvbmZpZyUyQyUwQSUyMCUyMCUyMCUyMHRvcmNoX2R0eXBlJTNEdG9yY2guZmxvYXQxNiUyQyUwQSklMEElMEFxdWFudF9jb25maWclMjAlM0QlMjBEaWZmdXNlcnNCaXRzQW5kQnl0ZXNDb25maWcobG9hZF9pbl84Yml0JTNEVHJ1ZSklMEF0cmFuc2Zvcm1lcl84Yml0JTIwJTNEJTIwQXVyYUZsb3dUcmFuc2Zvcm1lcjJETW9kZWwuZnJvbV9wcmV0cmFpbmVkKCUwQSUyMCUyMCUyMCUyMCUyMmZhbCUyRkF1cmFGbG93JTIyJTJDJTBBJTIwJTIwJTIwJTIwc3ViZm9sZGVyJTNEJTIydHJhbnNmb3JtZXIlMjIlMkMlMEElMjAlMjAlMjAlMjBxdWFudGl6YXRpb25fY29uZmlnJTNEcXVhbnRfY29uZmlnJTJDJTBBJTIwJTIwJTIwJTIwdG9yY2hfZHR5cGUlM0R0b3JjaC5mbG9hdDE2JTJDJTBBKSUwQSUwQXBpcGVsaW5lJTIwJTNEJTIwQXVyYUZsb3dQaXBlbGluZS5mcm9tX3ByZXRyYWluZWQoJTBBJTIwJTIwJTIwJTIwJTIyZmFsJTJGQXVyYUZsb3clMjIlMkMlMEElMjAlMjAlMjAlMjB0ZXh0X2VuY29kZXIlM0R0ZXh0X2VuY29kZXJfOGJpdCUyQyUwQSUyMCUyMCUyMCUyMHRyYW5zZm9ybWVyJTNEdHJhbnNmb3JtZXJfOGJpdCUyQyUwQSUyMCUyMCUyMCUyMHRvcmNoX2R0eXBlJTNEdG9yY2guZmxvYXQxNiUyQyUwQSUyMCUyMCUyMCUyMGRldmljZV9tYXAlM0QlMjJiYWxhbmNlZCUyMiUyQyUwQSklMEElMEFwcm9tcHQlMjAlM0QlMjAlMjJhJTIwdGlueSUyMGFzdHJvbmF1dCUyMGhhdGNoaW5nJTIwZnJvbSUyMGFuJTIwZWdnJTIwb24lMjB0aGUlMjBtb29uJTIyJTBBaW1hZ2UlMjAlM0QlMjBwaXBlbGluZShwcm9tcHQpLmltYWdlcyU1QjAlNUQlMEFpbWFnZS5zYXZlKCUyMmF1cmFmbG93LnBuZyUyMik=",highlighted:`<span class="hljs-keyword">import</span> torch | |
| <span class="hljs-keyword">from</span> diffusers <span class="hljs-keyword">import</span> BitsAndBytesConfig <span class="hljs-keyword">as</span> DiffusersBitsAndBytesConfig, AuraFlowTransformer2DModel, AuraFlowPipeline | |
| <span class="hljs-keyword">from</span> transformers <span class="hljs-keyword">import</span> BitsAndBytesConfig <span class="hljs-keyword">as</span> BitsAndBytesConfig, T5EncoderModel | |
| quant_config = BitsAndBytesConfig(load_in_8bit=<span class="hljs-literal">True</span>) | |
| text_encoder_8bit = T5EncoderModel.from_pretrained( | |
| <span class="hljs-string">"fal/AuraFlow"</span>, | |
| subfolder=<span class="hljs-string">"text_encoder"</span>, | |
| quantization_config=quant_config, | |
| torch_dtype=torch.float16, | |
| ) | |
| quant_config = DiffusersBitsAndBytesConfig(load_in_8bit=<span class="hljs-literal">True</span>) | |
| transformer_8bit = AuraFlowTransformer2DModel.from_pretrained( | |
| <span class="hljs-string">"fal/AuraFlow"</span>, | |
| subfolder=<span class="hljs-string">"transformer"</span>, | |
| quantization_config=quant_config, | |
| torch_dtype=torch.float16, | |
| ) | |
| pipeline = AuraFlowPipeline.from_pretrained( | |
| <span class="hljs-string">"fal/AuraFlow"</span>, | |
| text_encoder=text_encoder_8bit, | |
| transformer=transformer_8bit, | |
| torch_dtype=torch.float16, | |
| device_map=<span class="hljs-string">"balanced"</span>, | |
| ) | |
| prompt = <span class="hljs-string">"a tiny astronaut hatching from an egg on the moon"</span> | |
| image = pipeline(prompt).images[<span class="hljs-number">0</span>] | |
| image.save(<span class="hljs-string">"auraflow.png"</span>)`,wrap:!1}}),G=new ye({props:{code:"aW1wb3J0JTIwdG9yY2glMEFmcm9tJTIwZGlmZnVzZXJzJTIwaW1wb3J0JTIwKCUwQSUyMCUyMCUyMCUyMEF1cmFGbG93UGlwZWxpbmUlMkMlMEElMjAlMjAlMjAlMjBHR1VGUXVhbnRpemF0aW9uQ29uZmlnJTJDJTBBJTIwJTIwJTIwJTIwQXVyYUZsb3dUcmFuc2Zvcm1lcjJETW9kZWwlMkMlMEEpJTBBJTBBdHJhbnNmb3JtZXIlMjAlM0QlMjBBdXJhRmxvd1RyYW5zZm9ybWVyMkRNb2RlbC5mcm9tX3NpbmdsZV9maWxlKCUwQSUyMCUyMCUyMCUyMCUyMmh0dHBzJTNBJTJGJTJGaHVnZ2luZ2ZhY2UuY28lMkZjaXR5OTYlMkZBdXJhRmxvdy12MC4zLWdndWYlMkZibG9iJTJGbWFpbiUyRmF1cmFfZmxvd18wLjMtUTJfSy5nZ3VmJTIyJTJDJTBBJTIwJTIwJTIwJTIwcXVhbnRpemF0aW9uX2NvbmZpZyUzREdHVUZRdWFudGl6YXRpb25Db25maWcoY29tcHV0ZV9kdHlwZSUzRHRvcmNoLmJmbG9hdDE2KSUyQyUwQSUyMCUyMCUyMCUyMHRvcmNoX2R0eXBlJTNEdG9yY2guYmZsb2F0MTYlMkMlMEEpJTBBJTBBcGlwZWxpbmUlMjAlM0QlMjBBdXJhRmxvd1BpcGVsaW5lLmZyb21fcHJldHJhaW5lZCglMEElMjAlMjAlMjAlMjAlMjJmYWwlMkZBdXJhRmxvdy12MC4zJTIyJTJDJTBBJTIwJTIwJTIwJTIwdHJhbnNmb3JtZXIlM0R0cmFuc2Zvcm1lciUyQyUwQSUyMCUyMCUyMCUyMHRvcmNoX2R0eXBlJTNEdG9yY2guYmZsb2F0MTYlMkMlMEEpJTBBJTBBcHJvbXB0JTIwJTNEJTIwJTIyYSUyMGN1dGUlMjBwb255JTIwaW4lMjBhJTIwZmllbGQlMjBvZiUyMGZsb3dlcnMlMjIlMEFpbWFnZSUyMCUzRCUyMHBpcGVsaW5lKHByb21wdCkuaW1hZ2VzJTVCMCU1RCUwQWltYWdlLnNhdmUoJTIyYXVyYWZsb3cucG5nJTIyKQ==",highlighted:`<span class="hljs-keyword">import</span> torch | |
| <span class="hljs-keyword">from</span> diffusers <span class="hljs-keyword">import</span> ( | |
| AuraFlowPipeline, | |
| GGUFQuantizationConfig, | |
| AuraFlowTransformer2DModel, | |
| ) | |
| transformer = AuraFlowTransformer2DModel.from_single_file( | |
| <span class="hljs-string">"https://huggingface.co/city96/AuraFlow-v0.3-gguf/blob/main/aura_flow_0.3-Q2_K.gguf"</span>, | |
| quantization_config=GGUFQuantizationConfig(compute_dtype=torch.bfloat16), | |
| torch_dtype=torch.bfloat16, | |
| ) | |
| pipeline = AuraFlowPipeline.from_pretrained( | |
| <span class="hljs-string">"fal/AuraFlow-v0.3"</span>, | |
| transformer=transformer, | |
| torch_dtype=torch.bfloat16, | |
| ) | |
| prompt = <span class="hljs-string">"a cute pony in a field of flowers"</span> | |
| image = pipeline(prompt).images[<span class="hljs-number">0</span>] | |
| image.save(<span class="hljs-string">"auraflow.png"</span>)`,wrap:!1}}),P=new be({props:{title:"Support for torch.compile()",local:"support-for-torchcompile",headingTag:"h2"}}),E=new ye({props:{code:"JTJCJTIwdG9yY2guZnguZXhwZXJpbWVudGFsLl9jb25maWcudXNlX2R1Y2tfc2hhcGUlMjAlM0QlMjBGYWxzZSUwQSUyQiUyMHBpcGVsaW5lLnRyYW5zZm9ybWVyJTIwJTNEJTIwdG9yY2guY29tcGlsZSglMEElMjAlMjAlMjAlMjBwaXBlbGluZS50cmFuc2Zvcm1lciUyQyUyMGZ1bGxncmFwaCUzRFRydWUlMkMlMjBkeW5hbWljJTNEVHJ1ZSUwQSk=",highlighted:`<span class="hljs-addition">+ torch.fx.experimental._config.use_duck_shape = False</span> | |
| <span class="hljs-addition">+ pipeline.transformer = torch.compile(</span> | |
| pipeline.transformer, fullgraph=True, dynamic=True | |
| )`,wrap:!1}}),W=new be({props:{title:"AuraFlowPipeline",local:"diffusers.AuraFlowPipeline",headingTag:"h2"}}),R=new xe({props:{name:"class diffusers.AuraFlowPipeline",anchor:"diffusers.AuraFlowPipeline",parameters:[{name:"tokenizer",val:": T5Tokenizer"},{name:"text_encoder",val:": UMT5EncoderModel"},{name:"vae",val:": AutoencoderKL"},{name:"transformer",val:": AuraFlowTransformer2DModel"},{name:"scheduler",val:": FlowMatchEulerDiscreteScheduler"}],parametersDescription:[{anchor:"diffusers.AuraFlowPipeline.tokenizer",description:`<strong>tokenizer</strong> (<code>T5TokenizerFast</code>) — | |
| Tokenizer of class | |
| <a href="https://huggingface.co/docs/transformers/model_doc/t5#transformers.T5Tokenizer" rel="nofollow">T5Tokenizer</a>.`,name:"tokenizer"},{anchor:"diffusers.AuraFlowPipeline.text_encoder",description:`<strong>text_encoder</strong> (<code>T5EncoderModel</code>) — | |
| Frozen text-encoder. AuraFlow uses | |
| <a href="https://huggingface.co/docs/transformers/model_doc/t5#transformers.T5EncoderModel" rel="nofollow">T5</a>, specifically the | |
| <a href="https://huggingface.co/EleutherAI/pile-t5-xl" rel="nofollow">EleutherAI/pile-t5-xl</a> variant.`,name:"text_encoder"},{anchor:"diffusers.AuraFlowPipeline.vae",description:`<strong>vae</strong> (<a href="/docs/diffusers/pr_11335/en/api/models/autoencoderkl#diffusers.AutoencoderKL">AutoencoderKL</a>) — | |
| Variational Auto-Encoder (VAE) Model to encode and decode images to and from latent representations.`,name:"vae"},{anchor:"diffusers.AuraFlowPipeline.transformer",description:`<strong>transformer</strong> (<a href="/docs/diffusers/pr_11335/en/api/models/aura_flow_transformer2d#diffusers.AuraFlowTransformer2DModel">AuraFlowTransformer2DModel</a>) — | |
| Conditional Transformer (MMDiT and DiT) architecture to denoise the encoded image latents.`,name:"transformer"},{anchor:"diffusers.AuraFlowPipeline.scheduler",description:`<strong>scheduler</strong> (<a href="/docs/diffusers/pr_11335/en/api/schedulers/flow_match_euler_discrete#diffusers.FlowMatchEulerDiscreteScheduler">FlowMatchEulerDiscreteScheduler</a>) — | |
| A scheduler to be used in combination with <code>transformer</code> to denoise the encoded image latents.`,name:"scheduler"}],source:"https://github.com/huggingface/diffusers/blob/vr_11335/src/diffusers/pipelines/aura_flow/pipeline_aura_flow.py#L123"}}),q=new xe({props:{name:"__call__",anchor:"diffusers.AuraFlowPipeline.__call__",parameters:[{name:"prompt",val:": typing.Union[str, typing.List[str]] = None"},{name:"negative_prompt",val:": typing.Union[str, typing.List[str]] = None"},{name:"num_inference_steps",val:": int = 50"},{name:"sigmas",val:": typing.List[float] = None"},{name:"guidance_scale",val:": float = 3.5"},{name:"num_images_per_prompt",val:": typing.Optional[int] = 1"},{name:"height",val:": typing.Optional[int] = 1024"},{name:"width",val:": typing.Optional[int] = 1024"},{name:"generator",val:": typing.Union[torch._C.Generator, typing.List[torch._C.Generator], NoneType] = None"},{name:"latents",val:": typing.Optional[torch.Tensor] = None"},{name:"prompt_embeds",val:": typing.Optional[torch.Tensor] = None"},{name:"prompt_attention_mask",val:": typing.Optional[torch.Tensor] = None"},{name:"negative_prompt_embeds",val:": typing.Optional[torch.Tensor] = None"},{name:"negative_prompt_attention_mask",val:": typing.Optional[torch.Tensor] = None"},{name:"max_sequence_length",val:": int = 256"},{name:"output_type",val:": typing.Optional[str] = 'pil'"},{name:"return_dict",val:": bool = True"},{name:"attention_kwargs",val:": typing.Optional[typing.Dict[str, typing.Any]] = None"},{name:"callback_on_step_end",val:": typing.Union[typing.Callable[[int, int, typing.Dict], NoneType], diffusers.callbacks.PipelineCallback, diffusers.callbacks.MultiPipelineCallbacks, NoneType] = None"},{name:"callback_on_step_end_tensor_inputs",val:": typing.List[str] = ['latents']"}],parametersDescription:[{anchor:"diffusers.AuraFlowPipeline.__call__.prompt",description:`<strong>prompt</strong> (<code>str</code> or <code>List[str]</code>, <em>optional</em>) — | |
| The prompt or prompts to guide the image generation. If not defined, one has to pass <code>prompt_embeds</code>. | |
| instead.`,name:"prompt"},{anchor:"diffusers.AuraFlowPipeline.__call__.negative_prompt",description:`<strong>negative_prompt</strong> (<code>str</code> or <code>List[str]</code>, <em>optional</em>) — | |
| The prompt or prompts not to guide the image generation. If not defined, one has to pass | |
| <code>negative_prompt_embeds</code> instead. Ignored when not using guidance (i.e., ignored if <code>guidance_scale</code> is | |
| less than <code>1</code>).`,name:"negative_prompt"},{anchor:"diffusers.AuraFlowPipeline.__call__.height",description:`<strong>height</strong> (<code>int</code>, <em>optional</em>, defaults to self.transformer.config.sample_size * self.vae_scale_factor) — | |
| The height in pixels of the generated image. This is set to 1024 by default for best results.`,name:"height"},{anchor:"diffusers.AuraFlowPipeline.__call__.width",description:`<strong>width</strong> (<code>int</code>, <em>optional</em>, defaults to self.transformer.config.sample_size * self.vae_scale_factor) — | |
| The width in pixels of the generated image. This is set to 1024 by default for best results.`,name:"width"},{anchor:"diffusers.AuraFlowPipeline.__call__.num_inference_steps",description:`<strong>num_inference_steps</strong> (<code>int</code>, <em>optional</em>, defaults to 50) — | |
| 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.AuraFlowPipeline.__call__.sigmas",description:`<strong>sigmas</strong> (<code>List[float]</code>, <em>optional</em>) — | |
| Custom sigmas used to override the timestep spacing strategy of the scheduler. If <code>sigmas</code> is passed, | |
| <code>num_inference_steps</code> and <code>timesteps</code> must be <code>None</code>.`,name:"sigmas"},{anchor:"diffusers.AuraFlowPipeline.__call__.guidance_scale",description:`<strong>guidance_scale</strong> (<code>float</code>, <em>optional</em>, defaults to 5.0) — | |
| Guidance scale as defined in <a href="https://arxiv.org/abs/2207.12598" rel="nofollow">Classifier-Free Diffusion Guidance</a>. | |
| <code>guidance_scale</code> is defined as <code>w</code> of equation 2. of <a href="https://arxiv.org/pdf/2205.11487.pdf" rel="nofollow">Imagen | |
| Paper</a>. Guidance scale is enabled by setting <code>guidance_scale > 1</code>. Higher guidance scale encourages to generate images that are closely linked to the text <code>prompt</code>, | |
| usually at the expense of lower image quality.`,name:"guidance_scale"},{anchor:"diffusers.AuraFlowPipeline.__call__.num_images_per_prompt",description:`<strong>num_images_per_prompt</strong> (<code>int</code>, <em>optional</em>, defaults to 1) — | |
| The number of images to generate per prompt.`,name:"num_images_per_prompt"},{anchor:"diffusers.AuraFlowPipeline.__call__.generator",description:`<strong>generator</strong> (<code>torch.Generator</code> or <code>List[torch.Generator]</code>, <em>optional</em>) — | |
| 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.AuraFlowPipeline.__call__.latents",description:`<strong>latents</strong> (<code>torch.FloatTensor</code>, <em>optional</em>) — | |
| Pre-generated noisy latents, sampled from a Gaussian distribution, to be used as inputs for image | |
| generation. Can be used to tweak the same generation with different prompts. If not provided, a latents | |
| tensor will ge generated by sampling using the supplied random <code>generator</code>.`,name:"latents"},{anchor:"diffusers.AuraFlowPipeline.__call__.prompt_embeds",description:`<strong>prompt_embeds</strong> (<code>torch.FloatTensor</code>, <em>optional</em>) — | |
| Pre-generated text embeddings. Can be used to easily tweak text inputs, <em>e.g.</em> prompt weighting. If not | |
| provided, text embeddings will be generated from <code>prompt</code> input argument.`,name:"prompt_embeds"},{anchor:"diffusers.AuraFlowPipeline.__call__.prompt_attention_mask",description:`<strong>prompt_attention_mask</strong> (<code>torch.Tensor</code>, <em>optional</em>) — | |
| Pre-generated attention mask for text embeddings.`,name:"prompt_attention_mask"},{anchor:"diffusers.AuraFlowPipeline.__call__.negative_prompt_embeds",description:`<strong>negative_prompt_embeds</strong> (<code>torch.FloatTensor</code>, <em>optional</em>) — | |
| Pre-generated negative text embeddings. Can be used to easily tweak text inputs, <em>e.g.</em> prompt | |
| weighting. If not provided, negative_prompt_embeds will be generated from <code>negative_prompt</code> input | |
| argument.`,name:"negative_prompt_embeds"},{anchor:"diffusers.AuraFlowPipeline.__call__.negative_prompt_attention_mask",description:`<strong>negative_prompt_attention_mask</strong> (<code>torch.Tensor</code>, <em>optional</em>) — | |
| Pre-generated attention mask for negative text embeddings.`,name:"negative_prompt_attention_mask"},{anchor:"diffusers.AuraFlowPipeline.__call__.output_type",description:`<strong>output_type</strong> (<code>str</code>, <em>optional</em>, defaults to <code>"pil"</code>) — | |
| 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.AuraFlowPipeline.__call__.return_dict",description:`<strong>return_dict</strong> (<code>bool</code>, <em>optional</em>, defaults to <code>True</code>) — | |
| Whether or not to return a <code>~pipelines.stable_diffusion_xl.StableDiffusionXLPipelineOutput</code> instead | |
| of a plain tuple.`,name:"return_dict"},{anchor:"diffusers.AuraFlowPipeline.__call__.attention_kwargs",description:`<strong>attention_kwargs</strong> (<code>dict</code>, <em>optional</em>) — | |
| A kwargs dictionary that if specified is passed along to the <code>AttentionProcessor</code> as defined under | |
| <code>self.processor</code> in | |
| <a href="https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py" rel="nofollow">diffusers.models.attention_processor</a>.`,name:"attention_kwargs"},{anchor:"diffusers.AuraFlowPipeline.__call__.callback_on_step_end",description:`<strong>callback_on_step_end</strong> (<code>Callable</code>, <em>optional</em>) — | |
| A function that calls at the end of each denoising steps during the inference. The function is called | |
| with the following arguments: <code>callback_on_step_end(self: DiffusionPipeline, step: int, timestep: int, callback_kwargs: Dict)</code>. <code>callback_kwargs</code> will include a list of all tensors as specified by | |
| <code>callback_on_step_end_tensor_inputs</code>.`,name:"callback_on_step_end"},{anchor:"diffusers.AuraFlowPipeline.__call__.callback_on_step_end_tensor_inputs",description:`<strong>callback_on_step_end_tensor_inputs</strong> (<code>List</code>, <em>optional</em>) — | |
| The list of tensor inputs for the <code>callback_on_step_end</code> function. The tensors specified in the list | |
| will be passed as <code>callback_kwargs</code> argument. You will only be able to include variables listed in the | |
| <code>._callback_tensor_inputs</code> attribute of your pipeline class.`,name:"callback_on_step_end_tensor_inputs"},{anchor:"diffusers.AuraFlowPipeline.__call__.max_sequence_length",description:"<strong>max_sequence_length</strong> (<code>int</code> defaults to 256) — Maximum sequence length to use with the <code>prompt</code>.",name:"max_sequence_length"}],source:"https://github.com/huggingface/diffusers/blob/vr_11335/src/diffusers/pipelines/aura_flow/pipeline_aura_flow.py#L438"}}),k=new Ye({props:{anchor:"diffusers.AuraFlowPipeline.__call__.example",$$slots:{default:[Le]},$$scope:{ctx:V}}}),z=new xe({props:{name:"encode_prompt",anchor:"diffusers.AuraFlowPipeline.encode_prompt",parameters:[{name:"prompt",val:": typing.Union[str, typing.List[str]]"},{name:"negative_prompt",val:": typing.Union[str, typing.List[str]] = None"},{name:"do_classifier_free_guidance",val:": bool = True"},{name:"num_images_per_prompt",val:": int = 1"},{name:"device",val:": typing.Optional[torch.device] = None"},{name:"prompt_embeds",val:": typing.Optional[torch.Tensor] = None"},{name:"negative_prompt_embeds",val:": typing.Optional[torch.Tensor] = None"},{name:"prompt_attention_mask",val:": typing.Optional[torch.Tensor] = None"},{name:"negative_prompt_attention_mask",val:": typing.Optional[torch.Tensor] = None"},{name:"max_sequence_length",val:": int = 256"},{name:"lora_scale",val:": typing.Optional[float] = None"}],parametersDescription:[{anchor:"diffusers.AuraFlowPipeline.encode_prompt.prompt",description:`<strong>prompt</strong> (<code>str</code> or <code>List[str]</code>, <em>optional</em>) — | |
| prompt to be encoded`,name:"prompt"},{anchor:"diffusers.AuraFlowPipeline.encode_prompt.negative_prompt",description:`<strong>negative_prompt</strong> (<code>str</code> or <code>List[str]</code>, <em>optional</em>) — | |
| The prompt not to guide the image generation. If not defined, one has to pass <code>negative_prompt_embeds</code> | |
| instead. Ignored when not using guidance (i.e., ignored if <code>guidance_scale</code> is less than <code>1</code>).`,name:"negative_prompt"},{anchor:"diffusers.AuraFlowPipeline.encode_prompt.do_classifier_free_guidance",description:`<strong>do_classifier_free_guidance</strong> (<code>bool</code>, <em>optional</em>, defaults to <code>True</code>) — | |
| whether to use classifier free guidance or not`,name:"do_classifier_free_guidance"},{anchor:"diffusers.AuraFlowPipeline.encode_prompt.num_images_per_prompt",description:`<strong>num_images_per_prompt</strong> (<code>int</code>, <em>optional</em>, defaults to 1) — | |
| number of images that should be generated per prompt`,name:"num_images_per_prompt"},{anchor:"diffusers.AuraFlowPipeline.encode_prompt.device",description:`<strong>device</strong> — (<code>torch.device</code>, <em>optional</em>): | |
| torch device to place the resulting embeddings on`,name:"device"},{anchor:"diffusers.AuraFlowPipeline.encode_prompt.prompt_embeds",description:`<strong>prompt_embeds</strong> (<code>torch.Tensor</code>, <em>optional</em>) — | |
| Pre-generated text embeddings. Can be used to easily tweak text inputs, <em>e.g.</em> prompt weighting. If not | |
| provided, text embeddings will be generated from <code>prompt</code> input argument.`,name:"prompt_embeds"},{anchor:"diffusers.AuraFlowPipeline.encode_prompt.prompt_attention_mask",description:`<strong>prompt_attention_mask</strong> (<code>torch.Tensor</code>, <em>optional</em>) — | |
| Pre-generated attention mask for text embeddings.`,name:"prompt_attention_mask"},{anchor:"diffusers.AuraFlowPipeline.encode_prompt.negative_prompt_embeds",description:`<strong>negative_prompt_embeds</strong> (<code>torch.Tensor</code>, <em>optional</em>) — | |
| Pre-generated negative text embeddings.`,name:"negative_prompt_embeds"},{anchor:"diffusers.AuraFlowPipeline.encode_prompt.negative_prompt_attention_mask",description:`<strong>negative_prompt_attention_mask</strong> (<code>torch.Tensor</code>, <em>optional</em>) — | |
| Pre-generated attention mask for negative text embeddings.`,name:"negative_prompt_attention_mask"},{anchor:"diffusers.AuraFlowPipeline.encode_prompt.max_sequence_length",description:"<strong>max_sequence_length</strong> (<code>int</code>, defaults to 256) — Maximum sequence length to use for the prompt.",name:"max_sequence_length"},{anchor:"diffusers.AuraFlowPipeline.encode_prompt.lora_scale",description:`<strong>lora_scale</strong> (<code>float</code>, <em>optional</em>) — | |
| A lora scale that will be applied to all LoRA layers of the text encoder if LoRA layers are loaded.`,name:"lora_scale"}],source:"https://github.com/huggingface/diffusers/blob/vr_11335/src/diffusers/pipelines/aura_flow/pipeline_aura_flow.py#L232"}}),Y=new Ve({props:{source:"https://github.com/huggingface/diffusers/blob/main/docs/source/en/api/pipelines/aura_flow.md"}}),{c(){r=l("meta"),U=a(),d=l("p"),c=a(),m(b.$$.fragment),i=a(),M=l("p"),M.innerHTML=ke,ee=a(),$=l("p"),$.innerHTML=Ze,te=a(),m(x.$$.fragment),ne=a(),m(A.$$.fragment),oe=a(),C=l("p"),C.textContent=$e,ae=a(),I=l("p"),I.innerHTML=Ae,se=a(),m(j.$$.fragment),re=a(),B=l("p"),B.innerHTML=Ce,ie=a(),m(G.$$.fragment),le=a(),m(P.$$.fragment),pe=a(),X=l("p"),X.innerHTML=Ie,de=a(),m(E.$$.fragment),ce=a(),N=l("p"),N.textContent=je,me=a(),Q=l("p"),Q.innerHTML=Be,ue=a(),m(W.$$.fragment),fe=a(),J=l("div"),m(R.$$.fragment),Te=a(),y=l("div"),m(q.$$.fragment),Me=a(),H=l("p"),H.textContent=Ge,Je=a(),m(k.$$.fragment),ve=a(),L=l("p"),L.innerHTML=Pe,Ue=a(),Z=l("div"),m(z.$$.fragment),Fe=a(),S=l("p"),S.textContent=Xe,ge=a(),m(Y.$$.fragment),_e=a(),D=l("p"),this.h()},l(e){const t=qe("svelte-u9bgzb",document.head);r=p(t,"META",{name:!0,content:!0}),t.forEach(n),U=s(e),d=p(e,"P",{}),O(d).forEach(n),c=s(e),u(b.$$.fragment,e),i=s(e),M=p(e,"P",{"data-svelte-h":!0}),w(M)!=="svelte-mz8sy4"&&(M.innerHTML=ke),ee=s(e),$=p(e,"P",{"data-svelte-h":!0}),w($)!=="svelte-1tuv1oa"&&($.innerHTML=Ze),te=s(e),u(x.$$.fragment,e),ne=s(e),u(A.$$.fragment,e),oe=s(e),C=p(e,"P",{"data-svelte-h":!0}),w(C)!=="svelte-1ou2pxc"&&(C.textContent=$e),ae=s(e),I=p(e,"P",{"data-svelte-h":!0}),w(I)!=="svelte-pmnat1"&&(I.innerHTML=Ae),se=s(e),u(j.$$.fragment,e),re=s(e),B=p(e,"P",{"data-svelte-h":!0}),w(B)!=="svelte-9873at"&&(B.innerHTML=Ce),ie=s(e),u(G.$$.fragment,e),le=s(e),u(P.$$.fragment,e),pe=s(e),X=p(e,"P",{"data-svelte-h":!0}),w(X)!=="svelte-10cvqm3"&&(X.innerHTML=Ie),de=s(e),u(E.$$.fragment,e),ce=s(e),N=p(e,"P",{"data-svelte-h":!0}),w(N)!=="svelte-rc38yx"&&(N.textContent=je),me=s(e),Q=p(e,"P",{"data-svelte-h":!0}),w(Q)!=="svelte-1l949d6"&&(Q.innerHTML=Be),ue=s(e),u(W.$$.fragment,e),fe=s(e),J=p(e,"DIV",{class:!0});var F=O(J);u(R.$$.fragment,F),Te=s(F),y=p(F,"DIV",{class:!0});var v=O(y);u(q.$$.fragment,v),Me=s(v),H=p(v,"P",{"data-svelte-h":!0}),w(H)!=="svelte-v78lg8"&&(H.textContent=Ge),Je=s(v),u(k.$$.fragment,v),ve=s(v),L=p(v,"P",{"data-svelte-h":!0}),w(L)!=="svelte-1muk50q"&&(L.innerHTML=Pe),v.forEach(n),Ue=s(F),Z=p(F,"DIV",{class:!0});var we=O(Z);u(z.$$.fragment,we),Fe=s(we),S=p(we,"P",{"data-svelte-h":!0}),w(S)!=="svelte-16q0ax1"&&(S.textContent=Xe),we.forEach(n),F.forEach(n),ge=s(e),u(Y.$$.fragment,e),_e=s(e),D=p(e,"P",{}),O(D).forEach(n),this.h()},h(){K(r,"name","hf:doc:metadata"),K(r,"content",De),K(y,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),K(Z,"class","docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"),K(J,"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,t){T(document.head,r),o(e,U,t),o(e,d,t),o(e,c,t),f(b,e,t),o(e,i,t),o(e,M,t),o(e,ee,t),o(e,$,t),o(e,te,t),f(x,e,t),o(e,ne,t),f(A,e,t),o(e,oe,t),o(e,C,t),o(e,ae,t),o(e,I,t),o(e,se,t),f(j,e,t),o(e,re,t),o(e,B,t),o(e,ie,t),f(G,e,t),o(e,le,t),f(P,e,t),o(e,pe,t),o(e,X,t),o(e,de,t),f(E,e,t),o(e,ce,t),o(e,N,t),o(e,me,t),o(e,Q,t),o(e,ue,t),f(W,e,t),o(e,fe,t),o(e,J,t),f(R,J,null),T(J,Te),T(J,y),f(q,y,null),T(y,Me),T(y,H),T(y,Je),f(k,y,null),T(y,ve),T(y,L),T(J,Ue),T(J,Z),f(z,Z,null),T(Z,Fe),T(Z,S),o(e,ge,t),f(Y,e,t),o(e,_e,t),o(e,D,t),he=!0},p(e,[t]){const F={};t&2&&(F.$$scope={dirty:t,ctx:e}),x.$set(F);const v={};t&2&&(v.$$scope={dirty:t,ctx:e}),k.$set(v)},i(e){he||(g(b.$$.fragment,e),g(x.$$.fragment,e),g(A.$$.fragment,e),g(j.$$.fragment,e),g(G.$$.fragment,e),g(P.$$.fragment,e),g(E.$$.fragment,e),g(W.$$.fragment,e),g(R.$$.fragment,e),g(q.$$.fragment,e),g(k.$$.fragment,e),g(z.$$.fragment,e),g(Y.$$.fragment,e),he=!0)},o(e){_(b.$$.fragment,e),_(x.$$.fragment,e),_(A.$$.fragment,e),_(j.$$.fragment,e),_(G.$$.fragment,e),_(P.$$.fragment,e),_(E.$$.fragment,e),_(W.$$.fragment,e),_(R.$$.fragment,e),_(q.$$.fragment,e),_(k.$$.fragment,e),_(z.$$.fragment,e),_(Y.$$.fragment,e),he=!1},d(e){e&&(n(U),n(d),n(c),n(i),n(M),n(ee),n($),n(te),n(ne),n(oe),n(C),n(ae),n(I),n(se),n(re),n(B),n(ie),n(le),n(pe),n(X),n(de),n(ce),n(N),n(me),n(Q),n(ue),n(fe),n(J),n(ge),n(_e),n(D)),n(r),h(b,e),h(x,e),h(A,e),h(j,e),h(G,e),h(P,e),h(E,e),h(W,e),h(R),h(q),h(k),h(z),h(Y,e)}}}const De='{"title":"AuraFlow","local":"auraflow","sections":[{"title":"Quantization","local":"quantization","sections":[],"depth":2},{"title":"Support for torch.compile()","local":"support-for-torchcompile","sections":[],"depth":2},{"title":"AuraFlowPipeline","local":"diffusers.AuraFlowPipeline","sections":[],"depth":2}],"depth":1}';function Oe(V){return Qe(()=>{new URLSearchParams(window.location.search).get("fw")}),[]}class rt extends We{constructor(r){super(),Re(this,r,Oe,Se,Ne,{})}}export{rt as component}; | |
Xet Storage Details
- Size:
- 32.9 kB
- Xet hash:
- 4b55951802f9df8ff919b9e6decf750b2014b96ce270230bf6affbc92f9a897a
·
Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.