diffusers/pr_13881/en/_app/immutable/nodes/115.DW_PrUf7.js

import"../chunks/DsnmJJEf.js";import{i as G,h as M,C as E,H as d,D as t,E as H,s as N}from"../chunks/CmJXCtRL.js";import{p as z,o as I,s as e,f as K,a as x,b as O,c as r,d as S,n as a,r as i}from"../chunks/DK803DsY.js";const R='{"title":"Pipeline states","local":"pipeline-states","sections":[{"title":"PipelineState","local":"diffusers.modular_pipelines.PipelineState","sections":[],"depth":2},{"title":"BlockState","local":"diffusers.modular_pipelines.BlockState","sections":[],"depth":2}],"depth":1}';var U=S('<meta name="hf:doc:metadata"/>'),j=S('<p></p> <!> <!> <!> <div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"><!> <p><code>PipelineState</code> stores the state of a pipeline. It is used to pass data between pipeline blocks.</p> <div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"><!> <p>Get one or multiple values from the pipeline state.</p></div> <div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"><!> <p>Get all values with matching kwargs_type.</p></div> <div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"><!> <p>Add a value to the pipeline state.</p></div> <div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"><!> <p>Convert PipelineState to a dictionary.</p></div></div> <!> <div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"><!> <p>Container for block state data with attribute access and formatted representation.</p> <div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8"><!> <p>Convert BlockState to a dictionary.</p></div></div> <!> <p></p>',1);function Q(w,P){z(P,!1),I(()=>{new URLSearchParams(window.location.search).get("fw")}),G();var c=j();M("15gtuvy",b=>{var k=U();N(k,"content",R),x(b,k)});var u=e(K(c),2);E(u,{containerStyle:"float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"});var m=e(u,2);d(m,{title:"Pipeline states",local:"pipeline-states",headingTag:"h1"});var f=e(m,2);d(f,{title:"PipelineState",local:"diffusers.modular_pipelines.PipelineState",headingTag:"h2"});var s=e(f,2),g=r(s);t(g,{name:"class diffusers.modular_pipelines.PipelineState",anchor:"diffusers.modular_pipelines.PipelineState",source:"https://github.com/huggingface/diffusers/blob/vr_13881/src/diffusers/modular_pipelines/modular_pipeline.py#L146",parameters:[{name:"values",val:": dict = <factory>"},{name:"kwargs_mapping",val:": dict = <factory>"}]});var n=e(g,4),T=r(n);t(T,{name:"get",anchor:"diffusers.modular_pipelines.PipelineState.get",source:"https://github.com/huggingface/diffusers/blob/vr_13881/src/diffusers/modular_pipelines/modular_pipeline.py#L171",parameters:[{name:"keys",val:": str | list[str]"},{name:"default",val:": typing.Any = None"}],parametersDescription:[{anchor:"diffusers.modular_pipelines.PipelineState.get.keys",description:"<strong>keys</strong> (str | list[str]) &#x2014; Key or list of keys for the values",name:"keys"},{anchor:"diffusers.modular_pipelines.PipelineState.get.default",description:"<strong>default</strong> (Any) &#x2014; The default value to return if not found",name:"default"}],returnDescription:`<script context="module">export const metadata = 'undefined';<\/script>


<p>Single value if keys is str, dictionary of values if keys is list</p>
`,returnType:`<script context="module">export const metadata = 'undefined';<\/script>


<p>Any | dict[str, Any]</p>
`}),a(2),i(n);var o=e(n,2),D=r(o);t(D,{name:"get_by_kwargs",anchor:"diffusers.modular_pipelines.PipelineState.get_by_kwargs",source:"https://github.com/huggingface/diffusers/blob/vr_13881/src/diffusers/modular_pipelines/modular_pipeline.py#L186",parameters:[{name:"kwargs_type",val:": str"}],parametersDescription:[{anchor:"diffusers.modular_pipelines.PipelineState.get_by_kwargs.kwargs_type",description:"<strong>kwargs_type</strong> (str) &#x2014; The kwargs_type to filter by",name:"kwargs_type"}],returnDescription:`<script context="module">export const metadata = 'undefined';<\/script>


<p>Dictionary of values with matching kwargs_type</p>
`,returnType:`<script context="module">export const metadata = 'undefined';<\/script>


<p>dict[str, Any]</p>
`}),a(2),i(o);var p=e(o,2),L=r(p);t(L,{name:"set",anchor:"diffusers.modular_pipelines.PipelineState.set",source:"https://github.com/huggingface/diffusers/blob/vr_13881/src/diffusers/modular_pipelines/modular_pipeline.py#L154",parameters:[{name:"key",val:": str"},{name:"value",val:": typing.Any"},{name:"kwargs_type",val:": str = None"}],parametersDescription:[{anchor:"diffusers.modular_pipelines.PipelineState.set.key",description:"<strong>key</strong> (str) &#x2014; The key for the value",name:"key"},{anchor:"diffusers.modular_pipelines.PipelineState.set.value",description:"<strong>value</strong> (Any) &#x2014; The value to store",name:"value"},{anchor:"diffusers.modular_pipelines.PipelineState.set.kwargs_type",description:"<strong>kwargs_type</strong> (str) &#x2014; The kwargs_type with which the value is associated",name:"kwargs_type"}]}),a(2),i(p);var _=e(p,2),A=r(_);t(A,{name:"to_dict",anchor:"diffusers.modular_pipelines.PipelineState.to_dict",source:"https://github.com/huggingface/diffusers/blob/vr_13881/src/diffusers/modular_pipelines/modular_pipeline.py#L199",parameters:[]}),a(2),i(_),i(s);var v=e(s,2);d(v,{title:"BlockState",local:"diffusers.modular_pipelines.BlockState",headingTag:"h2"});var l=e(v,2),h=r(l);t(h,{name:"class diffusers.modular_pipelines.BlockState",anchor:"diffusers.modular_pipelines.BlockState",source:"https://github.com/huggingface/diffusers/blob/vr_13881/src/diffusers/modular_pipelines/modular_pipeline.py#L236",parameters:[{name:"**kwargs",val:""}]});var y=e(h,4),B=r(y);t(B,{name:"as_dict",anchor:"diffusers.modular_pipelines.BlockState.as_dict",source:"https://github.com/huggingface/diffusers/blob/vr_13881/src/diffusers/modular_pipelines/modular_pipeline.py#L253",parameters:[],returnDescription:`<script context="module">export const metadata = 'undefined';<\/script>


<p>Dictionary containing all attributes of the BlockState</p>
`,returnType:`<script context="module">export const metadata = 'undefined';<\/script>


<p>dict[str, Any]</p>
`}),a(2),i(y),i(l);var C=e(l,2);H(C,{source:"https://github.com/huggingface/diffusers/blob/main/docs/source/en/api/modular_diffusers/pipeline_states.md"}),a(2),x(w,c),O()}export{Q as component};