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

Pipeline states

PipelineState[[diffusers.modular_pipelines.PipelineState]]

diffusers.modular_pipelines.PipelineState[[diffusers.modular_pipelines.PipelineState]]

diffusers.modular_pipelines.PipelineState(values: dict = <factory>, kwargs_mapping: dict = <factory>)

Source

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

get[[diffusers.modular_pipelines.PipelineState.get]]

get(keys: str | list[str], default: typing.Any = None)

Source

Parameters:

keys (str | list[str]) : Key or list of keys for the values

default (Any) : The default value to return if not found

Returns: 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_kwargs[[diffusers.modular_pipelines.PipelineState.get_by_kwargs]]

get_by_kwargs(kwargs_type: str)

Source

Parameters:

kwargs_type (str) : The kwargs_type to filter by

Returns: dict[str, Any]

Dictionary of values with matching kwargs_type

Get all values with matching kwargs_type.

set[[diffusers.modular_pipelines.PipelineState.set]]

set(key: str, value: typing.Any, kwargs_type: str = None)

Source

Parameters:

key (str) : The key for the value

value (Any) : The value to store

kwargs_type (str) : The kwargs_type with which the value is associated

Add a value to the pipeline state.

to_dict[[diffusers.modular_pipelines.PipelineState.to_dict]]

to_dict()

Source

Convert PipelineState to a dictionary.

BlockState[[diffusers.modular_pipelines.BlockState]]

diffusers.modular_pipelines.BlockState[[diffusers.modular_pipelines.BlockState]]

diffusers.modular_pipelines.BlockState(**kwargs)

Source

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

as_dict[[diffusers.modular_pipelines.BlockState.as_dict]]

as_dict()

Source

Returns: dict[str, Any]

Dictionary containing all attributes of the BlockState

Convert BlockState to a dictionary.