# مُرمِّز الصوت لـ Pocket TTS

## نظرة عامة

مُرمِّز الصوت في [Pocket TTS](https://huggingface.co/kyutai/pocket-tts): وهو مُرمِّز (codec) يعتمد على بنية [Mimi](./mimi) (تحويلات SEANet ومحوّل سببي صغير على كل جانب) حيث يُستبدل مُكمِّم المتجهات المتبقية عنق زجاجة مستمر بعرض 32 بُعدًا، وهو VAE-GAN الخاص بـ [Continuous Audio Language Models](https://huggingface.co/papers/2509.06926). يُحوِّل هذا المُرمِّز الصوت بمعدل 24 كيلوهرتز إلى كائنات كامنة (latents) بمعدل 12.5 هرتز والعكس. يمكن تحميل مُرمِّزه ومُفكِّكه بشكل مستقل ([PocketTTSAudioTokenizerEncoderModel](/docs/transformers/main/ar/model_doc/pocket_tts_audio_tokenizer#transformers.PocketTTSAudioTokenizerEncoderModel)، [PocketTTSAudioTokenizerDecoderModel](/docs/transformers/main/ar/model_doc/pocket_tts_audio_tokenizer#transformers.PocketTTSAudioTokenizerDecoderModel)). وهو `audio_tokenizer` الخاص بـ [PocketTTSProcessor](/docs/transformers/main/ar/model_doc/pocket_tts#transformers.PocketTTSProcessor)، وهو مشترك بين جميع نقاط التفتيش (checkpoints) الخاصة بـ Pocket TTS: حيث يقوم المُعالِج بتشفير أوامر الصوت باستخدامه وفك تشفير الكائنات الكامنة المُولَّدة.

تمت مساهمة هذا النموذج من قِبل [Eustache Le Bihan](https://huggingface.co/eustlb). الكود الأصلي هو [kyutai-labs/pocket-tts](https://github.com/kyutai-labs/pocket-tts).

## الاستخدام

```python
from datasets import Audio, load_dataset
from transformers import AutoFeatureExtractor, AutoModel

model = AutoModel.from_pretrained("eustlb/pocket-tts-audio-tokenizer", device_map="auto")
feature_extractor = AutoFeatureExtractor.from_pretrained("eustlb/pocket-tts-audio-tokenizer")

dataset = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
dataset = dataset.cast_column("audio", Audio(sampling_rate=24000))
inputs = feature_extractor(dataset[0]["audio"]["array"], sampling_rate=24000, return_tensors="pt").to(model.device)

latents = model.encode(**inputs).latents
audio_values = model.decode(latents).audio_values
```

## PocketTTSAudioTokenizerConfig[[transformers.PocketTTSAudioTokenizerConfig]]

#### transformers.PocketTTSAudioTokenizerConfig[[transformers.PocketTTSAudioTokenizerConfig]]

```python
transformers.PocketTTSAudioTokenizerConfig(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, hidden_size: int = 512, num_filters: int = 64, num_residual_layers: int = 1, upsampling_ratios: list[int] | None = None, kernel_size: int = 7, last_kernel_size: int = 3, residual_kernel_size: int = 3, dilation_growth_rate: int = 2, use_causal_conv: bool = True, pad_mode: str = 'constant', compress: int = 2, trim_right_ratio: float = 1.0, use_conv_shortcut: bool = False, upsample_groups: int = 512, num_hidden_layers: int = 2, intermediate_size: int = 2048, num_attention_heads: int = 8, num_key_value_heads: int = 8, head_dim: int | None = None, hidden_act: str = 'gelu_pytorch_tanh', max_position_embeddings: int = 8000, initializer_range: float = 0.02, norm_eps: float = 1e-05, use_cache: bool = False, use_streaming: bool = False, rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None, sliding_window: int = 250, attention_dropout: float | int = 0.0, layer_scale_initial_scale: float = 0.01, attention_bias: bool = False, latent_stride: int = 16, latent_dim: int = 32)
```

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

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

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

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

hidden_size (`int`، *اختياري*، القيمة الافتراضية `512`) : بُعد التمثيلات المخفية.

num_filters (`int`، *اختياري*، القيمة الافتراضية 64) : عدد نوى الالتفاف في طبقة `PocketTTSAudioTokenizerConv1d` الأولى من المُشفِّر.

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

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

kernel_size (`int`، *اختياري*، القيمة الافتراضية `7`) : حجم النواة الالتفافية.

last_kernel_size (`int`، *اختياري*، القيمة الافتراضية 3) : حجم النواة لطبقة الالتفاف الأخيرة.

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

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

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

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

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

trim_right_ratio (`float`، *اختياري*، القيمة الافتراضية 1.0) : النسبة المستخدمة لقص الجزء الأيمن من الالتفاف المنقول (transposed convolution) عند تفعيل الإعداد `use_causal_conv = True`. إذا كانت تساوي 1.0، فهذا يعني أن كل عملية القص تتم على الجانب الأيمن.

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

upsample_groups (`int`، *اختياري*، القيمة الافتراضية 512) : عدد مجموعات الالتفاف المعكوس الذي يعيد حجم الكامنات إلى معدل SEANet.

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

intermediate_size (`int`، *اختياري*، القيمة الافتراضية `2048`) : بُعد تمثيلات MLP.

num_attention_heads (`int`، *اختياري*، القيمة الافتراضية `8`) : عدد رؤوس الانتباه في كل طبقة انتباه داخل مُفكِّك Transformer.

num_key_value_heads (`int`، *اختياري*، القيمة الافتراضية `8`) : يمثل هذا عدد رؤوس key_value التي يجب استخدامها لتنفيذ Grouped Query Attention. إذا كان `num_key_value_heads=num_attention_heads`، فسيستخدم النموذج Multi Head Attention (MHA)، وإذا كان `num_key_value_heads=1` فسيستخدم النموذج Multi Query Attention (MQA)، وإلا فسيتم استخدام GQA. عند تحويل نقطة تفتيش متعددة الرؤوس إلى نقطة تفتيش GQA، يجب بناء كل رأس key و value ضمن المجموعة عن طريق meanpooling جميع الرؤوس الأصلية داخل تلك المجموعة. لمزيد من التفاصيل، راجعوا [هذا البحث](https://huggingface.co/papers/2305.13245). إذا لم يتم تحديد القيمة، فستتخذ القيمة الافتراضية `num_attention_heads`.

head_dim (`int`، *اختياري*) : بُعد رأس الانتباه. إذا كانت القيمة None، فسيتم افتراض hidden_size // num_attention_heads

hidden_act (`str`، *اختياري*، القيمة الافتراضية `gelu_pytorch_tanh`) : دالة التنشيط غير الخطية (دالة أو نص) في المُفكِّك. على سبيل المثال، `"gelu"`، `"relu"`، `"silu"`، وما إلى ذلك.

max_position_embeddings (`int`، *اختياري*، القيمة الافتراضية `8000`) : الحد الأقصى لطول التسلسل الذي قد يُستخدم به هذا النموذج على الإطلاق.

initializer_range (`float`، *اختياري*، القيمة الافتراضية `0.02`) : الانحراف المعياري لـ truncated_normal_initializer المستخدم في تهيئة جميع مصفوفات الأوزان.

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

use_cache (`bool`، *اختياري*، القيمة الافتراضية `False`) : ما إذا كان يجب على النموذج إرجاع انتباهات المفاتيح/القيم الأخيرة (لا تُستخدم في جميع النماذج). لا ينطبق إلا إذا كان `config.is_decoder=True` أو عندما يكون النموذج نموذجًا توليديًا يعتمد على المُفكِّك فقط.

use_streaming (`bool`، *اختياري*، القيمة الافتراضية `False`) : ما إذا كان المُشفِّر يبثّ البيانات بشكل افتراضي: في هذه الحالة، يعيد كاش التوسيد وكاش المفاتيح والقيم لتُمرَّر إلى الاستدعاء التالي.

rope_parameters (`Union[~modeling_rope_utils.RopeParameters, dict]`، *اختياري*) : قاموس يحتوي على معاملات التهيئة الخاصة بتضمينات RoPE. يجب أن يحتوي القاموس على قيمة لـ `rope_theta`، وبشكل اختياري معاملات تُستخدم للتوسيع في حال رغبتَ في استخدام RoPE مع `max_position_embeddings` أطول.

sliding_window (`int`، *اختياري*، القيمة الافتراضية `250`) : حجم نافذة الانتباه النافذة المنزلقة. إذا كانت `None`، فلا تُطبَّق نافذة منزلقة.

attention_dropout (`Union[float, int]`، *اختياري*، القيمة الافتراضية `0.0`) : نسبة الإسقاط (dropout) لاحتمالات الانتباه.

layer_scale_initial_scale (`float`، *اختياري*، القيمة الافتراضية `0.01`) : المقياس المستخدم في طبقات الانتباه الذاتي. 0.1 للنموذج الأساسي، و1e-6 للنموذج الكبير. اضبط القيمة على 0 لتعطيل مقياس الطبقة.

attention_bias (`bool`، *اختياري*، القيمة الافتراضية `False`) : ما إذا كان سيتم استخدام انحياز في طبقات الإسقاط للاستعلام والمفتاح والقيمة والمخرجات أثناء الانتباه الذاتي.

latent_stride (`int`، *اختياري*، القيمة الافتراضية 16) : عدد إطارات SEANet لكل إطار كامن: وهو خطوة التمرير في المُشفِّر الذي يُقلِّل حجم مخرجات SEANet إلى الإطارات الكامنة، وفي المُفكِّك المعاكس الذي يُعيد رفع حجمها. يغطي الإطار الكامن `prod(upsampling_ratios) * latent_stride` من عينات الصوت (`frame_size`، و1920 في نقاط التفتيش المُصدَّرة).

latent_dim (`int`, *اختياري*، القيمة الافتراضية 32) : بُعد الكامنات المستمرة. يتم استبدال مُكمِّم المتجهات المتبقية في Mimi بهذا عنق الزجاجة: تُخرج طبقة الالتفاف المُصغِّرة في المُشفِّر `latent_dim` قناة، ثم يعيد المُفكِّك إسقاطها إلى `hidden_size` قبل عملية التكبير.

هذه فئة الإعدادات (configuration class) لتخزين إعدادات نموذج PocketTTSAudioTokenizerModel. تُستخدم لاستحداث نموذج Pocket Tts Audio Tokenizer وفقاً للحجج المحددة، مع تعريف بنية النموذج. إن استحداث إعدادات باستخدام القيم الافتراضية سيؤدي إلى الحصول على إعدادات مشابهة لتلك الخاصة بـ [eustlb/pocket-tts-audio-tokenizer](https://huggingface.co/eustlb/pocket-tts-audio-tokenizer)

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

مثال:

```python
>>> from transformers import PocketTTSAudioTokenizerConfig, PocketTTSAudioTokenizerModel

>>> # a full codec, and its decoder alone
>>> model = PocketTTSAudioTokenizerModel(PocketTTSAudioTokenizerConfig())
>>> decoder_only = PocketTTSAudioTokenizerModel(PocketTTSAudioTokenizerConfig(encoder_config=None))
```

## PocketTTSAudioTokenizerEncoderConfig[[transformers.PocketTTSAudioTokenizerEncoderConfig]]

#### transformers.PocketTTSAudioTokenizerEncoderConfig[[transformers.PocketTTSAudioTokenizerEncoderConfig]]

```python
transformers.PocketTTSAudioTokenizerEncoderConfig(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, hidden_size: int = 512, num_filters: int = 64, num_residual_layers: int = 1, upsampling_ratios: list[int] | None = None, kernel_size: int = 7, last_kernel_size: int = 3, residual_kernel_size: int = 3, dilation_growth_rate: int = 2, use_causal_conv: bool = True, pad_mode: str = 'constant', compress: int = 2, trim_right_ratio: float = 1.0, use_conv_shortcut: bool = False, upsample_groups: int = 512, num_hidden_layers: int = 2, intermediate_size: int = 2048, num_attention_heads: int = 8, num_key_value_heads: int = 8, head_dim: int | None = None, hidden_act: str = 'gelu_pytorch_tanh', max_position_embeddings: int = 8000, initializer_range: float = 0.02, norm_eps: float = 1e-05, use_cache: bool = False, use_streaming: bool = False, rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None, sliding_window: int = 250, attention_dropout: float | int = 0.0, layer_scale_initial_scale: float = 0.01, attention_bias: bool = False, latent_stride: int = 16, latent_dim: int = 32)
```

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

إعداد النصف المُشفِّر من PocketTTSAudioTokenizer (مُشفِّر SEANet، ومحوّل المُشفِّر، والخفض). يتشارك كل حقل مع [PocketTTSAudioTokenizerConfig](/docs/transformers/main/ar/model_doc/pocket_tts_audio_tokenizer#transformers.PocketTTSAudioTokenizerConfig) (راجع توثيقه لمعرفة الحُجج)، لذا يمكن تحميله مباشرةً من نقطة تحقق كاملة لـ PocketTTSAudioTokenizer.

## PocketTTSAudioTokenizerDecoderConfig[[transformers.PocketTTSAudioTokenizerDecoderConfig]]

#### transformers.PocketTTSAudioTokenizerDecoderConfig[[transformers.PocketTTSAudioTokenizerDecoderConfig]]

```python
transformers.PocketTTSAudioTokenizerDecoderConfig(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, hidden_size: int = 512, num_filters: int = 64, num_residual_layers: int = 1, upsampling_ratios: list[int] | None = None, kernel_size: int = 7, last_kernel_size: int = 3, residual_kernel_size: int = 3, dilation_growth_rate: int = 2, use_causal_conv: bool = True, pad_mode: str = 'constant', compress: int = 2, trim_right_ratio: float = 1.0, use_conv_shortcut: bool = False, upsample_groups: int = 512, num_hidden_layers: int = 2, intermediate_size: int = 2048, num_attention_heads: int = 8, num_key_value_heads: int = 8, head_dim: int | None = None, hidden_act: str = 'gelu_pytorch_tanh', max_position_embeddings: int = 8000, initializer_range: float = 0.02, norm_eps: float = 1e-05, use_cache: bool = False, use_streaming: bool = False, rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None, sliding_window: int = 250, attention_dropout: float | int = 0.0, layer_scale_initial_scale: float = 0.01, attention_bias: bool = False, latent_stride: int = 16, latent_dim: int = 32)
```

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

إعداد النصف المُفكِّك (decoder) من PocketTTSAudioTokenizer (الترقية، محوّل المُفكِّك، ومُفكِّك SEANet). يتشارك كل حقل مع [PocketTTSAudioTokenizerConfig](/docs/transformers/main/ar/model_doc/pocket_tts_audio_tokenizer#transformers.PocketTTSAudioTokenizerConfig) (راجع توثيقه لمعرفة الحُجج)، لذا يمكن تحميله مباشرةً من نقطة تحقق كاملة لـ PocketTTSAudioTokenizer.

## PocketTTSAudioTokenizerModel[[transformers.PocketTTSAudioTokenizerModel]]

#### transformers.PocketTTSAudioTokenizerModel[[transformers.PocketTTSAudioTokenizerModel]]

```python
transformers.PocketTTSAudioTokenizerModel(config: PocketTTSAudioTokenizerConfig)
```

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

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

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

مُرمِّز الصوت في Pocket TTS: مُرمِّز بهيكلية Mimi مع كامن مستمر ذي 32 بُعدًا عند 12.5 هرتز (وهو VAE-GAN الخاص بنماذج اللغة الصوتية المستمرة)، يُحوِّل الصوت بمعدل 24 كيلوهرتز إلى كمائن والعكس.

يرث هذا النموذج من [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.PocketTTSAudioTokenizerModel.encode]]

```python
encode(input_values: Tensor, padding_mask: typing.Optional[torch.Tensor] = None, encoder_past_key_values: transformers.cache_utils.Cache | None = None, padding_cache: transformers.models.pocket_tts_audio_tokenizer.modeling_pocket_tts_audio_tokenizer.PocketTTSAudioTokenizerConv1dPaddingCache | None = None, use_streaming: bool | None = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

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

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

input_values (`torch.Tensor` من الشكل `(batch_size, audio_channels, num_samples)`) : موجة صوتية، كما تُعاد بواسطة [EncodecFeatureExtractor](/docs/transformers/main/ar/model_doc/encodec#transformers.EncodecFeatureExtractor)، حيث تُضيف أصفارًا في نهايتها لتصبح مضاعفًا لحجم `config.frame_size` من العينات، تمامًا كما تفعل النسخة الأصلية.

padding_mask (`torch.Tensor` من الشكل `(batch_size, num_samples)`، *اختياري*) : قناع لعينات الصوت (`1`) على عكس الحشو (`0`)، والذي يُحسب منه `latents_mask`.

encoder_past_key_values (`Cache`، *اختياري*) : ذاكرة تخزين مؤقت للمفاتيح والقيم لمحوّل المُشفِّر، تُعاد من الاستدعاء السابق عند البث.

padding_cache (`PocketTTSAudioTokenizerConv1dPaddingCache`، *اختياري*) : ذاكرة مؤقتة لحشو الالتفافات السببية للمشفّر، تُعاد من الاستدعاء السابق عند البث.

use_streaming (`bool`، *اختياري*) : ما إذا كان سيتم الترميز في وضع البث، مع إرجاع الكاشات (caches) لتُمرَّر إلى الاستدعاء التالي.

يقوم بتشفير الصوت إلى كامنات مستمرة من الشكل `(batch_size, num_frames, latent_dim)`: وهي الكامنات الخاصة بـ [PocketTTSAudioTokenizerEncoderModel.forward()](/docs/transformers/main/ar/model_doc/pocket_tts_audio_tokenizer#transformers.PocketTTSAudioTokenizerEncoderModel.forward)، مع وضع الإطارات أولاً.

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

```python
decode(latents: Tensor, decoder_past_key_values: transformers.cache_utils.Cache | None = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

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

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

latents (`torch.Tensor` من الشكل `(batch_size, num_frames, latent_dim)`) : متغيرات مستمرة (latents) لفك الترميز، إطار واحد لكل `config.frame_size` من عينات الصوت.

decoder_past_key_values (`Cache`، *اختياري*) : ذاكرة تخزين مؤقت للمفاتيح والقيم لمحوّل المُفكِّك، تُعاد من الاستدعاء السابق عند فك الترميز على دفعات.

يفكك الكامنات المستمرة إلى صوت: تُسقط الكامنات إلى `hidden_size`، ثم تُفكك بواسطة [PocketTTSAudioTokenizerDecoderModel.forward()](/docs/transformers/main/ar/model_doc/pocket_tts_audio_tokenizer#transformers.PocketTTSAudioTokenizerDecoderModel.forward).

#### forward[[transformers.PocketTTSAudioTokenizerModel.forward]]

```python
forward(input_values: Tensor, padding_mask: typing.Optional[torch.Tensor] = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

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

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

input_values (`torch.Tensor` من الشكل `(batch_size, audio_channels, num_samples)`) : موجة صوتية، كما تُعاد بواسطة [EncodecFeatureExtractor](/docs/transformers/main/ar/model_doc/encodec#transformers.EncodecFeatureExtractor).

padding_mask (`torch.Tensor` من الشكل `(batch_size, num_samples)`، *اختياري*) : قناع لعينات الصوت (`1`) على عكس الحشو (`0`).

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

`PocketTTSAudioTokenizerOutput` أو مجموعة مرتبة من `torch.Tensor` (إذا تم تمرير `return_dict=False` أو عندما يكون `config.return_dict=False`) تتكون من عناصر مختلفة اعتماداً على الإعداد ([PocketTTSAudioTokenizerConfig](/docs/transformers/main/ar/model_doc/pocket_tts_audio_tokenizer#transformers.PocketTTSAudioTokenizerConfig)) والمدخلات.

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

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

- **latents** (`torch.Tensor` من الشكل `(batch_size, num_frames, latent_dim)`) -- متغيرات مستمرة للصوت.
- **latents_mask** (`torch.LongTensor` من الشكل `(batch_size, num_frames)`، *اختياري*) -- قناع للإطارات الكامنة المحسوبة من عينات الصوت (`1`) بدلاً من الحشو (`0`).
- **audio_values** (`torch.Tensor` من الشكل `(batch_size, audio_channels, num_samples)`) -- موجة الصوت المُعاد بناؤها من القيم الكامنة.
- **hidden_states** (`tuple(torch.Tensor)`، *اختياري*، يُعاد عند `output_hidden_states=True`) -- حالات المخفية لمحوّل المُشفِّر عند مخرج كل طبقة بالإضافة إلى مدخلاتها.
- **attentions** (`tuple(torch.Tensor)`، *اختياري*، يُعاد عند `output_attentions=True`) -- أوزان الانتباه لكل طبقة محوّل المُشفِّر.

## PocketTTSAudioTokenizerEncoderModel[[transformers.PocketTTSAudioTokenizerEncoderModel]]

#### transformers.PocketTTSAudioTokenizerEncoderModel[[transformers.PocketTTSAudioTokenizerEncoderModel]]

```python
transformers.PocketTTSAudioTokenizerEncoderModel(config: PocketTTSAudioTokenizerEncoderConfig)
```

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

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

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

النصف المُشفِّر من PocketTTSAudioTokenizer: مُشفِّر SEANet، ومحوّل المُشفِّر، والخفض، من الصوت إلى الكمّات المستمرة.

يرث هذا النموذج من [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 لكل ما يتعلق بالاستخدام العام والسلوك.

#### forward[[transformers.PocketTTSAudioTokenizerEncoderModel.forward]]

```python
forward(input_values: Tensor, padding_mask: typing.Optional[torch.Tensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, padding_cache: transformers.models.pocket_tts_audio_tokenizer.modeling_pocket_tts_audio_tokenizer.PocketTTSAudioTokenizerConv1dPaddingCache | None = None, use_streaming: bool | None = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

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

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

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

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

past_key_values (`Cache`، *اختياري*) : حالات مخفية محسوبة مسبقًا (المفاتيح والقيم في كتل الانتباه الذاتي) لمحوّل المُشفِّر، تُستخدم لتسريع التشفير البثّي.

padding_cache (`PocketTTSAudioTokenizerConv1dPaddingCache`، *اختياري*) : ذاكرة مؤقتة للتباعد (Padding) للتموجات (Convolutions) السببية، تُستخدم للتشفير البثي (Streaming encoding).

use_streaming (`bool`، *اختياري*) : ما إذا كان سيتم الترميز في وضع البث، مع إرجاع الكاشات (caches) لتُمرَّر إلى الاستدعاء التالي.

يقوم بتشفير موجة الصوت المدخلة إلى كائنات مستمرة (latents) ذات الشكل `(batch_size, latent_dim, frames)`. --

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

`PocketTTSAudioTokenizerEncoderModelOutput` أو مجموعة مرتبة من `torch.Tensor` (إذا تم تمرير `return_dict=False` أو عندما يكون `config.return_dict=False`) وتتضمن عناصر مختلفة اعتماداً على الإعداد ([PocketTTSAudioTokenizerConfig](/docs/transformers/main/ar/model_doc/pocket_tts_audio_tokenizer#transformers.PocketTTSAudioTokenizerConfig)) والمدخلات.

تُعيد طريقة [PocketTTSAudioTokenizerEncoderModel](/docs/transformers/main/ar/model_doc/pocket_tts_audio_tokenizer#transformers.PocketTTSAudioTokenizerEncoderModel) الخاصة بالتقديم (forward) تعريف الطريقة الخاصة `__call__`.

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

- **latents** (`torch.Tensor` من الشكل `(batch_size, latent_dim, frames)`) -- متغيرات مستمرة للصوت، إطار واحد لكل `config.frame_size` من عينات الصوت.
- **past_key_values** (`Cache`، *اختياري*) -- حالات مخفية محسوبة مسبقًا (المفاتيح والقيم في كتل الانتباه الذاتي) لمحوّل المُشفِّر، تُعاد عند البث.
- **padding_cache** (`PocketTTSAudioTokenizerConv1dPaddingCache`، *اختياري*) -- ذاكرة مؤقتة للتبطين (Padding) للعمليات التلافيفية السببية في PocketTTSAudioTokenizerConv1d لدعم البث عبر تبطين الذاكرة المؤقتة.
- **hidden_states** (`tuple(torch.Tensor)`، *اختياري*، يُعاد عند `output_hidden_states=True`) -- حالات المخفية لمحوّل المُشفِّر عند مخرج كل طبقة بالإضافة إلى مدخلاتها.
- **attentions** (`tuple(torch.Tensor)`، *اختياري*، يُعاد عند `output_attentions=True`) -- أوزان الانتباه لكل طبقة محوّل المُشفِّر.

## PocketTTSAudioTokenizerDecoderModel[[transformers.PocketTTSAudioTokenizerDecoderModel]]

#### transformers.PocketTTSAudioTokenizerDecoderModel[[transformers.PocketTTSAudioTokenizerDecoderModel]]

```python
transformers.PocketTTSAudioTokenizerDecoderModel(config: PocketTTSAudioTokenizerDecoderConfig)
```

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

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

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

نصف المُفكِّك في PocketTTSAudioTokenizer: التوسيع، ومحوّل المُفكِّك، ومُفكِّك SEANet، من الكمونيات المستمرة إلى الصوت.

يرث هذا النموذج من [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 لكل ما يتعلق بالاستخدام العام والسلوك.

#### forward[[transformers.PocketTTSAudioTokenizerDecoderModel.forward]]

```python
forward(latents: Tensor, padding_mask: typing.Optional[torch.Tensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

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

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

latents (`torch.Tensor` من الشكل `(batch_size, hidden_size, frames)`) : كامنات مستمرة لفك الترميز، كما تم حسابها بواسطة [PocketTTSAudioTokenizerModel.decode()](/docs/transformers/main/ar/model_doc/pocket_tts_audio_tokenizer#transformers.PocketTTSAudioTokenizerModel.decode).

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

past_key_values (`Cache`، *اختياري*) : حالات مخفية محسوبة مسبقًا (المفاتيح والقيم في كتل الانتباه الذاتي) لمحوّل المُفكِّك، تُستخدم لتسريع فك الترميز التدفقي.

يفكك الإطارات المعطاة إلى موجة صوتية ناتجة. لاحظ أن الناتج قد يكون أكبر قليلاً من --

input. في هذه الحالة، يمكن حذف أي خطوات إضافية في النهاية. --

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

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

تُعيد طريقة [PocketTTSAudioTokenizerDecoderModel](/docs/transformers/main/ar/model_doc/pocket_tts_audio_tokenizer#transformers.PocketTTSAudioTokenizerDecoderModel) الخاصة بالتقديم (forward) تعريف الطريقة الخاصة `__call__`.

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

- **audio_values** (`torch.Tensor` من الشكل `(batch_size, audio_channels, num_samples)`، *اختياري*) -- قيم الصوت المُفكّكة، المُستخرجة باستخدام جزء المُفكّك في PocketTTSAudioTokenizer.
- **decoder_past_key_values** (`Cache`، *اختياري*) -- حالات مخفية محسوبة مسبقًا (المفاتيح والقيم في كتل الانتباه الذاتي) يمكن استخدامها لتسريع فك الترميز التسلسلي لمحوّل المُفكِّك. يتكوّن هذا عادةً من `past_key_values` التي يعيدها النموذج في مرحلة سابقة من فك الترميز، عندما يكون `use_cache=True` أو `config.use_cache=True`.

  سيُخرج النموذج نفس صيغة الكاش التي تُمرَّر كمدخل.

  إذا تم استخدام `past_key_values`، يمكن للمستخدم اختيارياً إدخال آخر `audio_values` أو `audio_codes (تلك التي لم تُعطَ حالات مفاتيحها السابقة لهذا النموذج).
- **hidden_states** (`tuple(torch.Tensor)`، *اختياري*، يُعاد عند `output_hidden_states=True`) -- حالات المخفية لمحوّل المُفكِّك عند مخرج كل طبقة بالإضافة إلى مدخلها.
- **attentions** (`tuple(torch.Tensor)`، *اختياري*، يُعاد عند `output_attentions=True`) -- أوزان الانتباه لكل طبقة محوّل المُفكِّك.