Diffusers documentation

SD3ControlNetModel

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

SD3ControlNetModel

SD3ControlNetModel là một triển khai của ControlNet cho Stable Diffusion 3.

Mô hình ControlNet được giới thiệu trong Adding Conditional Control to Text-to-Image Diffusion Models bởi Lvmin Zhang, Anyi Rao, Maneesh Agrawala. Nó cung cấp mức độ kiểm soát cao hơn đối với việc tạo ảnh từ văn bản bằng cách điều kiện hóa mô hình dựa trên các đầu vào bổ sung như bản đồ cạnh, bản đồ độ sâu, bản đồ phân đoạn và các điểm chính cho phát hiện tư thế.

Tóm tắt từ bài báo là:

Chúng tôi giới thiệu ControlNet, một kiến trúc mạng nơ-ron để thêm các điều khiển điều kiện không gian vào các mô hình khuếch tán từ văn bản sang ảnh lớn, được huấn luyện trước. ControlNet khóa các mô hình khuếch tán lớn sẵn sàng cho sản xuất, và tái sử dụng các lớp mã hóa sâu và mạnh mẽ của chúng, được huấn luyện trước với hàng tỷ hình ảnh, làm một khung xương mạnh mẽ để học một tập hợp đa dạng các điều khiển có điều kiện. Kiến trúc mạng nơ-ron được kết nối bằng các “cuộn không” (các lớp tích chập khởi tạo bằng không) giúp tăng dần các tham số từ không và đảm bảo rằng không có nhiễu có hại nào có thể ảnh hưởng đến việc tinh chỉnh. Chúng tôi kiểm tra các điều khiển điều kiện khác nhau, ví dụ như cạnh, độ sâu, phân đoạn, tư thế con người, v.v., với Stable Diffusion, sử dụng một hoặc nhiều điều kiện, có hoặc không có lời nhắc. Chúng tôi cho thấy rằng việc huấn luyện ControlNet là mạnh mẽ với các bộ dữ liệu nhỏ (<50k) và lớn (>1m). Các kết quả mở rộng cho thấy ControlNet có thể thúc đẩy các ứng dụng rộng hơn để kiểm soát các mô hình khuếch tán ảnh.

Tải từ định dạng gốc

Mặc định, SD3ControlNetModel nên được tải bằng from_pretrained().

from diffusers import StableDiffusion3ControlNetPipeline
from diffusers.models import SD3ControlNetModel, SD3MultiControlNetModel

controlnet = SD3ControlNetModel.from_pretrained("InstantX/SD3-Controlnet-Canny")
pipe = StableDiffusion3ControlNetPipeline.from_pretrained("stabilityai/stable-diffusion-3-medium-diffusers", controlnet=controlnet)

SD3ControlNetModel

lớp diffusers.SD3ControlNetModel

< >

( sample_size: int = 128patch_size: int = 2in_channels: int = 16num_layers: int = 18attention_head_dim: int = 64num_attention_heads: int = 18joint_attention_dim: int = 4096caption_projection_dim: int = 1152pooled_projection_dim: int = 2048out_channels: int = 16pos_embed_max_size: int = 96extra_conditioning_channels: int = 0dual_attention_layers: tuple[int, ...] = ()qk_norm: str | None = Nonepos_embed_type: str | None = 'sincos'use_pos_embed: bool = Trueforce_zeros_for_pooled_projection: bool = True )

Tham số

  • sample_size (int, mặc định là 128) — Chiều rộng/chiều cao của các latents. Giá trị này được cố định trong quá trình huấn luyện vì nó được dùng để học một số lượng các position embeddings.
  • patch_size (int, mặc định là 2) — Kích thước patch để chuyển dữ liệu đầu vào thành các patch nhỏ.
  • in_channels (int, mặc định là 16) — Số lượng kênh tiềm ẩn trong đầu vào.
  • num_layers (int, mặc định là 18) — Số lượng lớp của các khối transformer cần sử dụng.
  • attention_head_dim (int, mặc định là 64) — Số lượng kênh trong mỗi head.
  • num_attention_heads (int, mặc định là 18) — Số lượng đầu (heads) được sử dụng cho cơ chế chú ý đa đầu (multi-head attention).
  • joint_attention_dim (int, mặc định là 4096) — Kích thước embedding để sử dụng cho chú ý kết hợp văn bản-hình ảnh.
  • caption_projection_dim (int, mặc định là 1152) — Kích thước embedding của các embedding caption.
  • pooled_projection_dim (int, mặc định là 2048) — Kích thước embedding của các phép chiếu văn bản đã gộp (pooled).
  • out_channels (int, mặc định là 16) — Số lượng kênh tiềm ẩn trong đầu ra.
  • pos_embed_max_size (int, mặc định là 96) — Chiều cao/chiều rộng tiềm ẩn tối đa của nhúng vị trí.
  • extra_conditioning_channels (int, mặc định là 0) — Số lượng kênh bổ sung được sử dụng cho điều kiện (conditioning) trong patch embedding.
  • dual_attention_layers (tuple[int, ...], mặc định là ()) — Số lượng khối transformer luồng kép (dual-stream) cần sử dụng.
  • qk_norm (str, tùy chọn, mặc định là None) — Phương pháp chuẩn hóa được sử dụng cho query và key trong lớp attention. Nếu là None, sẽ không sử dụng chuẩn hóa.
  • pos_embed_type (str, mặc định là "sincos") — Loại positional embedding cần sử dụng. Chọn giữa "sincos" và None.
  • use_pos_embed (bool, mặc định là True) — Có sử dụng nhúng vị trí hay không.
  • force_zeros_for_pooled_projection (bool, mặc định là True) — Có nên ép giá trị bằng 0 cho các embedding của pooled projection hay không. Điều này được xử lý trong các pipeline bằng cách đọc giá trị config của mô hình ControlNet.

Mô hình ControlNet cho Stable Diffusion 3.

enable_forward_chunking

< >

( chunk_size: int | None = Nonedim: int = 0 )

Tham số

  • chunk_size (int, tùy chọn) — Kích thước chunk của các lớp feed-forward. Nếu không được chỉ định, lớp feed-forward sẽ được chạy riêng lẻ trên mỗi tensor có dim=dim.
  • dim (int, tùy chọn, mặc định là 0) — Chiều mà phép tính feed-forward nên được chia nhỏ. Chọn giữa dim=0 (batch) hoặc dim=1 (chiều dài chuỗi).

Đặt bộ xử lý chú ý để sử dụng chia nhỏ feed forward.

forward

< >

( hidden_states: Tensorcontrolnet_cond: Tensorconditioning_scale: float = 1.0encoder_hidden_states: Tensor = Nonepooled_projections: Tensor = Nonetimestep: LongTensor = Nonejoint_attention_kwargs: dict[str, typing.Any] | None = Nonereturn_dict: bool = True )

Tham số

  • hidden_states (torch.Tensor có hình dạng (batch size, channel, height, width)) — hidden_states đầu vào.
  • controlnet_cond (torch.Tensor) — Tensor đầu vào có điều kiện với hình dạng (batch_size, sequence_length, hidden_size).
  • conditioning_scale (float, mặc định là 1.0) — Hệ số tỷ lệ cho đầu ra của ControlNet.
  • encoder_hidden_states (torch.Tensor có hình dạng (batch size, sequence_len, embed_dims)) — Các embedding điều kiện (các embedding được tính toán từ các điều kiện đầu vào như prompts) cần sử dụng.
  • pooled_projections (torch.Tensor có hình dạng (batch_size, projection_dim)) — Các embedding được chiếu từ các embedding của điều kiện đầu vào.
  • timestep ( torch.LongTensor) — Dùng để chỉ bước khử nhiễu.
  • joint_attention_kwargs (dict, tùy chọn) — Một từ điển kwargs, nếu được chỉ định, sẽ được truyền đến AttentionProcessor như đã định nghĩa dưới self.processor trong diffusers.models.attention_processor.
  • return_dict (bool, tùy chọn, mặc định là True) — Có nên trả về một ~models.transformer_2d.Transformer2DModelOutput thay vì một tuple thông thường hay không.

Phương thức forward của SD3Transformer2DModel.

fuse_qkv_projections

< >

( )

Bật các phép chiếu QKV đã hợp nhất. Đối với các module tự chú ý, tất cả các ma trận chiếu (tức là truy vấn, khóa, giá trị) đều được hợp nhất. Đối với các module chú ý chéo, các ma trận chiếu khóa và giá trị được hợp nhất.

> API này 🧪 mang tính thử nghiệm.

unfuse_qkv_projections

< >

( )

Tắt dự phóng QKV hợp nhất nếu đã được bật.

> API này 🧪 mang tính thử nghiệm.

SD3ControlNetOutput

lớp diffusers.models.controlnets.SD3ControlNetOutput

< >

( controlnet_block_samples: tuple[torch.Tensor] )

Update on GitHub