diffusers/pr_12595/en/api/modular_diffusers/pipeline_components.md

Components and configs

ComponentSpec[[diffusers.ComponentSpec]]

class diffusers.ComponentSpecdiffusers.ComponentSpechttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/modular_pipeline_utils.py#L71[{"name": "name", "val": ": typing.Optional[str] = None"}, {"name": "type_hint", "val": ": typing.Optional[typing.Type] = None"}, {"name": "description", "val": ": typing.Optional[str] = None"}, {"name": "config", "val": ": typing.Optional[diffusers.configuration_utils.FrozenDict] = None"}, {"name": "repo", "val": ": typing.Union[str, typing.List[str], NoneType] = None"}, {"name": "subfolder", "val": ": typing.Optional[str] = ''"}, {"name": "variant", "val": ": typing.Optional[str] = None"}, {"name": "revision", "val": ": typing.Optional[str] = None"}, {"name": "default_creation_method", "val": ": typing.Literal['from_config', 'from_pretrained'] = 'from_pretrained'"}]- name -- Name of the component

• type_hint -- Type of the component (e.g. UNet2DConditionModel)
• description -- Optional description of the component
• config -- Optional config dict for init creation
• repo -- Optional repo path for from_pretrained creation
• subfolder -- Optional subfolder in repo
• variant -- Optional variant in repo
• revision -- Optional revision in repo
• default_creation_method -- Preferred creation method - "from_config" or "from_pretrained"0 Specification for a pipeline component.

A component can be created in two ways:

1. From scratch using init with a config dict
2. using from_pretrained

creatediffusers.ComponentSpec.createhttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/modular_pipeline_utils.py#L232[{"name": "config", "val": ": typing.Union[diffusers.configuration_utils.FrozenDict, typing.Dict[str, typing.Any], NoneType] = None"}, {"name": "**kwargs", "val": ""}] Create component using from_config with config.

decode_load_iddiffusers.ComponentSpec.decode_load_idhttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/modular_pipeline_utils.py#L194[{"name": "load_id", "val": ": str"}]- load_id -- The load_id string to decode, format: "repo|subfolder|variant|revision" where None values are represented as "null"0Dict mapping loading field names to their values. e.g. { "repo": "path/to/repo", "subfolder": "subfolder", "variant": "variant", "revision": "revision" } If a segment value is "null", it's replaced with None. Returns None if load_id is "null" (indicating component not created with load method).

Decode a load_id string back into a dictionary of loading fields and values.

from_componentdiffusers.ComponentSpec.from_componenthttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/modular_pipeline_utils.py#L115[{"name": "name", "val": ": str"}, {"name": "component", "val": ": typing.Any"}]- name -- Name of the component

• component -- Component object to create spec from0ComponentSpec object- ValueError -- If component is not supported (e.g. nn.Module without load_id, non-ConfigMixin)ValueError Create a ComponentSpec from a Component.

Currently supports:

• Components created with ComponentSpec.load() method
• Components that are ConfigMixin subclasses but not nn.Modules (e.g. schedulers, guiders)

loaddiffusers.ComponentSpec.loadhttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/modular_pipeline_utils.py#L260[{"name": "**kwargs", "val": ""}] Load component using from_pretrained.

loading_fieldsdiffusers.ComponentSpec.loading_fieldshttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/modular_pipeline_utils.py#L175[]

Return the names of all loading‐related fields (i.e. those whose field.metadata["loading"] is True).

ConfigSpec[[diffusers.modular_pipelines.ConfigSpec]]

class diffusers.modular_pipelines.ConfigSpecdiffusers.modular_pipelines.ConfigSpechttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/modular_pipeline_utils.py#L298[{"name": "name", "val": ": str"}, {"name": "default", "val": ": typing.Any"}, {"name": "description", "val": ": typing.Optional[str] = None"}] Specification for a pipeline configuration parameter.

ComponentsManager[[diffusers.ComponentsManager]]

class diffusers.ComponentsManagerdiffusers.ComponentsManagerhttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/components_manager.py#L285[]

A central registry and management system for model components across multiple pipelines.

ComponentsManager provides a unified way to register, track, and reuse model components (like UNet, VAE, text encoders, etc.) across different modular pipelines. It includes features for duplicate detection, memory management, and component organization.

> This is an experimental feature and is likely to change in the future.

Example:

from diffusers import ComponentsManager

# Create a components manager
cm = ComponentsManager()

# Add components
cm.add("unet", unet_model, collection="sdxl")
cm.add("vae", vae_model, collection="sdxl")

# Enable auto offloading
cm.enable_auto_cpu_offload()

# Retrieve components
unet = cm.get_one(name="unet", collection="sdxl")

adddiffusers.ComponentsManager.addhttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/components_manager.py#L378[{"name": "name", "val": ": str"}, {"name": "component", "val": ": typing.Any"}, {"name": "collection", "val": ": typing.Optional[str] = None"}]- name (str) -- The name of the component

• component (Any) -- The component to add
• collection (Optional[str]) -- The collection to add the component to0strThe unique component ID, which is generated as "{name}_{id(component)}" where id(component) is Python's built-in unique identifier for the object

Add a component to the ComponentsManager.

disable_auto_cpu_offloaddiffusers.ComponentsManager.disable_auto_cpu_offloadhttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/components_manager.py#L735[]

Disable automatic CPU offloading for all components.

enable_auto_cpu_offloaddiffusers.ComponentsManager.enable_auto_cpu_offloadhttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/components_manager.py#L686[{"name": "device", "val": ": typing.Union[str, int, torch.device] = None"}, {"name": "memory_reserve_margin", "val": " = '3GB'"}]- device (Union[str, int, torch.device]) -- The execution device where models are moved for forward passes

• memory_reserve_margin (str) -- The memory reserve margin to use, default is 3GB. This is the amount of memory to keep free on the device to avoid running out of memory during model execution (e.g., for intermediate activations, gradients, etc.)0

Enable automatic CPU offloading for all components.

The algorithm works as follows:

1. All models start on CPU by default
2. When a model's forward pass is called, it's moved to the execution device
3. If there's insufficient memory, other models on the device are moved back to CPU
4. The system tries to offload the smallest combination of models that frees enough memory
5. Models stay on the execution device until another model needs memory and forces them off

get_components_by_idsdiffusers.ComponentsManager.get_components_by_idshttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/components_manager.py#L1029[{"name": "ids", "val": ": typing.List[str]"}, {"name": "return_dict_with_names", "val": ": typing.Optional[bool] = True"}]- ids (List[str]) -- List of component IDs

• return_dict_with_names (Optional[bool]) -- Whether to return a dictionary with component names as keys:0Dict[str, Any]Dictionary of components.
• If return_dict_with_names=True, keys are component names.
• If return_dict_with_names=False, keys are component IDs.- ValueError -- If duplicate component names are found in the search results when return_dict_with_names=TrueValueError

Get components by a list of IDs.

get_components_by_namesdiffusers.ComponentsManager.get_components_by_nameshttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/components_manager.py#L1062[{"name": "names", "val": ": typing.List[str]"}, {"name": "collection", "val": ": typing.Optional[str] = None"}]- names (List[str]) -- List of component names

• collection (Optional[str]) -- Optional collection to filter by0Dict[str, Any]Dictionary of components with component names as keys- ValueError -- If duplicate component names are found in the search resultsValueError

Get components by a list of names, optionally filtered by collection.

get_idsdiffusers.ComponentsManager.get_idshttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/components_manager.py#L1011[{"name": "names", "val": ": typing.Union[str, typing.List[str]] = None"}, {"name": "collection", "val": ": typing.Optional[str] = None"}]- names (Union[str, List[str]]) -- List of component names

• collection (Optional[str]) -- Optional collection to filter by0List[str]List of component IDs

Get component IDs by a list of names, optionally filtered by collection.

get_model_infodiffusers.ComponentsManager.get_model_infohttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/components_manager.py#L752[{"name": "component_id", "val": ": str"}, {"name": "fields", "val": ": typing.Union[str, typing.List[str], NoneType] = None"}]- component_id (str) -- Name of the component to get info for

• fields (Optional[Union[str, List[str]]]) -- Field(s) to return. Can be a string for single field or list of fields. If None, uses the available_info_fields setting.0Dictionary containing requested component metadata. If fields is specified, returns only those fields. Otherwise, returns all fields. Get comprehensive information about a component.

get_onediffusers.ComponentsManager.get_onehttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/components_manager.py#L966[{"name": "component_id", "val": ": typing.Optional[str] = None"}, {"name": "name", "val": ": typing.Optional[str] = None"}, {"name": "collection", "val": ": typing.Optional[str] = None"}, {"name": "load_id", "val": ": typing.Optional[str] = None"}]- component_id (Optional[str]) -- Optional component ID to get

• name (Optional[str]) -- Component name or pattern
• collection (Optional[str]) -- Optional collection to filter by
• load_id (Optional[str]) -- Optional load_id to filter by0A single component- ValueError -- If no components match or multiple components matchValueError

Get a single component by either:

• searching name (pattern matching), collection, or load_id.
• passing in a component_id Raises an error if multiple components match or none are found.

removediffusers.ComponentsManager.removehttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/components_manager.py#L467[{"name": "component_id", "val": ": str = None"}]- component_id (str) -- The ID of the component to remove0

Remove a component from the ComponentsManager.

remove_from_collectiondiffusers.ComponentsManager.remove_from_collectionhttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/components_manager.py#L449[{"name": "component_id", "val": ": str"}, {"name": "collection", "val": ": str"}]

Remove a component from a collection.

search_componentsdiffusers.ComponentsManager.search_componentshttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/components_manager.py#L500[{"name": "names", "val": ": typing.Optional[str] = None"}, {"name": "collection", "val": ": typing.Optional[str] = None"}, {"name": "load_id", "val": ": typing.Optional[str] = None"}, {"name": "return_dict_with_names", "val": ": bool = True"}]- names -- Component name(s) or pattern(s) Patterns:

• "unet" : match any component with base name "unet" (e.g., unet_123abc)
• "!unet" : everything except components with base name "unet"
• "unet*" : anything with base name starting with "unet"
• "!unet*" : anything with base name NOT starting with "unet"
• "unet" : anything with base name containing "unet"
• "!unet" : anything with base name NOT containing "unet"
• "refiner|vae|unet" : anything with base name exactly matching "refiner", "vae", or "unet"
• "!refiner|vae|unet" : anything with base name NOT exactly matching "refiner", "vae", or "unet"
• "unet*|vae*" : anything with base name starting with "unet" OR starting with "vae"
• collection -- Optional collection to filter by
• load_id -- Optional load_id to filter by
• return_dict_with_names -- If True, returns a dictionary with component names as keys, throw an error if multiple components with the same name are found If False, returns a dictionary with component IDs as keys0Dictionary mapping component names to components if return_dict_with_names=True, or a dictionary mapping component IDs to components if return_dict_with_names=False

Search components by name with simple pattern matching. Optionally filter by collection or load_id.

InsertableDict[[diffusers.modular_pipelines.InsertableDict]]

class diffusers.modular_pipelines.InsertableDictdiffusers.modular_pipelines.InsertableDicthttps://github.com/huggingface/diffusers/blob/vr_12595/src/diffusers/modular_pipelines/modular_pipeline_utils.py#L33""