# SarvamMoE

SarvamMoE, [Sarvam AI](https://www.sarvam.ai/) tarafından geliştirilen 30B parametreli Mixture of Experts (MoE) dil modeli olan [Sarvam-30B](https://huggingface.co/sarvamai/sarvam-30b)'ın mimarisidir. Daha büyük kardeşi Sarvam-105B ise [SarvamMLA](./sarvam_mla) kullanır.

Temel mimari özellikler:

- QK normalizasyonu ve tam döner konum gömmelemeleri ile **Gruplanmış sorgu dikkati**.
- **Sparse Mixture of Experts**: 128 yönlendirilmiş uzman, token başına 6 aktif ve 1 paylaşılan uzman. İlk katman yoğun bir MLP kullanır.
- **Sigmoid yönlendirme**, uzman sapma düzeltmesi ve yönlendirilmiş ölçekleme faktörü ile.

Mimari, [GLM-4-MoE](./glm4_moe) ile aynıdır; yalnızca parametre ve yapılandırma adları farklıdır. Otomatik sınıflar, modeli GLM-4-MoE uygulamasıyla ([Glm4MoeModel](/docs/transformers/main/tr/model_doc/glm4_moe#transformers.Glm4MoeModel) ve [Glm4MoeForCausalLM](/docs/transformers/main/tr/model_doc/glm4_moe#transformers.Glm4MoeForCausalLM)) yükler, bu nedenle SarvamMoE'ye özgü olan tek sınıf [SarvamMoEConfig](/docs/transformers/main/tr/model_doc/sarvam_moe#transformers.SarvamMoEConfig)'tir. Yayınlanan kontrol noktaları, yükleme sırasında GLM-4-MoE adlarına, kaydetme sırasında ise orijinal adlarına dönüştürülür.

Aşağıdaki örnek, [AutoModelForCausalLM](/docs/transformers/main/tr/model_doc/auto#transformers.AutoModelForCausalLM) sınıfı ile metin üretmenin nasıl yapıldığını göstermektedir.

```python
from transformers import AutoModelForCausalLM, AutoTokenizer

tokenizer = AutoTokenizer.from_pretrained("sarvamai/sarvam-30b")
model = AutoModelForCausalLM.from_pretrained("sarvamai/sarvam-30b", device_map="auto")

messages = [{"role": "user", "content": "Explain the Pythagorean theorem in one sentence."}]
inputs = tokenizer.apply_chat_template(messages, add_generation_prompt=True, return_tensors="pt", return_dict=True)
output = model.generate(**inputs.to(model.device), max_new_tokens=64)
print(tokenizer.decode(output[0][inputs["input_ids"].shape[1] :], skip_special_tokens=True))
```

## SarvamMoEConfig[[transformers.SarvamMoEConfig]]

#### transformers.SarvamMoEConfig[[transformers.SarvamMoEConfig]]

```python
transformers.SarvamMoEConfig(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, vocab_size: int = 262144, hidden_size: int = 4096, intermediate_size: int = 8192, num_hidden_layers: int = 19, num_attention_heads: int = 64, num_key_value_heads: int = 4, hidden_act: str = 'silu', max_position_embeddings: int = 131072, initializer_range: float = 0.006, rms_norm_eps: float = 1e-06, use_cache: bool = True, tie_word_embeddings: bool = False, rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None, attention_bias: bool = False, attention_dropout: float | int = 0.0, moe_intermediate_size: int = 1024, num_experts_per_tok: int = 6, output_router_logits: bool = False, n_shared_experts: int = 1, n_routed_experts: int = 128, routed_scaling_factor: float = 2.5, n_group: int = 1, topk_group: int = 1, first_k_dense_replace: int = 1, norm_topk_prob: bool = True, use_qk_norm: bool = True, bos_token_id: int | None = None, eos_token_id: int | list[int] | None = 1, pad_token_id: int | None = 0, num_mtp_layers: int = 0, head_dim: int = 64)
```

[Kaynak](https://github.com/huggingface/transformers/blob/main/src/transformers/models/sarvam_moe/configuration_sarvam_moe.py#L30)

**Parametreler:**

vocab_size (`int`, *isteğe bağlı*, varsayılan `262144`) : Modelin sözlük boyutu. `input_ids` tarafından temsil edilebilecek farklı token sayısını tanımlar.

hidden_size (`int`, *isteğe bağlı*, varsayılan `4096`) : Gizli temsillerin boyutu.

intermediate_size (`int`, *isteğe bağlı*, varsayılan `8192`) : MLP temsillerinin boyutu.

num_hidden_layers (`int`, *isteğe bağlı*, varsayılan `19`) : Transformer decoder'ındaki gizli katman sayısı.

num_attention_heads (`int`, *isteğe bağlı*, varsayılan `64`) : Transformer decoder'ındaki her dikkat katmanı için dikkat başı sayısı.

num_key_value_heads (`int`, *opsiyonel*, varsayılan `4`) : Grouped Query Attention'ı uygulamak için kullanılması gereken key_value başlarının sayısıdır. `num_key_value_heads=num_attention_heads` ise model Multi Head Attention (MHA) kullanır, `num_key_value_heads=1` ise model Multi Query Attention (MQA) kullanır, aksi halde GQA kullanılır. Çok başlı bir checkpoint'i GQA checkpoint'ine dönüştürürken, her grup key ve value başı, o gruptaki tüm orijinal başların ortalama havuzlanması (meanpooling) ile oluşturulmalıdır. Daha fazla ayrıntı için [bu makaleye](https://huggingface.co/papers/2305.13245) göz atın. Belirtilmezse, varsayılan olarak `num_attention_heads` kullanılır.

hidden_act (`str`, *isteğe bağlı*, varsayılan `silu`) : Dekoderdeki doğrusal olmayan aktivasyon fonksiyonu (fonksiyon veya dize). Örneğin, `"gelu"`, `"relu"`, `"silu"` vb.

max_position_embeddings (`int`, *isteğe bağlı*, varsayılan `131072`) : Bu modelin kullanılabileceği maksimum dizi uzunluğu.

initializer_range (`float`, *opsiyonel*, varsayılan `0.006`) : Tüm ağırlık matrislerini başlatmak için kullanılan truncated_normal_initializer'ın standart sapması.

rms_norm_eps (`float`, *opsiyonel*, varsayılan `1e-06`) : rms normalizasyon katmanları tarafından kullanılan epsilon.

use_cache (`bool`, *isteğe bağlı*, varsayılan `True`) : Modelin son anahtar/değer dikkatlerini döndürüp döndürmeyeceğini belirtir (tüm modellerde kullanılmaz). Yalnızca `config.is_decoder=True` olduğunda veya model yalnızca çözücü tabanlı üretken bir model olduğunda geçerlidir.

tie_word_embeddings (`bool`, *isteğe bağlı*, varsayılan `False`) : Ağırlık gömme bağlamalarının, modelin `tied_weights_keys` eşlemesine göre yapılıp yapılmayacağını belirtir.

rope_parameters (`Union[~modeling_rope_utils.RopeParameters, dict]`, *isteğe bağlı*) : RoPE gömme yapılandırma parametrelerini içeren sözlük. Sözlük, `rope_theta` için bir değer içermeli ve daha uzun `max_position_embeddings` ile RoPE kullanmak istiyorsanız ölçekleme için kullanılan parametreleri isteğe bağlı olarak içermelidir.

attention_bias (`bool`, *isteğe bağlı*, varsayılan `False`) : Kendi kendine dikkat (self-attention) sırasında sorgu, anahtar, değer ve çıktı projeksiyon katmanlarında sapma (bias) kullanılıp kullanılmayacağı.

attention_dropout (`Union[float, int]`, *isteğe bağlı*, varsayılan `0.0`) : Dikkat olasılıkları için dropout oranı.

moe_intermediate_size (`int`, *isteğe bağlı*, varsayılan `1024`) : Yönlendirilmiş uzman MLP'lerinin ara boyutu.

num_experts_per_tok (`int`, *isteğe bağlı*, varsayılan `6`) : Her jetonu yönlendirilecek uzman sayısı. Bu, jeton seçimli yönlendirmenin top-k değeridir.

output_router_logits (`bool`, *isteğe bağlı*, varsayılan `False`) : Modelin router logit'lerini döndürüp döndürmeyeceğini belirtir. Bu özellik etkinleştirildiğinde, modelin yük dengeleme kaybı ve router z-kaybı dahil olmak üzere yardımcı kaybı (auxiliary loss) da çıkarmasına olanak tanınır.

n_shared_experts (`int`, *isteğe bağlı*, varsayılan `1`) : Paylaşılan uzman sayısı.

n_routed_experts (`int`, *isteğe bağlı*, varsayılan `128`) : Yönlendirilen uzman sayısı.

routed_scaling_factor (`float`, *isteğe bağlı*, varsayılan `2.5`) : Ölçekleme faktörü veya yönlendirilmiş uzmanlar.

n_group (`int`, *isteğe bağlı*, varsayılan 1) : Yönlendirilmiş uzmanlar için grup sayısı.

topk_group (`int`, *opsiyonel*, varsayılan `1`) : Her token için seçilen grup sayısı (her token için, seçilen uzmanların yalnızca `topk_group` grup içinde olmasını sağlar).

first_k_dense_replace (`int`, *opsiyonel*, varsayılan 1) : Shallow katmanlardaki (embed->dense->moe->moe...->lm_head) yoğun katman sayısı. \--k yoğun katman--/

norm_topk_prob (`bool`, *isteğe bağlı*, varsayılan `True`) : Yönlendirilen uzmanların ağırlıklarının normalize edilip edilmeyeceğini belirtir.

use_qk_norm (`bool`, *isteğe bağlı*, varsayılan `True`) : Dikkat mekanizmasında sorgu-anahtar normalizasyonunun kullanılıp kullanılmayacağı.

bos_token_id (`int`, *isteğe bağlı*) : Sözlükte akış başlangıcı için kullanılan token kimliği.

eos_token_id (`Union[int, list[int]]`, *isteğe bağlı*, varsayılan `1`) : Sözlükte akış sonu için kullanılan token kimliği.

pad_token_id (`int`, *isteğe bağlı*, varsayılan `0`) : Sözlükte dolgu için kullanılan token kimliği.

num_mtp_layers (`int`, *isteğe bağlı*, varsayılan 0) : Temel dönüştürücü modelin sonuna eklenmesi için kullanılabilir Multi-Token Prediction (MTP) modüllerinin sayısı. Yayınlanan denetim noktaları MTP ağırlıklarını içermez.

head_dim (`int`, *isteğe bağlı*, varsayılan `64`) : Dikkat başı boyutu. None ise, hidden_size // num_attention_heads varsayılan olarak kullanılır

Bu, bir Glm4MoeModel yapılandırmasını depolamak için kullanılan yapılandırma sınıfıdır. Belirtilen argümanlara göre bir Sarvam Moe modelinin örneklenmesi için kullanılır ve model mimarisini tanımlar. Varsayılanlarla bir yapılandırma örneği oluşturmak, [sarvamai/sarvam-30b](https://huggingface.co/sarvamai/sarvam-30b) ile benzer bir yapılandırmaya yol açar.

Yapılandırma nesneleri [PreTrainedConfig](/docs/transformers/main/tr/main_classes/configuration#transformers.PreTrainedConfig) sınıfından türetilir ve model çıktılarını kontrol etmek için kullanılabilir. Daha fazla bilgi için [PreTrainedConfig](/docs/transformers/main/tr/main_classes/configuration#transformers.PreTrainedConfig) belgesini okuyun.

Örnek:

```python
>>> from transformers import AutoModelForCausalLM, SarvamMoEConfig

>>> # Initializing a Sarvam-30B style configuration
>>> configuration = SarvamMoEConfig()

>>> # Initializing a model (which uses the GLM-4-MoE implementation) from that configuration
>>> model = AutoModelForCausalLM.from_config(configuration)

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

