# WavTokenizer

## نظرة عامة

يقوم [WavTokenizer](https://huggingface.co/papers/2408.16532) بتشفير الصوت أحادي القناة بمعدل 24 كيلو هرتز إلى رموز منفصلة باستخدام دفتر رموز واحد، بمعدل 40 أو 75 رمزًا في الثانية اعتمادًا على نقطة الفحص. كما يمكنه إعادة بناء الصوت من تلك الرموز.

تدعم هذه النسخة الاستدلال باستخدام [WavTokenizerModel](/docs/transformers/main/ar/model_doc/wavtokenizer#transformers.WavTokenizerModel) للتشفير وفك التشفير، أو [WavTokenizerEncoderModel](/docs/transformers/main/ar/model_doc/wavtokenizer#transformers.WavTokenizerEncoderModel) للتشفير فقط. يوفر المتغير الذي يحتوي على 40 رمزًا في الثانية مرمّز الصوت لـ [Apertus 1.5](./apertus1p5). لا يُدعم تدريب المرمّز.

تمت مساهمة هذا النموذج من قبل [المبادرة السويسرية للذكاء الاصطناعي](https://huggingface.co/swiss-ai). تتوفر النسخة الأصلية على [GitHub](https://github.com/jishengpeng/WavTokenizer).

## نقاط التفتيش المتاحة

هذه النقاط الفاصلة جاهزة للتحميل باستخدام `from_pretrained`:

| نقطة التفتيش | المجال | رموز في الثانية |
|---|---|---:|
| [صغير، 40 رمزًا/ثانية](https://huggingface.co/swiss-ai/wavtokenizer-small-speech-40token) | الخطاب | 40 |
| [صغير، 75 رمزًا/ثانية](https://huggingface.co/swiss-ai/wavtokenizer-small-speech-75token) | الخطاب | 75 |
| [متوسط](https://huggingface.co/swiss-ai/wavtokenizer-medium-speech-75token) | الخطاب | 75 |
| [متوسط v2](https://huggingface.co/swiss-ai/wavtokenizer-medium-speech-75token-v2) | الخطاب | 75 |
| [متوسط](https://huggingface.co/swiss-ai/wavtokenizer-medium-music-audio-75token) | الموسيقى/الصوت | 75 |
| [متوسط v2](https://huggingface.co/swiss-ai/wavtokenizer-medium-music-audio-75token-v2) | الموسيقى/الصوت | 75 |
| [موحّد كبير](https://huggingface.co/swiss-ai/wavtokenizer-large-unify-40token) | مُوحَّد | 40 |
| [Large v2](https://huggingface.co/swiss-ai/wavtokenizer-large-speech-75token-v2) | الخطاب | 75 |

## مثال على الاستخدام

حمّل مقطعًا صوتيًا، وأعدّ عيّنته إلى معدل العينة الخاص بالنقطة المرجعية، ثم شفّره وأعدّ بناءه:

```python
import torch
from transformers import AutoFeatureExtractor, WavTokenizerModel
from transformers.audio_utils import load_audio

model_id = "swiss-ai/wavtokenizer-large-unify-40token"
model = WavTokenizerModel.from_pretrained(model_id)
feature_extractor = AutoFeatureExtractor.from_pretrained(model_id)

audio = load_audio(
    "https://huggingface.co/datasets/hf-internal-testing/dummy-audio-samples/resolve/main/belinda.wav",
    sampling_rate=feature_extractor.sampling_rate,
)
inputs = feature_extractor(audio=audio, sampling_rate=feature_extractor.sampling_rate, return_tensors="pt")
with torch.no_grad():
    audio_codes = model.encode(**inputs).audio_codes
    reconstruction = model.decode(audio_codes).audio_values[..., : len(audio)]
```

## ملاحظات الاستخدام

- **مدخلات الصوت:** يتوقع مستخرج الميزات صوتًا أحادي القناة (Mono) بمعدل العينة المُعدّ مسبقًا؛ فهو لا يعيد أخذ العينات ولا يقلل عدد القنوات. يستخدم المثال `load_audio` للتعامل مع كلا الأمرين. قد يؤدي فك الترميز إلى إضافة عينات في النهاية بسبب الحشو الداخلي، لذا يقوم المثال بقص إعادة البناء إلى الطول الأصلي.
- **التجميع:** يمكن أن يؤدي ملء المقاطع ذات الأطوال المختلفة إلى تغيير رموزها. قم بتشفير المقاطع بشكل منفصل عندما تحتاج إلى الرموز نفسها كما لو كنت تعالج كل مقطع على حدة.
- **الدقة:** حمّل شيفر الرموز وشغّله بدقة `float32` (الافتراضي). قد يؤدي استخدام دقة أقل إلى تغيير إسنادات الرموز.

## WavTokenizerConfig[[transformers.WavTokenizerConfig]]

#### transformers.WavTokenizerConfig[[transformers.WavTokenizerConfig]]

```python
transformers.WavTokenizerConfig(transformers_version: str | None = None, architectures: list[str] | None = None, output_hidden_states: bool | None = False, return_dict: bool | None = True, dtype: str | torch.dtype | None = None, chunk_size_feed_forward: int = 0, is_encoder_decoder: bool = False, id2label: dict[int, str] | dict[str, str] | None = None, label2id: dict[str, int] | dict[str, str] | None = None, problem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = None, sampling_rate: int = 24000, audio_channels: int = 1, num_filters: int = 32, upsampling_ratios: list[int] | tuple[int, ...] = (6, 5, 5, 4), num_residual_layers: int = 1, dilation_growth_rate: int = 2, compress: int = 2, use_conv_shortcut: bool = True, use_causal_conv: bool = False, pad_mode: str = 'reflect', norm_type: str = 'weight_norm', kernel_size: int = 7, last_kernel_size: int = 7, residual_kernel_size: int = 3, num_lstm_layers: int = 2, hidden_size: int = 512, codebook_size: int = 4096, codebook_dim: int = 512, decoder_hidden_size: int = 768, decoder_intermediate_size: int = 2304, decoder_num_layers: int = 12, adanorm_num_embeddings: int = 4, decoder_attention_num_groups: int = 32, norm_eps: float = 1e-06)
```

[المصدر](https://github.com/huggingface/transformers/blob/main/src/transformers/models/wavtokenizer/configuration_wavtokenizer.py#L26)

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

sampling_rate (`int`، *اختياري*، القيمة الافتراضية `24000`) : معدل أخذ العينات الذي يجب أن تُرقَم به ملفات الصوت، ويُعبَّر عنه بالهرتز (Hz).

audio_channels (`int`، *اختياري*، القيمة الافتراضية 1) : عدد القنوات في بيانات الصوت. يتم دعم أحادي (1) فقط.

num_filters (`int`، *اختياري*، القيمة الافتراضية 32) : عدد نوى الالتفاف في طبقة `WavTokenizerConv1d` الأولى لتقليل العينة.

upsampling_ratios (`list[int]`، *اختياري*، القيمة الافتراضية `[6, 5, 5, 4]`) : نسب حجم النواة والخطوة. يستخدم المُشفِّر نسب تقليل الحجم بدلاً من نسب زيادة الحجم، لذا سيستخدم النسب بالترتيب المعاكس لتلك المحددة هنا، والتي يجب أن تتطابق مع ترتيب المُفكِّك. حاصل الضرب (600 افتراضيًا) هو طول القفزة: عدد عينات الصوت التي تمثّلها شفرة واحدة.

num_residual_layers (`int`، *اختياري*، القيمة الافتراضية 1) : عدد طبقات البقايا في كل مرحلة من مراحل المُشفِّر.

dilation_growth_rate (`int`، *اختياري*، القيمة الافتراضية 2) : مقدار زيادة التمدد (dilation) مع كل طبقة متبقية (residual) في المُشفِّر (encoder).

compress (`int`، *اختياري*، القيمة الافتراضية 2) : الأبعاد المُخفَّضة في الفروع المتبقية.

use_conv_shortcut (`bool`، *اختياري*، القيمة الافتراضية `True`) : ما إذا كان سيتم استخدام طبقة تلافيفية كاختصار (تخطي) في الكتل المتبقية. إذا كانت القيمة False، فسيتم استخدام دالة الهوية، مما يوفر اتصالًا متبقياً عامًا.

use_causal_conv (`bool`، *اختياري*، الافتراضي `False`) : ما إذا كان سيتم استخدام الالتفاف السببي الكامل.

pad_mode (`str`، *اختياري*، القيمة الافتراضية `"reflect"`) : وضع الحشو للعمليات التجميعية.

norm_type (`str`، *اختياري*، القيمة الافتراضية `"weight_norm"`) : طريقة التطبيع لعمليات الالتفاف في المُشفِّر. يجب أن تكون ضمن `["weight_norm", "time_group_norm"]`.

kernel_size (`int`، *اختياري*، القيمة الافتراضية 7) : حجم النواة (Kernel) لعمليّة الالتفاف (convolution) الأولية في المُشفِّر (encoder).

last_kernel_size (`int`، *اختياري*، القيمة الافتراضية 7) : حجم النواة لعمليّة الالتفاف الأخيرة في المُشفِّر.

residual_kernel_size (`int`، *اختياري*، القيمة الافتراضية 3) : حجم النواة للطبقات المتبقية في المُشفِّر.

num_lstm_layers (`int`، *اختياري*، القيمة الافتراضية 2) : عدد طبقات LSTM في نهاية المُشفِّر.

hidden_size (`int`، *اختياري*، القيمة الافتراضية 512) : بُعد مخرج المُشفِّر (فضاء الكمّية الخاص بالمُكمِّم).

codebook_size (`int`، *اختياري*، القيمة الافتراضية 4096) : عدد الرموز المنفصلة التي يتكون منها دفتر الرموز VQ الأحادي.

codebook_dim (`int`، *اختياري*، القيمة الافتراضية 512) : بُعد متجهات دفتر الرموز. يجب أن يتطابق مع `hidden_size` (لا تُستخدم إسقاطات).

decoder_hidden_size (`int`، *اختياري*، القيمة الافتراضية 768) : بُعد العمود الفقري لفك الترميز بنمط Vocos.

decoder_intermediate_size (`int`، *اختياري*، القيمة الافتراضية 2304) : بُعد التحويلات النقطية داخل كتل ConvNeXt في المُفكِّك.

decoder_num_layers (`int`، *اختياري*، القيمة الافتراضية 12) : عدد كتل ConvNeXt في هيكل فك الترميز.

adanorm_num_embeddings (`int`، *اختياري*، القيمة الافتراضية 4) : عدد تضمينات الشرط لطبقات تطبيع المعايير التكيفية في المُفكِّك. يُعدّ التكييف ميزةً أثناء التدريب (تضمين واحد لكل نطاق عرض)؛ أما أثناء الاستدلال فيُستخدم التضمين 0 دائمًا.

decoder_attention_num_groups (`int`، *اختياري*، القيمة الافتراضية 32) : عدد مجموعات طبقات GroupNorm في المُفكِّك.

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

هذه فئة الإعدادات المخزنة لإعدادات نموذج WavTokenizerModel. تُستخدم لاستحداث نموذج Wavtokenizer وفقًا للحجج المحددة، مع تعريف بنية النموذج. إن استحداث إعدادات باستخدام القيم الافتراضية سيؤدي إلى إعدادات مشابهة لتلك الخاصة بـ [swiss-ai/wavtokenizer-large-unify-40token](https://huggingface.co/swiss-ai/wavtokenizer-large-unify-40token)

ترث كائنات الإعداد من [PreTrainedConfig](/docs/transformers/main/ar/main_classes/configuration#transformers.PreTrainedConfig) ويمكن استخدامها للتحكم في مخرجات النموذج. اقرأ التوثيق الخاص بـ [PreTrainedConfig](/docs/transformers/main/ar/main_classes/configuration#transformers.PreTrainedConfig) لمزيد من المعلومات.

مثال:

```python
>>> from transformers import WavTokenizerConfig, WavTokenizerModel

>>> # Initializing configuration
>>> configuration = WavTokenizerConfig()

>>> # Initializing a model (with random weights) from the configuration
>>> model = WavTokenizerModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config
```

## WavTokenizerEncoderConfig[[transformers.WavTokenizerEncoderConfig]]

#### transformers.WavTokenizerEncoderConfig[[transformers.WavTokenizerEncoderConfig]]

```python
transformers.WavTokenizerEncoderConfig(transformers_version: str | None = None, architectures: list[str] | None = None, output_hidden_states: bool | None = False, return_dict: bool | None = True, dtype: str | torch.dtype | None = None, chunk_size_feed_forward: int = 0, is_encoder_decoder: bool = False, id2label: dict[int, str] | dict[str, str] | None = None, label2id: dict[str, int] | dict[str, str] | None = None, problem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = None, sampling_rate: int = 24000, audio_channels: int = 1, num_filters: int = 32, upsampling_ratios: list[int] | tuple[int, ...] = (6, 5, 5, 4), num_residual_layers: int = 1, dilation_growth_rate: int = 2, compress: int = 2, use_conv_shortcut: bool = True, use_causal_conv: bool = False, pad_mode: str = 'reflect', norm_type: str = 'weight_norm', kernel_size: int = 7, last_kernel_size: int = 7, residual_kernel_size: int = 3, num_lstm_layers: int = 2, hidden_size: int = 512, codebook_size: int = 4096, codebook_dim: int = 512, decoder_hidden_size: int = 768, decoder_intermediate_size: int = 2304, decoder_num_layers: int = 12, adanorm_num_embeddings: int = 4, decoder_attention_num_groups: int = 32, norm_eps: float = 1e-06)
```

[المصدر](https://github.com/huggingface/transformers/blob/main/src/transformers/models/wavtokenizer/configuration_wavtokenizer.py#L159)

إعداد [WavTokenizerEncoderModel](/docs/transformers/main/ar/model_doc/wavtokenizer#transformers.WavTokenizerEncoderModel)، وهو المُشفِّر والمُكمِّم الخاص بـ WavTokenizer. يتشارك جميع الحقول مع [WavTokenizerConfig](/docs/transformers/main/ar/model_doc/wavtokenizer#transformers.WavTokenizerConfig) (راجع توثيقه لمعرفة الحُجج)، لذا يمكن تحميله من نقطة تحقق WavTokenizer كاملة. الحقول الخاصة بالمُفكِّك غير مستخدمة في نموذج المُشفِّر.

## WavTokenizerFeatureExtractor[[transformers.WavTokenizerFeatureExtractor]]

#### transformers.WavTokenizerFeatureExtractor[[transformers.WavTokenizerFeatureExtractor]]

```python
transformers.WavTokenizerFeatureExtractor(feature_size: int = 1, sampling_rate: int = 24000, padding_value: float = 0.0, hop_length: int = 600, normalize_audio: bool = False, target_peak_dB_FS: float = -3.0, **kwargs)
```

[المصدر](https://github.com/huggingface/transformers/blob/main/src/transformers/models/wavtokenizer/feature_extraction_wavtokenizer.py#L27)

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

feature_size (`int`، *اختياري*، القيمة الافتراضية 1) : بُعد الميزة للميزات المستخرجة. يتم دعم أحادي (1) فقط.

sampling_rate (`int`، *اختياري*، القيمة الافتراضية 24000) : معدل أخذ العينات الذي يجب من خلاله تحويل الموجة الصوتية إلى شكل رقمي، ويُعبَّر عنه بالهرتز (Hz).

padding_value (`float`، *اختياري*، القيمة الافتراضية 0.0) : القيمة المستخدمة للتعبئة.

hop_length (`int`، *اختياري*، القيمة الافتراضية 600) : عدد عينات الصوت التي يمثلها رمز صوتي واحد.

normalize_audio (`bool`، *اختياري*، القيمة الافتراضية `False`) : ما إذا كان يجب تطبيع كل مقطع إلى `target_peak_dB_FS` قبل إضافة الحشو. لا يقوم WavTokenizer الأصلي بالتطبيع؛ بينما تمكينه في Apertus 1.5.

target_peak_dB_FS (`float`، *اختياري*، القيمة الافتراضية -3.0) : المستوى القمّي المستهدف بوحدة dB FS المستخدم عندما تكون `normalize_audio` هي `True`.

ينشئ مستخرج ميزات WavTokenizer لتسجيل صوتي أحادي القناة بمعدل العينة المُعدّ. لا يتم إعادة أخذ عينات الصوت أو خلطه.

#### __call__[[transformers.WavTokenizerFeatureExtractor.__call__]]

```python
__call__(audio: typing.Union[numpy.ndarray, ForwardRef('torch.Tensor'), collections.abc.Sequence[numpy.ndarray], collections.abc.Sequence['torch.Tensor']], padding: bool | str | transformers.utils.generic.PaddingStrategy | None = None, truncation: bool | None = False, max_length: int | None = None, return_tensors: str | transformers.utils.generic.TensorType | None = None, sampling_rate: int | None = None)
```

[المصدر](https://github.com/huggingface/transformers/blob/main/src/transformers/models/wavtokenizer/feature_extraction_wavtokenizer.py#L72)

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

audio (`np.ndarray`، `torch.Tensor`، `list[float]`، `list[np.ndarray]`، `list[torch.Tensor]`، `list[list[float]]`) : التسلسل أو الدفعة من التسلسلات المراد معالجتها. يجب أن يكون كل تسلسل صوتًا أحادي القناة (mono) بشكل `(num_samples,)`، وقد تم أخذ عيناته مسبقًا بمعدل `sampling_rate` الخاص بمستخرج الميزات هذا. لا يتم إعادة أخذ عينات الصوت أو خلطه (downmix).

padding (`bool` أو `str` أو [PaddingStrategy](/docs/transformers/main/ar/internal/file_utils#transformers.utils.PaddingStrategy)، *اختياري*، القيمة الافتراضية `True`) : استراتيجية الحشو: `True` أو `'longest'` تحشو الدفعة حتى أطول تسلسل فيها (تبقى المدخلات المفردة دون حشو)، و`'max_length'` تحشو حتى `max_length`، و`False` أو `'do_not_pad'` تعطّل الحشو.

truncation (`bool`، *اختياري*، القيمة الافتراضية `False`) : ما إذا كان يجب تقصير التسلسلات الأطول من `max_length` إلى `max_length`.

max_length (`int`, *اختياري*) : الطول المستهدف لحشو `'max_length'` ولـ `truncation`.

return_tensors (`str` أو [TensorType](/docs/transformers/main/ar/internal/file_utils#transformers.TensorType)، *اختياري*) : إذا تم تعيينه، تُعاد الموترات بدلاً من قائمة مصفوفات numpy: `'pt'` لـ PyTorch `torch.Tensor`، و`'np'` لـ NumPy `np.ndarray`.

sampling_rate (`int`، *اختياري*) : معدل أخذ العينات لإدخال `audio`؛ مرّره حتى يؤدي أي عدم تطابق مع `sampling_rate` المُعدّ إلى رفع خطأ بدلاً من الفشل بصمت.

**يعيد:** [BatchFeature](/docs/transformers/main/ar/main_classes/feature_extractor#transformers.BatchFeature)

[BatchFeature](/docs/transformers/main/ar/main_classes/feature_extractor#transformers.BatchFeature) يحتوي على الحقول التالية:

- **input_values** -- موجات صوتية تُغذّى بها النموذج، على شكل قائمة من المصفوفات ذات الشكل `(1, num_samples)`، أو متجه (tensor) ذو الشكل `(batch_size, 1, num_samples)` عند تعيين `return_tensors`.
- **padding_mask** -- قناع يُظهر العينات الصوتية الصالحة (1) مقابل الحشو (0)، على شكل `(batch_size, num_samples)`.

قم بتحويل وتجهيز تسلسل صوتي واحد أو عدة تسلسلات صوتية للنموذج.

## WavTokenizerEncoderModel[[transformers.WavTokenizerEncoderModel]]

#### transformers.WavTokenizerEncoderModel[[transformers.WavTokenizerEncoderModel]]

```python
transformers.WavTokenizerEncoderModel(config: WavTokenizerEncoderConfig)
```

[المصدر](https://github.com/huggingface/transformers/blob/main/src/transformers/models/wavtokenizer/modeling_wavtokenizer.py#L540)

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

config ([WavTokenizerEncoderConfig](/docs/transformers/main/ar/model_doc/wavtokenizer#transformers.WavTokenizerEncoderConfig)) : فئة إعدادات النموذج التي تحتوي على جميع معاملات النموذج. عند التهيئة باستخدام ملف إعدادات، لا يتم تحميل الأوزان المرتبطة بالنموذج، بل الإعدادات فقط. راجع طريقة [from_pretrained()](/docs/transformers/main/ar/main_classes/model#transformers.PreTrainedModel.from_pretrained) لتحميل أوزان النموذج.

المُشفِّر والمُكمِّم الخاص بـ WavTokenizer لتحويل الموجات الصوتية إلى رموز منفصلة.

يرث هذا النموذج من [PreTrainedModel](/docs/transformers/main/ar/main_classes/model#transformers.PreTrainedModel). راجع توثيق الفئة الأصلية لمعرفة الطرق العامة التي تنفذها المكتبة لجميع نماذجها (مثل التنزيل أو الحفظ، وتغيير حجم تضمينات الإدخال، وقص الرؤوس، وما إلى ذلك).

هذا النموذج هو أيضاً فئة فرعية من [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) في PyTorch. استخدمه كوحدة PyTorch عادية، وارجع إلى توثيق PyTorch لكل ما يتعلق بالاستخدام العام والسلوك.

#### encode[[transformers.WavTokenizerEncoderModel.encode]]

```python
encode(input_values: Tensor, padding_mask: typing.Optional[torch.Tensor] = None, **kwargs)
```

[المصدر](https://github.com/huggingface/transformers/blob/main/src/transformers/models/wavtokenizer/modeling_wavtokenizer.py#L554)

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

input_values (`torch.Tensor` من الشكل `(batch_size, 1, sequence_length)`) : موجة الصوت المدخلة. يتم دعم الأطوال غير الصفرية بشكل تعسفي؛ حيث يقوم المُشفِّر بإضافة الحشو داخلياً وإصدار `ceil(sequence_length / hop_length)` رمزاً.

padding_mask (`torch.Tensor` من الشكل `(batch_size, sequence_length)` أو `(batch_size, 1, sequence_length)`، *اختياري*) : قناع يصف الحشو في `input_values`؛ يُستخدم لحساب `audio_codes_mask`.

**يعيد:** `WavTokenizerEncoderOutput` أو `tuple(torch.Tensor)`

A `WavTokenizerEncoderOutput` or a tuple of `torch.Tensor` (if `return_dict=False` is passed or when `config.return_dict=False`) comprising various elements depending on the configuration (`None`) and inputs.

- **audio_codes** (`torch.LongTensor` من الشكل `(batch_size, 1, codes_length)`، *اختياري*) -- فهارس رموز منفصلة محسوبة باستخدام `model.encode`. تمثل هذه الرموز الشكل المضغوط والمكمَّم للإشارة الصوتية المدخلة (دفتر رموز واحد، `ceil(num_samples / hop_length)` رمز).
- **audio_codes_mask** (`torch.Tensor` من الشكل `(batch_size, 1, codes_length)`، *اختياري*) -- `padding_mask` مُصغَّر الحجم يُشير إلى رموز الصوت الصالحة في `audio_codes`.

#### forward[[transformers.WavTokenizerEncoderModel.forward]]

```python
forward(input_values: Tensor, padding_mask: typing.Optional[torch.Tensor] = None, **kwargs)
```

[المصدر](https://github.com/huggingface/transformers/blob/main/src/transformers/models/wavtokenizer/modeling_wavtokenizer.py#L589)

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

input_values (`torch.Tensor` من الشكل `(batch_size, 1, sequence_length)`) : موجة الصوت المدخلة.

padding_mask (`torch.Tensor` من الشكل `(batch_size, sequence_length)` أو `(batch_size, 1, sequence_length)`، *اختياري*) : قناع التعبئة (Padding mask) المستخدم لحساب `audio_codes_mask`.

**يعيد:** `WavTokenizerEncoderOutput` أو `tuple(torch.Tensor)`

`WavTokenizerEncoderOutput` أو مجموعة (tuple) من `torch.Tensor` (في حال تمرير `return_dict=False` أو عندما يكون `config.return_dict=False`) تتكون من عناصر مختلفة اعتماداً على الإعدادات ([WavTokenizerConfig](/docs/transformers/main/ar/model_doc/wavtokenizer#transformers.WavTokenizerConfig)) والمدخلات.

تتجاوز طريقة [WavTokenizerEncoderModel](/docs/transformers/main/ar/model_doc/wavtokenizer#transformers.WavTokenizerEncoderModel) الخاصة بالتقديم (forward) الطريقة الخاصة `__call__`.

على الرغم من أنه يجب تعريف وصفة المرور الأمامي داخل هذه الدالة، إلا أنه ينبغي استدعاء كائن `Module` بدلاً من هذه الدالة، لأن الكائن يتولى تنفيذ خطوات المعالجة المسبقة والمعالجة اللاحقة، بينما تتجاهل الدالة هذه الخطوات بصمت.

- **audio_codes** (`torch.LongTensor` من الشكل `(batch_size, 1, codes_length)`، *اختياري*) -- فهارس رموز منفصلة محسوبة باستخدام `model.encode`. تمثل هذه الرموز الشكل المضغوط والمكمَّم للإشارة الصوتية المدخلة (دفتر رموز واحد، `ceil(num_samples / hop_length)` رمز).
- **audio_codes_mask** (`torch.Tensor` من الشكل `(batch_size, 1, codes_length)`، *اختياري*) -- `padding_mask` مُصغَّر الحجم يُشير إلى رموز الصوت الصالحة في `audio_codes`.

## WavTokenizerModel[[transformers.WavTokenizerModel]]

#### transformers.WavTokenizerModel[[transformers.WavTokenizerModel]]

```python
transformers.WavTokenizerModel(config: WavTokenizerConfig)
```

[المصدر](https://github.com/huggingface/transformers/blob/main/src/transformers/models/wavtokenizer/modeling_wavtokenizer.py#L610)

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

config ([WavTokenizerConfig](/docs/transformers/main/ar/model_doc/wavtokenizer#transformers.WavTokenizerConfig)) : فئة إعدادات النموذج التي تحتوي على جميع معاملات النموذج. عند التهيئة باستخدام ملف إعدادات، لا يتم تحميل الأوزان المرتبطة بالنموذج، بل الإعدادات فقط. راجع طريقة [from_pretrained()](/docs/transformers/main/ar/main_classes/model#transformers.PreTrainedModel.from_pretrained) لتحميل أوزان النموذج.

رمز صوتي عصبي WavTokenizer بكتاب رمز واحد مخصص للاستدلال فقط.

يرث هذا النموذج من [PreTrainedModel](/docs/transformers/main/ar/main_classes/model#transformers.PreTrainedModel). راجع توثيق الفئة الأصلية لمعرفة الطرق العامة التي تنفذها المكتبة لجميع نماذجها (مثل التنزيل أو الحفظ، وتغيير حجم تضمينات الإدخال، وقص الرؤوس، وما إلى ذلك).

هذا النموذج هو أيضاً فئة فرعية من [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) في PyTorch. استخدمه كوحدة PyTorch عادية، وارجع إلى توثيق PyTorch لكل ما يتعلق بالاستخدام العام والسلوك.

#### فك الترميز[[transformers.WavTokenizerModel.decode]]

```python
decode(audio_codes: Tensor, bandwidth_id: int = 0, **kwargs)
```

[المصدر](https://github.com/huggingface/transformers/blob/main/src/transformers/models/wavtokenizer/modeling_wavtokenizer.py#L639)

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

audio_codes (`torch.LongTensor` من الشكل `(batch_size, 1, codes_length)`) : فهارس رموز منفصلة محسوبة باستخدام `model.encode`. يدعم رمزًا واحدًا أو أكثر؛ حيث يُفكّك كل رمز إلى `hop_length` من عينات الصوت.

bandwidth_id (`int`، *اختياري*، القيمة الافتراضية 0) : معرّف تضمين الشرط لطبقات تطبيع المعايير التكيفية في المُفكِّك. تكون القيمة دائمًا 0 أثناء الاستدلال.

**يعيد:** `WavTokenizerDecoderOutput` أو `tuple(torch.Tensor)`

A `WavTokenizerDecoderOutput` or a tuple of `torch.Tensor` (if `return_dict=False` is passed or when `config.return_dict=False`) comprising various elements depending on the configuration (`None`) and inputs.

- **audio_values** (`torch.Tensor` من الشكل `(batch_size, 1, sequence_length)`، *اختياري*) -- قيم موجة الصوت المُفكّكة في مجال الزمن (`codes_length * hop_length` عينة).

#### encode[[transformers.WavTokenizerModel.encode]]

```python
encode(input_values: Tensor, padding_mask: typing.Optional[torch.Tensor] = None, **kwargs)
```

[المصدر](https://github.com/huggingface/transformers/blob/main/src/transformers/models/wavtokenizer/modeling_wavtokenizer.py#L622)

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

input_values (`torch.Tensor` من الشكل `(batch_size, 1, sequence_length)`) : موجة الصوت المدخلة. يتم دعم الأطوال غير الصفرية بشكل تعسفي؛ حيث يقوم المُشفِّر بإضافة الحشو داخلياً وإصدار `ceil(sequence_length / hop_length)` رمزاً.

padding_mask (`torch.Tensor` من الشكل `(batch_size, sequence_length)` أو `(batch_size, 1, sequence_length)`، *اختياري*) : قناع يصف الحشو في `input_values`؛ يُستخدم لحساب `audio_codes_mask`.

**يعيد:** `WavTokenizerEncoderOutput` أو `tuple(torch.Tensor)`

A `WavTokenizerEncoderOutput` or a tuple of `torch.Tensor` (if `return_dict=False` is passed or when `config.return_dict=False`) comprising various elements depending on the configuration (`None`) and inputs.

- **audio_codes** (`torch.LongTensor` من الشكل `(batch_size, 1, codes_length)`، *اختياري*) -- فهارس رموز منفصلة محسوبة باستخدام `model.encode`. تمثل هذه الرموز الشكل المضغوط والمكمَّم للإشارة الصوتية المدخلة (دفتر رموز واحد، `ceil(num_samples / hop_length)` رمز).
- **audio_codes_mask** (`torch.Tensor` من الشكل `(batch_size, 1, codes_length)`، *اختياري*) -- `padding_mask` مُصغَّر الحجم يُشير إلى رموز الصوت الصالحة في `audio_codes`.

#### forward[[transformers.WavTokenizerModel.forward]]

```python
forward(input_values: Tensor, padding_mask: typing.Optional[torch.Tensor] = None, **kwargs)
```

[المصدر](https://github.com/huggingface/transformers/blob/main/src/transformers/models/wavtokenizer/modeling_wavtokenizer.py#L660)

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

input_values (`torch.Tensor` من الشكل `(batch_size, 1, sequence_length)`) : موجة الصوت المدخلة.

padding_mask (`torch.Tensor` من الشكل `(batch_size, sequence_length)` أو `(batch_size, 1, sequence_length)`، *اختياري*) : قناع يُظهر العينات الصوتية الصالحة (1) مقابل الحشو (0)، ويُستخدم لحساب `audio_codes_mask`.

**يعيد:** `WavTokenizerOutput` أو `tuple(torch.Tensor)`

A `WavTokenizerOutput` or a tuple of `torch.Tensor` (if `return_dict=False` is passed or when `config.return_dict=False`) comprising various elements depending on the configuration (`None`) and inputs.

تتجاوز طريقة [WavTokenizerModel](/docs/transformers/main/ar/model_doc/wavtokenizer#transformers.WavTokenizerModel) الأمامية الطريقة الخاصة `__call__`.

على الرغم من أنه يجب تعريف وصفة المرور الأمامي داخل هذه الدالة، إلا أنه ينبغي استدعاء كائن `Module` بدلاً من هذه الدالة، لأن الكائن يتولى تنفيذ خطوات المعالجة المسبقة والمعالجة اللاحقة، بينما تتجاهل الدالة هذه الخطوات بصمت.

- **audio_values** (`torch.Tensor` من الشكل `(batch_size, 1, sequence_length)`، *اختياري*) -- قيم موجة الصوت المُفكّكة في مجال الزمن، والمُستخرجة باستخدام جزء المُفكّك في WavTokenizer.
- **audio_codes** (`torch.LongTensor` من الشكل `(batch_size, 1, codes_length)`، *اختياري*) -- فهارس رموز منفصلة محسوبة باستخدام `model.encode`.
- **audio_codes_mask** (`torch.Tensor` من الشكل `(batch_size, 1, codes_length)`، *اختياري*) -- `padding_mask` مُصغَّر الحجم يُشير إلى رموز الصوت الصالحة في `audio_codes`.

