Buckets:

hf-doc-build
/

doc-dev

Files

xet

hf-doc-build/doc-dev / diffusers /pr_13881 /en /using-diffusers /guiders.html

HuggingFaceDocBuilder

about 17 hours ago

download

raw

36.4 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"Guiders","local":"guiders","sections":[{"title":"Switching guiders","local":"switching-guiders","sections":[],"depth":2},{"title":"Loading custom guiders","local":"loading-custom-guiders","sections":[],"depth":2},{"title":"Changing guider parameters","local":"changing-guider-parameters","sections":[],"depth":2},{"title":"Uploading custom guiders","local":"uploading-custom-guiders","sections":[],"depth":2}],"depth":1}"/>
	<link href="/docs/diffusers/main/en/_app/immutable/entry/start.BKtHvaj4.js" rel="modulepreload">
	<link href="/docs/diffusers/main/en/_app/immutable/chunks/DA5YANCb.js" rel="modulepreload">
	<link href="/docs/diffusers/main/en/_app/immutable/chunks/DK803DsY.js" rel="modulepreload">
	<link href="/docs/diffusers/main/en/_app/immutable/entry/app.Cp32ddTn.js" rel="modulepreload">
	<link href="/docs/diffusers/main/en/_app/immutable/chunks/DTwaC60R.js" rel="modulepreload">
	<link href="/docs/diffusers/main/en/_app/immutable/chunks/BTASUwav.js" rel="modulepreload">
	<link href="/docs/diffusers/main/en/_app/immutable/chunks/C1r7BcyV.js" rel="modulepreload">
	<link href="/docs/diffusers/main/en/_app/immutable/chunks/DsnmJJEf.js" rel="modulepreload">
	<link href="/docs/diffusers/main/en/_app/immutable/nodes/0.BPNuemSR.js" rel="modulepreload">
	<link href="/docs/diffusers/main/en/_app/immutable/chunks/BzOvRKAw.js" rel="modulepreload">
	<link href="/docs/diffusers/main/en/_app/immutable/nodes/349.BvI5thRW.js" rel="modulepreload">
	<link href="/docs/diffusers/main/en/_app/immutable/chunks/CmJXCtRL.js" rel="modulepreload">
	<link href="/docs/diffusers/main/en/_app/immutable/chunks/BtTdhXOX.js" rel="modulepreload">
	<!--p5m5hv--><meta name="hf:doc:metadata" content="{"title":"Guiders","local":"guiders","sections":[{"title":"Switching guiders","local":"switching-guiders","sections":[],"depth":2},{"title":"Loading custom guiders","local":"loading-custom-guiders","sections":[],"depth":2},{"title":"Changing guider parameters","local":"changing-guider-parameters","sections":[],"depth":2},{"title":"Uploading custom guiders","local":"uploading-custom-guiders","sections":[],"depth":2}],"depth":1}"/><!---->
	<link href="/docs/diffusers/main/en/_app/immutable/assets/0.tn0RQdqM.css" rel="modulepreload"> <!--[--><!--[0--><!--[--><!--[0--><!--[--><p></p> <div class="items-center shrink-0 min-w-[100px] max-sm:min-w-[50px] justify-end ml-auto flex" style="float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"><div class="inline-flex rounded-md max-sm:rounded-sm"><button class="inline-flex items-center gap-1 h-7 max-sm:h-7 px-2 max-sm:px-1.5 text-sm font-medium text-gray-800 border border-r-0 rounded-l-md max-sm:rounded-l-sm border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-live="polite"><span class="inline-flex items-center justify-center rounded-md p-0.5 max-sm:p-0 hover:text-gray-800 dark:hover:text-gray-200"><svg class="sm:size-3.5 size-3" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg><!----></span> <span>Copy page</span></button> <button class="inline-flex items-center justify-center w-6 max-sm:w-5 h-7 max-sm:h-7 disabled:pointer-events-none text-sm text-gray-500 hover:text-gray-700 dark:hover:text-white rounded-r-md max-sm:rounded-r-sm border border-l transition border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-haspopup="menu" aria-expanded="false" aria-label="Open copy menu"><svg class="transition-transform text-gray-400 overflow-visible sm:size-3.5 size-3 rotate-0" width="1em" height="1em" viewBox="0 0 12 7" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L6 6L11 1" stroke="currentColor"></path></svg><!----></button></div> <!--[-1--><!--]--></div><!----> <!--[0--><h1 class="relative group"><a id="guiders" 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" href="#guiders"><span><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg><!----></span></a> <span>Guiders</span></h1><!--]--><!----> <p><a href="https://huggingface.co/papers/2207.12598" rel="nofollow">Classifier-free guidance</a> steers model generation that better match a prompt and is commonly used to improve generation quality, control, and adherence to prompts. There are different types of guidance methods, and in Diffusers, they are known as <em>guiders</em>. Like blocks, it is easy to switch and use different guiders for different use cases without rewriting the pipeline.</p> <p>This guide will show you how to switch guiders, adjust guider parameters, and load and share them to the Hub.</p> <!--[1--><h2 class="relative group"><a id="switching-guiders" 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" href="#switching-guiders"><span><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg><!----></span></a> <span>Switching guiders</span></h2><!--]--><!----> <p><a href="/docs/diffusers/pr_13881/en/api/modular_diffusers/guiders#diffusers.ClassifierFreeGuidance">ClassifierFreeGuidance</a> is the default guider and created when a pipeline is initialized with <a href="/docs/diffusers/pr_13881/en/api/modular_diffusers/pipeline_blocks#diffusers.ModularPipelineBlocks.init_pipeline">init_pipeline()</a>. It is created by <code>from_config</code> which means it doesn’t require loading specifications from a modular repository. A guider won’t be listed in <code>modular_model_index.json</code>.</p> <p>Use <a href="/docs/diffusers/pr_13881/en/api/modular_diffusers/pipeline#diffusers.ModularPipeline.get_component_spec">get_component_spec()</a> to inspect a guider.</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg><!----> <div class=" absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0 "><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent;"></div> Copied</div><!----></button><!----></div> <pre class="language-py "><!---->t2i_pipeline.get_component_spec(<span class="hljs-string">"guider"</span>)
	ComponentSpec(name=<span class="hljs-string">'guider'</span>, type_hint=<<span class="hljs-keyword">class</span> <span class="hljs-string">'diffusers.guiders.classifier_free_guidance.ClassifierFreeGuidance'</span>>, description=<span class="hljs-literal">None</span>, config=FrozenDict([(<span class="hljs-string">'guidance_scale'</span>, <span class="hljs-number">7.5</span>), (<span class="hljs-string">'guidance_rescale'</span>, <span class="hljs-number">0.0</span>), (<span class="hljs-string">'use_original_formulation'</span>, <span class="hljs-literal">False</span>), (<span class="hljs-string">'start'</span>, <span class="hljs-number">0.0</span>), (<span class="hljs-string">'stop'</span>, <span class="hljs-number">1.0</span>), (<span class="hljs-string">'_use_default_values'</span>, [<span class="hljs-string">'start'</span>, <span class="hljs-string">'guidance_rescale'</span>, <span class="hljs-string">'stop'</span>, <span class="hljs-string">'use_original_formulation'</span>])]), repo=<span class="hljs-literal">None</span>, subfolder=<span class="hljs-literal">None</span>, variant=<span class="hljs-literal">None</span>, revision=<span class="hljs-literal">None</span>, default_creation_method=<span class="hljs-string">'from_config'</span>)<!----></pre></div><!----> <p>Switch to a different guider by passing the new guider to <a href="/docs/diffusers/pr_13881/en/api/modular_diffusers/pipeline#diffusers.ModularPipeline.update_components">update_components()</a>.</p> <blockquote class="tip"><p>Changing guiders will return text letting you know you’re changing the guider type.</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg><!----> <div class=" absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0 "><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent;"></div> Copied</div><!----></button><!----></div> <pre class="language-bash "><!---->ModularPipeline.update_components: adding guider with new <span class="hljs-built_in">type</span>: PerturbedAttentionGuidance, previous <span class="hljs-built_in">type</span>: ClassifierFreeGuidance<!----></pre></div><!----></blockquote> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg><!----> <div class=" absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0 "><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent;"></div> Copied</div><!----></button><!----></div> <pre class="language-py "><!----><span class="hljs-keyword">from</span> diffusers <span class="hljs-keyword">import</span> LayerSkipConfig, PerturbedAttentionGuidance

	config = LayerSkipConfig(indices=[<span class="hljs-number">2</span>, <span class="hljs-number">9</span>], fqn=<span class="hljs-string">"mid_block.attentions.0.transformer_blocks"</span>, skip_attention=<span class="hljs-literal">False</span>, skip_attention_scores=<span class="hljs-literal">True</span>, skip_ff=<span class="hljs-literal">False</span>)
	guider = PerturbedAttentionGuidance(
	guidance_scale=<span class="hljs-number">5.0</span>, perturbed_guidance_scale=<span class="hljs-number">2.5</span>, perturbed_guidance_config=config
	)
	t2i_pipeline.update_components(guider=guider)<!----></pre></div><!----> <p>Use <a href="/docs/diffusers/pr_13881/en/api/modular_diffusers/pipeline#diffusers.ModularPipeline.get_component_spec">get_component_spec()</a> again to verify the guider type is different.</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg><!----> <div class=" absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0 "><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent;"></div> Copied</div><!----></button><!----></div> <pre class="language-py "><!---->t2i_pipeline.get_component_spec(<span class="hljs-string">"guider"</span>)
	ComponentSpec(name=<span class="hljs-string">'guider'</span>, type_hint=<<span class="hljs-keyword">class</span> <span class="hljs-string">'diffusers.guiders.perturbed_attention_guidance.PerturbedAttentionGuidance'</span>>, description=<span class="hljs-literal">None</span>, config=FrozenDict([(<span class="hljs-string">'guidance_scale'</span>, <span class="hljs-number">5.0</span>), (<span class="hljs-string">'perturbed_guidance_scale'</span>, <span class="hljs-number">2.5</span>), (<span class="hljs-string">'perturbed_guidance_start'</span>, <span class="hljs-number">0.01</span>), (<span class="hljs-string">'perturbed_guidance_stop'</span>, <span class="hljs-number">0.2</span>), (<span class="hljs-string">'perturbed_guidance_layers'</span>, <span class="hljs-literal">None</span>), (<span class="hljs-string">'perturbed_guidance_config'</span>, LayerSkipConfig(indices=[<span class="hljs-number">2</span>, <span class="hljs-number">9</span>], fqn=<span class="hljs-string">'mid_block.attentions.0.transformer_blocks'</span>, skip_attention=<span class="hljs-literal">False</span>, skip_attention_scores=<span class="hljs-literal">True</span>, skip_ff=<span class="hljs-literal">False</span>, dropout=<span class="hljs-number">1.0</span>)), (<span class="hljs-string">'guidance_rescale'</span>, <span class="hljs-number">0.0</span>), (<span class="hljs-string">'use_original_formulation'</span>, <span class="hljs-literal">False</span>), (<span class="hljs-string">'start'</span>, <span class="hljs-number">0.0</span>), (<span class="hljs-string">'stop'</span>, <span class="hljs-number">1.0</span>), (<span class="hljs-string">'_use_default_values'</span>, [<span class="hljs-string">'perturbed_guidance_start'</span>, <span class="hljs-string">'use_original_formulation'</span>, <span class="hljs-string">'perturbed_guidance_layers'</span>, <span class="hljs-string">'stop'</span>, <span class="hljs-string">'start'</span>, <span class="hljs-string">'guidance_rescale'</span>, <span class="hljs-string">'perturbed_guidance_stop'</span>]), (<span class="hljs-string">'_class_name'</span>, <span class="hljs-string">'PerturbedAttentionGuidance'</span>), (<span class="hljs-string">'_diffusers_version'</span>, <span class="hljs-string">'0.35.0.dev0'</span>)]), repo=<span class="hljs-literal">None</span>, subfolder=<span class="hljs-literal">None</span>, variant=<span class="hljs-literal">None</span>, revision=<span class="hljs-literal">None</span>, default_creation_method=<span class="hljs-string">'from_config'</span>)<!----></pre></div><!----> <!--[1--><h2 class="relative group"><a id="loading-custom-guiders" 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" href="#loading-custom-guiders"><span><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg><!----></span></a> <span>Loading custom guiders</span></h2><!--]--><!----> <p>Guiders that are already saved on the Hub with a <code>modular_model_index.json</code> file are considered a <code>from_pretrained</code> component now instead of a <code>from_config</code> component.</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg><!----> <div class=" absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0 "><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent;"></div> Copied</div><!----></button><!----></div> <pre class="language-json "><!----><span class="hljs-punctuation">{</span>
	<span class="hljs-attr">"guider"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span>
	<span class="hljs-literal"><span class="hljs-keyword">null</span></span><span class="hljs-punctuation">,</span>
	<span class="hljs-literal"><span class="hljs-keyword">null</span></span><span class="hljs-punctuation">,</span>
	<span class="hljs-punctuation">{</span>
	<span class="hljs-attr">"repo"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"YiYiXu/modular-loader-t2i-guider"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"revision"</span><span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">null</span></span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"subfolder"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"pag_guider"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"type_hint"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span>
	<span class="hljs-string">"diffusers"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-string">"PerturbedAttentionGuidance"</span>
	<span class="hljs-punctuation">]</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"variant"</span><span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">null</span></span>
	<span class="hljs-punctuation">}</span>
	<span class="hljs-punctuation">]</span>
	<span class="hljs-punctuation">}</span><!----></pre></div><!----> <p>The guider is only created after calling <a href="/docs/diffusers/pr_13881/en/api/modular_diffusers/pipeline#diffusers.ModularPipeline.load_components">load_components()</a> based on the loading specification in <code>modular_model_index.json</code>.</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg><!----> <div class=" absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0 "><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent;"></div> Copied</div><!----></button><!----></div> <pre class="language-py "><!---->t2i_pipeline = t2i_blocks.init_pipeline(<span class="hljs-string">"YiYiXu/modular-doc-guider"</span>)
	<span class="hljs-comment"># not created during init</span>
	<span class="hljs-keyword">assert</span> t2i_pipeline.guider <span class="hljs-keyword">is</span> <span class="hljs-literal">None</span>
	t2i_pipeline.load_components()
	<span class="hljs-comment"># loaded as PAG guider</span>
	t2i_pipeline.guider<!----></pre></div><!----> <!--[1--><h2 class="relative group"><a id="changing-guider-parameters" 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" href="#changing-guider-parameters"><span><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg><!----></span></a> <span>Changing guider parameters</span></h2><!--]--><!----> <p>The guider parameters can be adjusted with the <a href="/docs/diffusers/pr_13881/en/api/modular_diffusers/pipeline_components#diffusers.ComponentSpec.create">create()</a> method and <a href="/docs/diffusers/pr_13881/en/api/modular_diffusers/pipeline#diffusers.ModularPipeline.update_components">update_components()</a>. The example below changes the <code>guidance_scale</code> value.</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg><!----> <div class=" absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0 "><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent;"></div> Copied</div><!----></button><!----></div> <pre class="language-py "><!---->guider_spec = t2i_pipeline.get_component_spec(<span class="hljs-string">"guider"</span>)
	guider = guider_spec.create(guidance_scale=<span class="hljs-number">10</span>)
	t2i_pipeline.update_components(guider=guider)<!----></pre></div><!----> <!--[1--><h2 class="relative group"><a id="uploading-custom-guiders" 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" href="#uploading-custom-guiders"><span><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg><!----></span></a> <span>Uploading custom guiders</span></h2><!--]--><!----> <p>Call the <a href="/docs/diffusers/pr_13881/en/api/schedulers/overview#diffusers.utils.PushToHubMixin.push_to_hub">push_to_hub()</a> method on a custom guider to share it to the Hub.</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg><!----> <div class=" absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0 "><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent;"></div> Copied</div><!----></button><!----></div> <pre class="language-py "><!---->guider.push_to_hub(<span class="hljs-string">"YiYiXu/modular-loader-t2i-guider"</span>, subfolder=<span class="hljs-string">"pag_guider"</span>)<!----></pre></div><!----> <p>To make this guider available to the pipeline, either modify the <code>modular_model_index.json</code> file or use the <a href="/docs/diffusers/pr_13881/en/api/modular_diffusers/pipeline#diffusers.ModularPipeline.update_components">update_components()</a> method.</p> <div class="flex space-x-2 items-center my-1.5 mr-8 h-7 !pl-0 -mx-3 md:mx-0"><!--[--><div class="flex items-center border rounded-lg px-1.5 py-1 leading-none select-none text-smd border-gray-800 bg-black dark:bg-gray-700 text-white">modular_model_index.json</div><div class="flex items-center border rounded-lg px-1.5 py-1 leading-none select-none text-smd text-gray-500 cursor-pointer opacity-90 hover:text-gray-700 dark:hover:text-gray-200 hover:shadow-sm">update_components</div><!--]--></div> <div class="language-select"><!--[0--><p>Edit the <code>modular_model_index.json</code> file and add a loading specification for the guider by pointing to a folder containing the guider config.</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg><!----> <div class=" absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0 "><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent;"></div> Copied</div><!----></button><!----></div> <pre class="language-json "><!----><span class="hljs-punctuation">{</span>
	<span class="hljs-attr">"guider"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span>
	<span class="hljs-string">"diffusers"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-string">"PerturbedAttentionGuidance"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-punctuation">{</span>
	<span class="hljs-attr">"repo"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"YiYiXu/modular-loader-t2i-guider"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"revision"</span><span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">null</span></span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"subfolder"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"pag_guider"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"type_hint"</span><span class="hljs-punctuation">:</span> <span class="hljs-punctuation">[</span>
	<span class="hljs-string">"diffusers"</span><span class="hljs-punctuation">,</span>
	<span class="hljs-string">"PerturbedAttentionGuidance"</span>
	<span class="hljs-punctuation">]</span><span class="hljs-punctuation">,</span>
	<span class="hljs-attr">"variant"</span><span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">null</span></span>
	<span class="hljs-punctuation">}</span>
	<span class="hljs-punctuation">]</span><span class="hljs-punctuation">,</span><!----></pre></div><!----><!----><!--]--><!----> <!--[-1--><!--]--><!----><!----></div><!----> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/diffusers/blob/main/docs/source/en/using-diffusers/guiders.md" target="_blank"><svg class="mr-1" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M31,16l-7,7l-1.41-1.41L28.17,16l-5.58-5.59L24,9l7,7z"></path><path d="M1,16l7-7l1.41,1.41L3.83,16l5.58,5.59L8,23l-7-7z"></path><path d="M12.419,25.484L17.639,6.552l1.932,0.518L14.351,26.002z"></path></svg><!----> <span><span class="underline">Update</span> on GitHub</span></a><!----> <p></p><!--]--><!----><!--]--><!--]--><!--]--> <!--[-1--><!--]--><!--]-->

	<script>
	{
	__sveltekit_rmdsov = {
	base: "/docs/diffusers/main/en",
	assets: "/docs/diffusers/main/en"
	};

	const element = document.currentScript.parentElement;

	Promise.all([
	import("/docs/diffusers/main/en/_app/immutable/entry/start.BKtHvaj4.js"),
	import("/docs/diffusers/main/en/_app/immutable/entry/app.Cp32ddTn.js")
	]).then(([kit, app]) => {
	kit.start(app, element, {
	node_ids: [0, 349],
	data: [null,null],
	form: null,
	error: null
	});
	});
	}
	</script>

Xet Storage Details

Size:: 36.4 kB
Xet hash:: 9508567bc3bd8f8fbced5bba784a34afcea23f43f10d8fe4fe62491732b337ba

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.