#
Pipeline states

##
PipelineState

###
class diffusers.modular_pipelines.PipelineState

< source >

( values: typing.Dict[str, typing.Any] = <factory> kwargs_mapping: typing.Dict[str, typing.List[str]] = <factory> )

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

####
get

< source >

( keys: typing.Union[str, typing.List[str]] default: typing.Any = None ) →
Union[Any, Dict[str, Any]]

Parameters

- keys (Union[str, List[str]]) — Key or list of keys for the values
- default (Any) — The default value to return if not found

Returns

Union[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

< source >

( kwargs_type: str ) →
Dict[str, Any]

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

< source >

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

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

< source >

( )

Convert PipelineState to a dictionary.

##
BlockState

###
class diffusers.modular_pipelines.BlockState

< source >

( **kwargs )

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

####
as_dict

< source >

( ) →
Dict[str, Any]

Returns

Dict[str, Any]

Dictionary containing all attributes of the BlockState

Convert BlockState to a dictionary.

< > Update on GitHub