Hugging Face's logo

Diffusers documentation

UNet2DConditionModel

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v0.42.1).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

UNet2DConditionModel

Mô hình UNet ban đầu được Ronneberger và cộng sự giới thiệu cho phân đoạn ảnh y sinh, nhưng nó cũng được sử dụng phổ biến trong 🤗 Diffusers vì nó tạo ra các ảnh có cùng kích thước với đầu vào. Đây là một trong những thành phần quan trọng nhất của một hệ thống khuếch tán vì nó hỗ trợ quá trình khuếch tán thực sự. Có một số biến thể của mô hình UNet trong 🤗 Diffusers, tùy thuộc vào số chiều của nó và việc nó có phải là mô hình có điều kiện hay không. Đây là một mô hình UNet có điều kiện 2D.

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

Có sự đồng thuận rộng rãi rằng việc huấn luyện thành công các mạng sâu đòi hỏi hàng nghìn mẫu huấn luyện đã được chú thích. Trong bài báo này, chúng tôi trình bày một kiến trúc mạng và chiến lược huấn luyện dựa vào việc sử dụng mạnh mẽ kỹ thuật tăng cường dữ liệu để khai thác hiệu quả hơn các mẫu đã được chú thích sẵn có. Kiến trúc bao gồm một đường co (contracting path) để nắm bắt ngữ cảnh và một đường mở rộng (expanding path) đối xứng cho phép định vị chính xác. Chúng tôi cho thấy rằng một mạng như vậy có thể được huấn luyện end-to-end từ rất ít hình ảnh và vượt trội hơn so với phương pháp tốt nhất trước đó (một mạng tích chập cửa sổ trượt) trong thử thách ISBI về phân đoạn các cấu trúc thần kinh trong các chồng ảnh hiển vi điện tử. Sử dụng cùng một mạng được huấn luyện trên các ảnh hiển vi ánh sáng truyền qua (tương phản pha và DIC), chúng tôi đã giành chiến thắng trong thử thách theo dõi tế bào ISBI 2015 ở các hạng mục này với khoảng cách lớn. Hơn nữa, mạng này hoạt động nhanh. Việc phân đoạn một ảnh 512x512 mất chưa đến một giây trên một GPU đời mới. Toàn bộ cài đặt (dựa trên Caffe) và các mạng đã được huấn luyện có sẵn tại http://lmb.informatik.uni-freiburg.de/people/ronneber/u-net.

UNet2DConditionModel

lớp diffusers.UNet2DConditionModel

< >

( sample_size: int | tuple[int, int] | None = Nonein_channels: int = 4out_channels: int = 4center_input_sample: bool = Falseflip_sin_to_cos: bool = Truefreq_shift: int = 0down_block_types: tuple = ('CrossAttnDownBlock2D', 'CrossAttnDownBlock2D', 'CrossAttnDownBlock2D', 'DownBlock2D')mid_block_type: str | None = 'UNetMidBlock2DCrossAttn'up_block_types: tuple = ('UpBlock2D', 'CrossAttnUpBlock2D', 'CrossAttnUpBlock2D', 'CrossAttnUpBlock2D')only_cross_attention: bool | tuple[bool] = Falseblock_out_channels: tuple = (320, 640, 1280, 1280)layers_per_block: int | tuple[int] = 2downsample_padding: int = 1mid_block_scale_factor: float = 1dropout: float = 0.0act_fn: str = 'silu'norm_num_groups: int | None = 32norm_eps: float = 1e-05cross_attention_dim: int | tuple[int] = 1280transformer_layers_per_block: int | tuple[int] | tuple[tuple] = 1reverse_transformer_layers_per_block: tuple[tuple[int]] | None = Noneencoder_hid_dim: int | None = Noneencoder_hid_dim_type: str | None = Noneattention_head_dim: int | tuple[int] = 8num_attention_heads: int | tuple[int] | None = Nonedual_cross_attention: bool = Falseuse_linear_projection: bool = Falseclass_embed_type: str | None = Noneaddition_embed_type: str | None = Noneaddition_time_embed_dim: int | None = Nonenum_class_embeds: int | None = Noneupcast_attention: bool = Falseresnet_time_scale_shift: str = 'default'resnet_skip_time_act: bool = Falseresnet_out_scale_factor: float = 1.0time_embedding_type: str = 'positional'time_embedding_dim: int | None = Nonetime_embedding_act_fn: str | None = Nonetimestep_post_act: str | None = Nonetime_cond_proj_dim: int | None = Noneconv_in_kernel: int = 3conv_out_kernel: int = 3projection_class_embeddings_input_dim: int | None = Noneattention_type: str = 'default'class_embeddings_concat: bool = Falsemid_block_only_cross_attention: bool | None = Nonecross_attention_norm: str | None = Noneaddition_embed_type_num_heads: int = 64 )

Tham số

  • sample_size (int hoặc tuple[int, int], tùy chọn, mặc định là None) — Chiều cao và chiều rộng của mẫu đầu vào/đầu ra.
  • in_channels (int, tùy chọn, mặc định là 4) — Số lượng kênh trong mẫu đầu vào.
  • out_channels (int, tùy chọn, mặc định là 4) — Số lượng kênh trong đầu ra.
  • center_input_sample (bool, tùy chọn, mặc định là False) — Có nên căn giữa mẫu đầu vào hay không.
  • flip_sin_to_cos (bool, tùy chọn, mặc định là True) — Có nên đảo sin thành cos trong time embedding hay không.
  • freq_shift (int, tùy chọn, mặc định là 0) — Độ dịch tần số cần áp dụng cho nhúng thời gian.
  • down_block_types (tuple[str], tùy chọn, mặc định là ("CrossAttnDownBlock2D", "CrossAttnDownBlock2D", "CrossAttnDownBlock2D", "DownBlock2D")) — Bộ tuple các khối hạ mẫu (downsample) cần sử dụng.
  • mid_block_type (str, tùy chọn, mặc định là "UNetMidBlock2DCrossAttn") — Loại block ở phần giữa của UNet, có thể là một trong UNetMidBlock2DCrossAttn, UNetMidBlock2D, hoặc UNetMidBlock2DSimpleCrossAttn. Nếu là None, lớp mid block sẽ bị bỏ qua.
  • up_block_types (tuple[str], tùy chọn, mặc định là ("UpBlock2D", "CrossAttnUpBlock2D", "CrossAttnUpBlock2D", "CrossAttnUpBlock2D")) — Bộ tuple các khối upsample cần sử dụng.
  • only_cross_attention(bool hoặc tuple[bool], tuỳ chọn, mặc định là False) — Có bao gồm self-attention trong các khối transformer cơ bản hay không, xem BasicTransformerBlock.
  • block_out_channels (tuple[int], tùy chọn, mặc định là (320, 640, 1280, 1280)) — Bộ tuple các kênh đầu ra cho mỗi khối.
  • layers_per_block (int, tùy chọn, mặc định là 2) — Số lượng lớp trong mỗi khối.
  • downsample_padding (int, tùy chọn, mặc định là 1) — Padding được sử dụng cho phép tích chập hạ mẫu.
  • mid_block_scale_factor (float, tùy chọn, mặc định là 1.0) — Hệ số tỷ lệ sử dụng cho khối giữa.
  • dropout (float, tùy chọn, mặc định là 0.0) — Xác suất dropout cần sử dụng.
  • act_fn (str, tùy chọn, mặc định là "silu") — Hàm kích hoạt cần sử dụng.
  • norm_num_groups (int, tùy chọn, mặc định là 32) — Số nhóm được sử dụng cho phép chuẩn hóa. Nếu None, các lớp chuẩn hóa và kích hoạt sẽ bị bỏ qua trong xử lý hậu kỳ.
  • norm_eps (float, tùy chọn, mặc định là 1e-5) — Epsilon được sử dụng cho phép chuẩn hóa.
  • cross_attention_dim (int hoặc tuple[int], tùy chọn, mặc định là 1280) — Kích thước của các đặc trưng chú ý chéo (cross attention).
  • transformer_layers_per_block (int, tuple[int], hoặc tuple[tuple] , tùy chọn, mặc định là 1) — Số lượng khối transformer có kiểu BasicTransformerBlock. Chỉ liên quan đến CrossAttnDownBlock2D, CrossAttnUpBlock2D, UNetMidBlock2DCrossAttn.
  • reverse_transformer_layers_per_block — (tuple[tuple], tùy chọn, mặc định là None): Số lượng khối transformer có kiểu BasicTransformerBlock, trong các khối upsampling của U-Net. Chỉ liên quan nếu transformer_layers_per_block có kiểu tuple[tuple] và đối với CrossAttnDownBlock2D, CrossAttnUpBlock2D, UNetMidBlock2DCrossAttn.
  • encoder_hid_dim (int, tùy chọn, mặc định là None) — Nếu encoder_hid_dim_type được định nghĩa, encoder_hidden_states sẽ được chiếu từ chiều encoder_hid_dim sang cross_attention_dim.
  • encoder_hid_dim_type (str, tùy chọn, mặc định là None) — Nếu được cung cấp, encoder_hidden_states và các embedding khác (nếu có) sẽ được down-project xuống text embeddings có chiều cross_attention theo encoder_hid_dim_type.
  • attention_head_dim (int, tùy chọn, mặc định là 8) — Kích thước của các đầu chú ý (attention heads).
  • num_attention_heads (int, tùy chọn) — Số lượng đầu chú ý. Nếu không được định nghĩa, mặc định là attention_head_dim
  • resnet_time_scale_shift (str, tùy chọn, mặc định là "default") — Cấu hình dịch chuyển thang thời gian cho các khối ResNet (xem ResnetBlock2D). Chọn từ default hoặc scale_shift.
  • class_embed_type (str, tùy chọn, mặc định là None) — Loại class embedding được sử dụng, cuối cùng sẽ được cộng với các time embeddings. Chọn từ None, "timestep", "identity", "projection" hoặc "simple_projection".
  • addition_embed_type (str, tùy chọn, mặc định là None) — Cấu hình một embedding tùy chọn sẽ được cộng với các time embeddings. Chọn từ None hoặc “text”. “text” sẽ sử dụng lớp TextTimeEmbedding.
  • addition_time_embed_dim — (int, tuỳ chọn, mặc định là None): Kích thước cho các embedding của bước thời gian.
  • num_class_embeds (int, tuỳ chọn, mặc định là None) — Kích thước đầu vào của ma trận nhúng có thể học được để chiếu sang time_embed_dim, khi thực hiện điều kiện theo lớp với class_embed_type bằng None.
  • time_embedding_type (str, tùy chọn, mặc định là positional) — Loại position embedding cần sử dụng cho timesteps. Chọn từ positional hoặc fourier.
  • time_embedding_dim (int, tuỳ chọn, mặc định là None) — Một giá trị ghi đè tuỳ chọn cho chiều của time embedding đã được chiếu.
  • time_embedding_act_fn (str, tùy chọn, mặc định là None) — Hàm kích hoạt tùy chọn chỉ được sử dụng một lần trên các embedding thời gian trước khi chúng được truyền đến phần còn lại của UNet. Chọn từ silu, mish, gelu và swish.
  • timestep_post_act (str, tùy chọn, mặc định là None) — Hàm kích hoạt thứ hai được sử dụng trong nhúng bước thời gian. Chọn từ silu, mish và gelu.
  • time_cond_proj_dim (int, tùy chọn, mặc định là None) — Kích thước của lớp cond_proj trong phần nhúng bước thời gian (timestep embedding).
  • conv_in_kernel (int, tùy chọn, mặc định là 3) — Kích thước kernel của lớp conv_in.
  • conv_out_kernel (int, tùy chọn, mặc định là 3) — Kích thước kernel của lớp conv_out.
  • projection_class_embeddings_input_dim (int, tuỳ chọn) — Kích thước của đầu vào class_labels khi class_embed_type="projection". Bắt buộc khi class_embed_type="projection".
  • class_embeddings_concat (bool, tùy chọn, mặc định là False) — Có nối các embedding thời gian với các embedding lớp hay không.
  • mid_block_only_cross_attention (bool, tùy chọn, mặc định là None) — Có sử dụng cross attention với mid block khi dùng UNetMidBlock2DSimpleCrossAttn hay không. Nếu only_cross_attention được truyền dưới dạng một giá trị boolean duy nhất và mid_block_only_cross_attention là None, thì giá trị của only_cross_attention sẽ được dùng làm giá trị cho mid_block_only_cross_attention. Mặc định là False trong các trường hợp còn lại.

Một mô hình 2D UNet có điều kiện, nhận vào một mẫu nhiễu, trạng thái điều kiện và một bước thời gian, sau đó trả về một đầu ra có hình dạng của mẫu.

Mô hình này kế thừa từ ModelMixin. Hãy xem tài liệu của lớp cha để biết các phương thức chung được triển khai cho tất cả các mô hình (chẳng hạn như tải xuống hoặc lưu trữ).

disable_freeu

< >

( )

Tắt cơ chế FreeU.

enable_freeu

< >

( s1: floats2: floatb1: floatb2: float )

Tham số

  • s1 (float) — Hệ số tỷ lệ cho giai đoạn 1 để làm suy giảm đóng góp của các đặc trưng skip. Việc này được thực hiện để giảm thiểu “hiệu ứng làm mịn quá mức” trong quá trình khử nhiễu được tăng cường.
  • s2 (float) — Hệ số tỷ lệ cho giai đoạn 2 để làm suy giảm đóng góp của các đặc trưng skip. Việc này được thực hiện để giảm thiểu “hiệu ứng làm mịn quá mức” trong quá trình khử nhiễu được tăng cường.
  • b1 (float) — Hệ số tỷ lệ cho giai đoạn 1 để khuếch đại đóng góp của các đặc trưng backbone.
  • b2 (float) — Hệ số tỷ lệ cho giai đoạn 2 để khuếch đại đóng góp của các đặc trưng backbone.

Bật cơ chế FreeU từ https://huggingface.co/papers/2309.11497.

Các hậu tố sau các hệ số tỷ lệ đại diện cho các khối giai đoạn mà chúng được áp dụng.

Vui lòng tham khảo kho mã nguồn chính thức để biết các tổ hợp giá trị được biết là hoạt động tốt cho các pipeline khác nhau như Stable Diffusion v1, v2 và Stable Diffusion XL.

forward

< >

( sample: Tensortimestep: typing.Union[torch.Tensor, float, int]encoder_hidden_states: Tensorclass_labels: typing.Optional[torch.Tensor] = Nonetimestep_cond: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonecross_attention_kwargs: dict[str, typing.Any] | None = Noneadded_cond_kwargs: dict[str, torch.Tensor] | None = Nonedown_block_additional_residuals: tuple[torch.Tensor] | None = Nonemid_block_additional_residual: typing.Optional[torch.Tensor] = Nonedown_intrablock_additional_residuals: tuple[torch.Tensor] | None = Noneencoder_attention_mask: typing.Optional[torch.Tensor] = Nonereturn_dict: bool = True ) → UNet2DConditionOutput or tuple

Tham số

  • sample (torch.Tensor) — Tensor đầu vào có nhiễu với hình dạng (batch, channel, height, width).
  • timestep (torch.Tensor hoặc float hoặc int) — Số lượng bước thời gian để khử nhiễu một đầu vào.
  • encoder_hidden_states (torch.Tensor) — Trạng thái ẩn của bộ mã hóa với hình dạng (batch, sequence_length, feature_dim).
  • class_labels (torch.Tensor, tùy chọn, mặc định là None) — Nhãn lớp tùy chọn để điều kiện. Các embedding của chúng sẽ được cộng với các embedding của bước thời gian (timestep).
  • timestep_cond — (torch.Tensor, tùy chọn, mặc định là None): Các embedding điều kiện cho timestep. Nếu được cung cấp, các embedding này sẽ được cộng với các mẫu được truyền qua lớp self.time_embedding để thu được các embedding timestep.
  • attention_mask (torch.Tensor, tùy chọn, mặc định là None) — Một attention mask có shape (batch, key_tokens) được áp dụng cho encoder_hidden_states. Nếu là 1, mask được giữ lại, ngược lại nếu là 0, nó sẽ bị loại bỏ. Mask sẽ được chuyển đổi thành một bias, thêm các giá trị âm lớn vào các điểm chú ý tương ứng với các token “bị loại bỏ”.
  • cross_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.
  • added_cond_kwargs — (dict, tùy chọn): Một từ điển kwargs chứa các embedding bổ sung, nếu được chỉ định, sẽ được thêm vào các embedding được truyền đến các khối UNet.
  • down_block_additional_residuals — (tuple của torch.Tensor, optional): Một tuple các tensor mà nếu được chỉ định sẽ được cộng vào các residual của các khối down unet.
  • mid_block_additional_residual — (torch.Tensor, tùy chọn): Một tensor, nếu được chỉ định, sẽ được cộng vào phần dư (residual) của khối unet ở giữa.
  • down_intrablock_additional_residuals (tuple của torch.Tensor, tuỳ chọn) — các residual bổ sung cần được thêm vào bên trong các khối down của UNet, ví dụ từ các mô hình phụ T2I-Adapter
  • encoder_attention_mask (torch.Tensor) — Một mask cross-attention có shape (batch, sequence_length) được áp dụng cho encoder_hidden_states. Nếu True, mask được giữ lại, ngược lại nếu False, nó sẽ bị loại bỏ. Mask sẽ được chuyển thành một bias, thêm các giá trị âm lớn vào các điểm chú ý (attention scores) tương ứng với các token “bị loại bỏ”.
  • return_dict (bool, tùy chọn, mặc định là True) — Có nên trả về một UNet2DConditionOutput thay vì một tuple thông thường hay không.

Trả về

UNet2DConditionOutput hoặc tuple

Nếu return_dict là True, một UNet2DConditionOutput sẽ được trả về, ngoài ra một tuple sẽ được trả về trong đó phần tử đầu tiên là tensor mẫu.

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

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.

set_attention_slice

< >

( slice_size: str | int | list[int] = 'auto' )

Tham số

  • slice_size (str hoặc int hoặc list(int), tùy chọn, mặc định là "auto") — Khi là "auto", đầu vào của các attention head được chia đôi, do đó attention được tính toán trong hai bước. Nếu là "max", lượng bộ nhớ được tiết kiệm tối đa bằng cách chỉ chạy một slice tại một thời điểm. Nếu cung cấp một số, số lượng slice được sử dụng bằng attention_head_dim // slice_size. Trong trường hợp này, attention_head_dim phải là bội số của slice_size.

Bật tính toán chú ý dạng lát cắt.

Khi tùy chọn này được bật, module attention sẽ chia tensor đầu vào thành các lát để tính toán attention qua nhiều bước. Điều này hữu ích để tiết kiệm một phần bộ nhớ, đổi lại là sự giảm tốc độ nhỏ.

set_default_attn_processor

< >

( )

Tắt các bộ xử lý chú ý tùy chỉnh và đặt cài đặt chú ý mặc định.

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.

UNet2DConditionOutput

lớp diffusers.models.unets.unet_2d_condition.UNet2DConditionOutput

< >

( sample: Tensor = None )

Tham số

  • sample (torch.Tensor có hình dạng (batch_size, num_channels, height, width)) — Trạng thái ẩn đầu ra được điều kiện bởi đầu vào encoder_hidden_states. Đầu ra của lớp cuối cùng của mô hình.

Đầu ra của UNet2DConditionModel.

Update on GitHub

←UNet1DModel UNet2DModel→