# UNet3DConditionModel

تم تقديم نموذج [UNet](https://huggingface.co/papers/1505.04597) في الأصل بواسطة Ronneberger et al. لتجزئة الصور الطبية الحيوية، لكنه يُستخدم أيضاً بشكل شائع في 🤗 Diffusers لأنه يُخرج صوراً بنفس حجم المدخلات. وهو أحد أهم مكونات نظام الانتشار لأنه يسهّل عملية الانتشار الفعلية. توجد عدة متغيرات لنموذج UNet في 🤗 Diffusers، اعتماداً على عدد أبعاده وعلى ما إذا كان نموذجاً شرطياً أم لا. هذا نموذج UNet شرطي ثلاثي الأبعاد.

ملخص الورقة البحثية هو:

*يوجد إجماع واسع على أن التدريب الناجح للشبكات العميقة يتطلب آلاف الأمثلة التدريبية الموسومة. في هذه الورقة، نقدم شبكة واستراتيجية تدريب تعتمدان على الاستخدام القوي لزيادة البيانات لاستخدام الأمثلة الموسومة المتاحة بكفاءة أكبر. تتكون البنية من مسار انكماشي لالتقاط السياق ومسار متوسع متماثل يمكّن من تحديد دقيق للمواقع. نُظهر أن مثل هذه الشبكة يمكن تدريبها من البداية إلى النهاية من عدد قليل جداً من الصور، وتتفوق على أفضل طريقة سابقة (شبكة تلافيفية بنافذة منزلقة) في تحدي ISBI لتجزئة الهياكل العصبية في المكدسات المجهرية الإلكترونية. وباستخدام نفس الشبكة المدرَّبة على صور المجهر الضوئي المنقول (تباين الطور وDIC)، فزنا بتحدي ISBI لتتبع الخلايا 2015 في هذه الفئات بفارق كبير. علاوة على ذلك، الشبكة سريعة. تستغرق تجزئة صورة 512x512 أقل من ثانية على وحدة معالجة رسومية حديثة. تتوفر التنفيذ الكامل (المبني على Caffe) والشبكات المدرَّبة على http://lmb.informatik.uni-freiburg.de/people/ronneber/u-net.*

## UNet3DConditionModel[[diffusers.UNet3DConditionModel]]

#### diffusers.UNet3DConditionModel[[diffusers.UNet3DConditionModel]]

```python
diffusers.UNet3DConditionModel(sample_size: int | None = None, in_channels: int = 4, out_channels: int = 4, down_block_types: tuple[str, ...] = ('CrossAttnDownBlock3D', 'CrossAttnDownBlock3D', 'CrossAttnDownBlock3D', 'DownBlock3D'), up_block_types: tuple[str, ...] = ('UpBlock3D', 'CrossAttnUpBlock3D', 'CrossAttnUpBlock3D', 'CrossAttnUpBlock3D'), block_out_channels: tuple[int, ...] = (320, 640, 1280, 1280), layers_per_block: int = 2, downsample_padding: int = 1, mid_block_scale_factor: float = 1, act_fn: str = 'silu', norm_num_groups: int | None = 32, norm_eps: float = 1e-05, cross_attention_dim: int = 1024, attention_head_dim: int | tuple[int] = 64, num_attention_heads: int | tuple[int] | None = None, time_cond_proj_dim: int | None = None)
```

[المصدر](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/unets/unet_3d_condition.py#L62)

**المعاملات:**

sample_size (`int` أو `tuple[int, int]`، *اختياري*، القيمة الافتراضية `None`) : ارتفاع وعينة الإدخال/الإخراج.

in_channels (`int`، *اختياري*، القيمة الافتراضية 4) : عدد القنوات في العينة المدخلة.

out_channels (`int`، *اختياري*، القيمة الافتراضية 4) : عدد القنوات في المخرجات.

down_block_types (`tuple[str]`، *اختياري*، القيمة الافتراضية `("CrossAttnDownBlock3D", "CrossAttnDownBlock3D", "CrossAttnDownBlock3D", "DownBlock3D")`) : مجموعة (tuple) من كتل التصفية (downsample blocks) التي سيتم استخدامها.

up_block_types (`tuple[str]`، *اختياري*، القيمة الافتراضية `("UpBlock3D", "CrossAttnUpBlock3D", "CrossAttnUpBlock3D", "CrossAttnUpBlock3D")`) : مجموعة (tuple) من كتل التوسيع (upsample blocks) التي سيتم استخدامها.

block_out_channels (`tuple[int]`، *اختياري*، القيمة الافتراضية هي `(320, 640, 1280, 1280)`) : مجموعة من القيم تمثل عدد قنوات الإخراج لكل كتلة.

layers_per_block (`int`، *اختياري*، القيمة الافتراضية 2) : عدد الطبقات في كل كتلة.

downsample_padding (`int`، *اختياري*، القيمة الافتراضية 1) : الحشو المستخدم لفولتير التجميع (downsampling convolution).

mid_block_scale_factor (`float`، *اختياري*، القيمة الافتراضية 1.0) : معامل المقياس المستخدم للكتلة الوسطى.

act_fn (`str`، *اختياري*، القيمة الافتراضية `"silu"`) : دالة التنشيط المستخدمة.

norm_num_groups (`int`، *اختياري*، القيمة الافتراضية 32) : عدد المجموعات المستخدمة للتطبيع. إذا كانت `None`، يتم تجاوز طبقات التطبيع والتفعيل في المعالجة اللاحقة.

norm_eps (`float`، *اختياري*، القيمة الافتراضية 1e-5) : قيمة الإيبسلون المستخدمة في عملية التطبيع.

cross_attention_dim (`int`، *اختياري*، القيمة الافتراضية 1024) : بُعد ميزات الانتباه المتقاطع.

attention_head_dim (`int`، *اختياري*، القيمة الافتراضية 64) : بُعد رؤوس الانتباه.

num_attention_heads (`int`، *اختياري*) : عدد رؤوس الانتباه.

time_cond_proj_dim (`int`، *اختياري*، القيمة الافتراضية `None`) : بُعد طبقة `cond_proj` في تضمين خطوة الزمن.

نموذج UNet ثلاثي الأبعاد مشروط يستقبل عينة ضجيجية وحالة شرطية وخطوة زمنية ويعيد إخراجًا على شكل العينة.

يرث هذا النموذج من [ModelMixin](/docs/diffusers/v0.43.0/ar/api/models/overview#diffusers.ModelMixin). راجع توثيق الفئة الأصلية لمعرفة طرقه العامة المُنفَّذة لجميع النماذج (مثل التنزيل أو الحفظ).

#### disable_freeu[[diffusers.UNet3DConditionModel.disable_freeu]]

```python
disable_freeu()
```

[المصدر](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/unets/unet_3d_condition.py#L437)

يعطّل آلية FreeU.

#### enable_forward_chunking[[diffusers.UNet3DConditionModel.enable_forward_chunking]]

```python
enable_forward_chunking(chunk_size: int | None = None, dim: int = 0)
```

[المصدر](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/unets/unet_3d_condition.py#L355)

**المعاملات:**

chunk_size (`int`, *اختياري*) : حجم الدفعة (chunk size) لطبقات التغذية الأمامية. إذا لم يُحدد، فسيتم تشغيل طبقة التغذية الأمامية بشكل فردي على كل متجه (tensor) ذي بُعد `dim`.

dim (`int`، *اختياري*، القيمة الافتراضية `0`) : البُعد الذي يجب تقسيم عملية الحساب الأمامي (feed-forward) عليه. اختر بين dim=0 (الحزمة) أو dim=1 (طول التسلسل).

يحدد معالج الانتباه لاستخدام [تقطيع الأمامي](https://huggingface.co/blog/reformer#2-chunked-feed-forward-layers).

#### enable_freeu[[diffusers.UNet3DConditionModel.enable_freeu]]

```python
enable_freeu(s1, s2, b1, b2)
```

[المصدر](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/unets/unet_3d_condition.py#L412)

**المعاملات:**

s1 (`float`) : عامل التدرّج للمرحلة 1 لتخفيف مساهمات ميزات التخطي. يتم ذلك للتخفيف من "تأثير الإفراط في التنعيم" في عملية إزالة الضوضاء المعزّزة.

s2 (`float`) : معامل التوسيع للمرحلة 2 لتخفيف مساهمات الميزات المتجاوزة. يتم ذلك للتخفيف من "تأثير الإفراط في التنعيم" في عملية إزالة الضوضاء المعززة.

b1 (`float`) : معامل التوسيع للمرحلة 1 لتضخيم مساهمات ميزات الهيكل الأساسي.

b2 (`float`) : معامل التوسيع للمرحلة 2 لتضخيم مساهمات ميزات الهيكل الأساسي.

يتيح آلية FreeU من https://huggingface.co/papers/2309.11497.

تمثل البادئات التي تلي معاملات التوسيع كتل المراحل التي تُطبَّق فيها.

يرجى الرجوع إلى [المستودع الرسمي](https://github.com/ChenyangSi/FreeU) للاطلاع على مجموعات القيم التي يُعرف أنها تعمل بشكل جيد لأنابيب مختلفة مثل Stable Diffusion v1 وv2 وStable Diffusion XL.

#### forward[[diffusers.UNet3DConditionModel.forward]]

```python
forward(sample: Tensor, timestep: typing.Union[torch.Tensor, float, int], encoder_hidden_states: Tensor, class_labels: typing.Optional[torch.Tensor] = None, timestep_cond: typing.Optional[torch.Tensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, cross_attention_kwargs: dict[str, typing.Any] | None = None, down_block_additional_residuals: tuple[torch.Tensor] | None = None, mid_block_additional_residual: typing.Optional[torch.Tensor] = None, return_dict: bool = True)
```

[المصدر](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/unets/unet_3d_condition.py#L477)

**المعاملات:**

sample (`torch.Tensor`) : المصفوفة المدخلة الضوضائية ذات الشكل التالي `(batch, num_channels, num_frames, height, width`.

timestep (`torch.Tensor` أو `float` أو `int`) : عدد خطوات الزمن لإزالة الضوضاء من مدخل.

encoder_hidden_states (`torch.Tensor`) : حالات المُشفِّر المخفية (encoder hidden states) ذات الشكل `(batch, sequence_length, feature_dim)`.

class_labels (`torch.Tensor`، *اختياري*، القيمة الافتراضية `None`) : تسميات فئات اختيارية للتكييف. سيتم جمع تمثيلاتها مع تمثيلات خطوة الزمن.

timestep_cond : (`torch.Tensor`, *اختياري*، القيمة الافتراضية `None`): تضمينات شرطية لخطوة الزمن. إذا تم توفيرها، سيتم جمع التضمينات مع العينات المارة عبر طبقة `self.time_embedding` للحصول على تضمينات خطوة الزمن.

attention_mask (`torch.Tensor`، *اختياري*، القيمة الافتراضية `None`) : يُطبَّق قناع انتباه (attention mask) على شكل `(batch, key_tokens)` على `encoder_hidden_states`. إذا كانت القيمة `1` يُحافظ على القناع، وإلا إذا كانت `0` يُستبعد. يُحوَّل القناع إلى انحياز (bias) يضيف قيمًا سالبة كبيرة إلى درجات الانتباه المقابلة لرموز "الاستبعاد".

cross_attention_kwargs (`dict`، *اختياري*) : قاموس kwargs يُمرَّر إلى `AttentionProcessor` إذا تم تحديده، كما هو معرَّف تحت `self.processor` في [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).

down_block_additional_residuals : (`tuple` من `torch.Tensor`، *اختياري*): مجموعة من الموترات التي إذا تم تحديدها تُضاف إلى بقايا كتل down unet.

mid_block_additional_residual : (`torch.Tensor`, *اختياري*): متجه يُضاف إلى الباقي (residual) في كتلة unet الوسطى إذا تم تحديده.

return_dict (`bool`، *اختياري*، القيمة الافتراضية `True`) : ما إذا كان يجب إرجاع [UNet3DConditionOutput](/docs/diffusers/v0.43.0/ar/api/models/unet-motion#diffusers.models.unets.unet_3d_condition.UNet3DConditionOutput) بدلاً من tuple عادي.

cross_attention_kwargs (`dict`، *اختياري*) : قاموس kwargs يُمرَّر إلى `AttnProcessor` إذا تم تحديده.

**يعيد:** [UNet3DConditionOutput](/docs/diffusers/v0.43.0/ar/api/models/unet-motion#diffusers.models.unets.unet_3d_condition.UNet3DConditionOutput) أو `tuple`

إذا كان `return_dict` صحيحًا، يُعاد [UNet3DConditionOutput](/docs/diffusers/v0.43.0/ar/api/models/unet-motion#diffusers.models.unets.unet_3d_condition.UNet3DConditionOutput)، وإلا يُعاد `tuple` يكون عنصره الأول هو متجه العينة.

طريقة [UNet3DConditionModel](/docs/diffusers/v0.43.0/ar/api/models/unet3d-cond#diffusers.UNet3DConditionModel) الأمامية.

#### fuse_qkv_projections[[diffusers.UNet3DConditionModel.fuse_qkv_projections]]

```python
fuse_qkv_projections()
```

[المصدر](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/unets/unet_3d_condition.py#L446)

…

> [!WARNING] > هذه الواجهة البرمجية 🧪 تجريبية.

#### set_attention_slice[[diffusers.UNet3DConditionModel.set_attention_slice]]

```python
set_attention_slice(slice_size: str | int | list[int])
```

[المصدر](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/unets/unet_3d_condition.py#L290)

**المعاملات:**

slice_size (`str` أو `int` أو `list(int)`، *اختياري*، القيمة الافتراضية `"auto"`) : عند تعيين `"auto"`، يُنصَّف مدخل رؤوس الانتباه، فيُحسب الانتباه على خطوتين. أما عند تعيين `"max"`، فيُوفَّر الحد الأقصى من الذاكرة عبر تشغيل شريحة واحدة في كل مرة. وإذا تم تقديم رقم، فسيتم استخدام عدد من الشرائح يساوي `attention_head_dim // slice_size`. في هذه الحالة، يجب أن يكون `attention_head_dim` مضاعفًا لـ `slice_size`.

تفعيل حساب الانتباه المقطّع.

عند تمكين هذا الخيار، يقسم وحدة الانتباه (attention module) المصفوفة المدخلة إلى شرائح لحساب الانتباه على عدة خطوات. وهذا مفيد لتوفير بعض الذاكرة مقابل انخفاض طفيف في السرعة.

#### set_default_attn_processor[[diffusers.UNet3DConditionModel.set_default_attn_processor]]

```python
set_default_attn_processor()
```

[المصدر](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/unets/unet_3d_condition.py#L396)

يعطّل معالجات الانتباه المخصصة ويضبط تطبيق الانتباه الافتراضي.

#### unfuse_qkv_projections[[diffusers.UNet3DConditionModel.unfuse_qkv_projections]]

```python
unfuse_qkv_projections()
```

[المصدر](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/unets/unet_3d_condition.py#L468)

يعطّل إسقاط QKV المدمج إذا كان مفعّلًا.

> [!WARNING] > هذه الواجهة البرمجية 🧪 تجريبية.

## UNet3DConditionOutput[[diffusers.models.unets.unet_3d_condition.UNet3DConditionOutput]]

#### diffusers.models.unets.unet_3d_condition.UNet3DConditionOutput[[diffusers.models.unets.unet_3d_condition.UNet3DConditionOutput]]

```python
diffusers.models.unets.unet_3d_condition.UNet3DConditionOutput(sample: Tensor)
```

[المصدر](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/unets/unet_3d_condition.py#L50)

**المعاملات:**

sample (`torch.Tensor` من الشكل `(batch_size, num_channels, num_frames, height, width)`) : مخرجات الحالات المخفية المشروطة على مدخل `encoder_hidden_states`. مخرجات الطبقة الأخيرة من النموذج.

مخرجات [UNet3DConditionModel](/docs/diffusers/v0.43.0/ar/api/models/unet3d-cond#diffusers.UNet3DConditionModel).