diffusers/pr_12509/en/api/modular_diffusers/pipeline_states.md

Pipeline states

PipelineState[[diffusers.modular_pipelines.PipelineState]]

class diffusers.modular_pipelines.PipelineStatediffusers.modular_pipelines.PipelineStatehttps://github.com/huggingface/diffusers/blob/vr_12509/src/diffusers/modular_pipelines/modular_pipeline.py#L69[{"name": "values", "val": ": typing.Dict[str, typing.Any] = "}, {"name": "kwargs_mapping", "val": ": typing.Dict[str, typing.List[str]] = "}]

PipelineState stores the state of a pipeline. It is used to pass data between pipeline blocks.

getdiffusers.modular_pipelines.PipelineState.gethttps://github.com/huggingface/diffusers/blob/vr_12509/src/diffusers/modular_pipelines/modular_pipeline.py#L94[{"name": "keys", "val": ": typing.Union[str, typing.List[str]]"}, {"name": "default", "val": ": typing.Any = None"}]- keys (Union[str, List[str]]) -- Key or list of keys for the values

• default (Any) -- The default value to return if not found0Union[Any, Dict[str, Any]]Single value if keys is str, dictionary of values if keys is list

Get one or multiple values from the pipeline state.

get_by_kwargsdiffusers.modular_pipelines.PipelineState.get_by_kwargshttps://github.com/huggingface/diffusers/blob/vr_12509/src/diffusers/modular_pipelines/modular_pipeline.py#L109[{"name": "kwargs_type", "val": ": str"}]- kwargs_type (str) -- The kwargs_type to filter by0Dict[str, Any]Dictionary of values with matching kwargs_type

Get all values with matching kwargs_type.

setdiffusers.modular_pipelines.PipelineState.sethttps://github.com/huggingface/diffusers/blob/vr_12509/src/diffusers/modular_pipelines/modular_pipeline.py#L77[{"name": "key", "val": ": str"}, {"name": "value", "val": ": typing.Any"}, {"name": "kwargs_type", "val": ": str = None"}]- key (str) -- The key for the value

• value (Any) -- The value to store
• kwargs_type (str) -- The kwargs_type with which the value is associated0

Add a value to the pipeline state.

to_dictdiffusers.modular_pipelines.PipelineState.to_dicthttps://github.com/huggingface/diffusers/blob/vr_12509/src/diffusers/modular_pipelines/modular_pipeline.py#L122[]

Convert PipelineState to a dictionary.

BlockState[[diffusers.modular_pipelines.BlockState]]

class diffusers.modular_pipelines.BlockStatediffusers.modular_pipelines.BlockStatehttps://github.com/huggingface/diffusers/blob/vr_12509/src/diffusers/modular_pipelines/modular_pipeline.py#L153[{"name": "**kwargs", "val": ""}]

Container for block state data with attribute access and formatted representation.

as_dictdiffusers.modular_pipelines.BlockState.as_dicthttps://github.com/huggingface/diffusers/blob/vr_12509/src/diffusers/modular_pipelines/modular_pipeline.py#L170[]Dict[str, Any]Dictionary containing all attributes of the BlockState

Convert BlockState to a dictionary.