Transformers documentation

Beam

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

and get access to the augmented documentation experience

to get started

Bu model, 2026-10-16 tarihinde Hugging Face Transformers'a katkıda bulunulmuştur.

FlashAttention SDPA Tensor parallelism Expert parallelism

Beam

Genel Bakış

Beam, Reflection’ın ilk açık ağırlıklı modelidir; 501B toplam parametreye ve token başına 23B aktif parametreye sahip, kodlama, akıl yürütme ve ajan tabanlı iş yükleri için geliştirilmiş seyrek uzman karışımı (MoE) bir dil modelidir. 23,8T token üzerinde ön eğitimden geçirilmiş ve büyük ölçekli asenkron pekiştirmeli öğrenme ile son eğitimden geçirilmiştir. Beam yalnızca metin tabanlıdır ve her yanıtından önce akıl yürütür. Sohbet şablonundaki bir akıl yürütme çabası ayarı, bu sürecin ne kadar süreceğini kontrol eder.

Beam, 52 çözücü katmanına sahiptir ve aşağıdaki özellikleri birleştirir:

  • Hibrit kayan ve tam dikkat. Her altıncı katman ve son katman tam dikkat kullanırken, diğerleri en son sliding_window (512) token'a dikkat eder. layer_types bu deseni belirler.
  • Kayan katmanlarda RoPE, tam katmanlarda NoPE. rope_parameters anahtarı katman türüne göre belirlenir ve None, konumsal kodlaması olmayan bir katman türünü belirtir. Tam dikkat katmanları sorguları ölçekler (ölçeklenebilir softmax): 1 tabanlı n konumundaki sorgu, bağlam büyüdükçe dikkatin düzleşmesini önleyen (1 + n / 2048) ** 0.1 ile çarpılır.
  • Gated attention. 48 sorgu başlığı ve 8 anahtar/değer başlığına sahip gruplu sorgu dikkati (grouped-query attention) ve her sorgu ve anahtar başlığı için RMSNorm. Dikkat girdisinden hesaplanan, başlık başına öğrenilmiş bir önyüklemeye sahip sigmoid kapısı, çıktı projeksiyonundan önce dikkat çıktısını öğe bazlı olarak ölçekler.
  • Sparse MoE. İlk 3 katman yoğun SwiGLU MLP kullanırken, kalan 49 katman her token'ı 256 uzman arasından 8'ine yönlendirir ve ortak uzman bulunmaz (mlp_layer_types deseni belirler). Router, uzmanları sigmoid ile puanlar, ek bir kayıp yerine öğrenilen uzman başına bir önyargı ile yükü dengeleyerek her token'ı n_group uzman grubundan en iyi topk_group grubuyla sınırlar. Yönlendirme ağırlıkları normalize edilir ve MoE çıktısı routed_scaling_factor ile ölçeklenir.
  • Derinlik ölçekli artıklar ile sandviç normları. Her dikkat ve MLP bloğu, önce ve sonra bir RMSNorm ile sarılır. Artık eklemeleri yeniden ölçeklenir, böylece k katkıdan (gömülmeler ilk olarak sayılır) sonra, artık akışı bu katkıların toplamının sqrt(k) ile bölünmüşüne eşit olur.
  • Son logit yumuşak sınırlama. Logitler 30 * tanh(logits / 30) ile sınırlandırılır (final_logit_softcapping).

Uygulama, Beam'in eğitildiği ve sunulduğu sayısal değerlerle eşleşmesi için RMSNorm ölçeklemesini, SwiGLU aktivasyonunu, RoPE'yi, sorgu ölçeklemesini, yönlendirmeyi ve softcapping'i FP32'de hesaplar. Yönlendirici ağırlıkları ve uzman sapması, yükleme sırasında FP32'de tutulur ve döndürülen logits her zaman FP32'dir.

Tüm orijinal Beam kontrol noktalarını Reflection kuruluşu altında bulabilirsiniz.

Bu model yonigozlan tarafından katkıda bulunmuştur.

Kullanım örnekleri

Beam’in sohbet şablonu, konuşmaları Beam’in Harmony biçiminde biçimlendirir ve yanıt şablonu, üretilen metni thinking, content ve tool_calls alanlarına sahip bir mesaja geri ayrıştırır. Aşağıdaki örnekler, bir yanıtı Pipeline veya AutoModelForCausalLM sınıfı ile oluşturur.

BF16 checkpoint yaklaşık 1 TB olduğundan, örnekler expert parallelism kullanarak onu 8 cihaz arasında paylaştırır ve her cihaza tam bir routed expert yerleştirir. Onları torchrun --nproc-per-node 8 <script.py> ile başlatın.

Pipeline
AutoModel
from transformers import DistributedConfig, pipeline

pipe = pipeline(
    task="text-generation",
    model="reflection/Beam-1.0-501B-A23B",
    model_kwargs={"distributed_config": DistributedConfig(tp_size=8, ep_size=8)},
)

messages = [{"role": "user", "content": "Explain in one sentence why the sky is usually blue."}]
output = pipe(messages, max_new_tokens=2048)
reply = output[0]["generated_text"][-1]
print(reply["thinking"])
print(reply["content"])

Bütün katmanları her cihaza yerleştiren, cihazları sırayla çalıştıran ve yükleme sırasında bellek yetersizliği yaşayabilen device_map="auto" yerine bunu tercih edin.

Beam’in önerdiği temperature=0.7 ve top_p=0.99 değerleriyle üretim örnekleri alın; bu değerler checkpoint’in GenerationConfig tarafından varsayılan olarak ayarlanır. Açgözlü çözümleme yapmak için do_sample=False parametresini iletin.

Mantıksal çaba

Beam'in ne kadar akıl yürüteceğini kontrol etmek için reasoning_effort değerini apply_chat_template() fonksiyonuna iletin. Bu parametre, bir tamsayı bütçesini veya aşağıdaki etiketlerden birini kabul eder. Beam, 8'in altındaki çabalarla eğitilmediğinden daha küçük değerler dikkate alınmaz.

Etiketminimallowmediumhighxhighmax
Efor83264128256512

reasoning_effort ayarlanmadığında şablon max değerini kullanır. max_new_tokens akıl yürütme sırasında tükendiğinde, ayrıştırılan mesajda thinking alanı bulunur ancak content alanı yoktur.

Çok turlu sohbetler

Ayrıştırılan mesajı geçmişe olduğu gibi ekleyin. Beam, önceki akıl yürütmesi olmadan çıktısını bozar; sohbet şablonu bunu thinking alanından okur (reasoning_content ve reasoning de kabul edilir). Varsayılan olarak, akıl yürütme içermeyen bir asistan turu boş bir akıl yürütme bloğuyla oluşturulur. add_generation_prompt=True olduğunda, Beam sunarken önerilen davranış olarak, bunun yerine hata fırlatmak için allow_missing_thinking=False parametresini iletin.

messages.append(message)
messages.append({"role": "user", "content": "And why are sunsets red?"})
inputs = tokenizer.apply_chat_template(
    messages, add_generation_prompt=True, return_tensors="pt", return_dict=True
).to(model.device)

Araç çağrısı

tools hem apply_chat_template() hem de parse_response() fonksiyonlarına aktarın. tools kullanıldığında, ayrıştırılan argümanlar her aracın şemasındaki türlere dönüştürülür; kullanılmadığında ise tüm argümanlar birer dizgedir.

def get_weather(city: str):
    """
    Get the current weather in a city.

    Args:
        city: The city name.
    """
    return "Sunny, 22 C"


messages = [{"role": "user", "content": "What's the weather like in Paris right now?"}]
inputs = tokenizer.apply_chat_template(
    messages, tools=[get_weather], add_generation_prompt=True, return_tensors="pt", return_dict=True
).to(model.device)
outputs = model.generate(**inputs, max_new_tokens=2048)
generated = tokenizer.decode(outputs[0, inputs["input_ids"].shape[1] :])
message = tokenizer.parse_response(generated, prefix=inputs["input_ids"][0], tools=[get_weather])
print(message["tool_calls"])
# [{'type': 'function', 'function': {'name': 'get_weather', 'arguments': {'city': 'Paris'}}}]

messages.append(message)
for call in message["tool_calls"]:
    result = get_weather(**call["function"]["arguments"])
    messages.append({"role": "tool", "name": call["function"]["name"], "content": result})

Ardından nihai yanıtı almak için messages üzerinden yeniden üretin. Çözümlenmiş araç çağrıları id içermez ve biçim, sonuçları çağrılara konuma göre eşleştirir; bu nedenle araç sonuçlarını çağrıların sırasıyla döndürün. Üretim, nihai bir yanıt (<|return|>) veya bir araç çağrısı (<|call|>) sonrasında durur; generation_config.json her ikisini de listeler.

Akış için, get_response_parser() üretildikçe metin parçalarını feed() ile besleyebileceğiniz bir ayrıştırıcı döndürür. Daha fazla ayrıntı için Yanıt ayrıştırma bölümüne bakın.

Notlar

  • Şablon argümanları. reasoning_effort'ın yanı sıra sohbet şablonu, model_identity (sistem mesajının ilk satırını değiştirir), builtin_tools ve allow_missing_thinking değerlerini kabul eder. builtin_tools, yalnızca search ve browse araçlarını ve yalnızca Beam'in eğitildiği tanımlarla birlikte adlandırmalıdır. Diğer araçlar için yalnızca tools yeterlidir. system ve developer mesajları yalnızca konuşmanın başında işlenir.
  • Eğitim. Sohbet şablonu, apply_chat_template(..., return_dict=True, return_assistant_tokens_mask=True) ile asistan çıktısını işaretler; bu sayede TRL’nin SFTConfig(assistant_only_loss=True) ayarı yalnızca asistan jetonları üzerinde eğitim yapar. Maske, her asistan turundaki akıl yürütme, yanıt ve araç çağrılarını kapsar.
  • Yardımcı kayıp yok. Router, uzman yükünü önyargısı aracılığıyla dengelediği için BeamForCausalLM yük dengeleme kaybı hesaplamaz. output_router_logits=True yine de router logitlerini döndürür.

BeamConfig

sınıf transformers.BeamConfig

< >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonevocab_size: int = 151936hidden_size: int = 5120intermediate_size: int = 20480num_hidden_layers: int = 52num_attention_heads: int = 48num_key_value_heads: int = 8hidden_act: str = 'silu'max_position_embeddings: int = 8192initializer_range: float = 0.02rms_norm_eps: float = 1e-06use_cache: bool = Truetie_word_embeddings: bool = Falserope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = Noneattention_bias: bool = Falsesliding_window: int | None = 512attention_dropout: float | int = 0.0moe_intermediate_size: int = 2560num_experts_per_tok: int = 8num_experts: int = 256norm_topk_prob: bool = Trueoutput_router_logits: bool = Falsepad_token_id: int | None = Nonebos_token_id: int | None = Noneeos_token_id: int | list[int] | None = Nonehead_dim: int = 128layer_types: list[str] | None = Nonemlp_layer_types: list[str] | None = Nonen_group: int | None = 8topk_group: int | None = 4routed_scaling_factor: int | float = 2.5final_logit_softcapping: int | float | None = 30.0 )

Parametreler

  • vocab_size (int, isteğe bağlı, varsayılan 151936) — 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 5120) — Gizli temsillerin boyutu.
  • intermediate_size (int, isteğe bağlı, varsayılan 20480) — MLP temsillerinin boyutu.
  • num_hidden_layers (int, isteğe bağlı, varsayılan 52) — Transformer çözücüdeki gizli katman sayısı.
  • num_attention_heads (int, isteğe bağlı, varsayılan 48) — Transformer decoder'ındaki her dikkat katmanı için dikkat başı sayısı.
  • num_key_value_heads (int, isteğe bağlı, varsayılan 8) — Bu, Grouped Query Attention uygulamasında kullanılacak 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 göz atın. Belirtilmezse, varsayılan olarak num_attention_heads kullanılır.
  • hidden_act (str, isteğe bağlı, varsayılan silu) — Çözücüdeki doğrusal olmayan aktivasyon fonksiyonu (fonksiyon veya dize). Örneğin, "gelu", "relu", "silu" vb.
  • max_position_embeddings (int, isteğe bağlı, varsayılan 8192) — Bu modelin kullanılabileceği en uzun dizi uzunluğu.
  • initializer_range (float, isteğe bağlı, varsayılan 0.02) — Tüm ağırlık matrislerini başlatmak için kullanılan truncated_normal_initializer'ın standart sapması.
  • rms_norm_eps (float, isteğe bağlı, 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 (tüm modellerde kullanılmaz) döndürüp döndürmeyeceği. 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) — Modelin tied_weights_keys eşlemesine göre ağırlık gömme bağlamalarının yapılıp yapılmayacağı.
  • 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 ve daha uzun max_position_embeddings ile RoPE kullanmak istiyorsanız ölçekleme için kullanılan isteğe bağlı parametreleri içermelidir.
  • attention_bias (bool, isteğe bağlı, varsayılan False) — Öz-dikkat sırasında sorgu, anahtar, değer ve çıktı projeksiyon katmanlarında önyargı (bias) kullanılıp kullanılmayacağı.
  • sliding_window (int, isteğe bağlı, varsayılan 512) — Kayan pencere dikkat penceresi boyutu. None ise kayan pencere uygulanmaz.
  • 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 2560) — Yönlendirilen uzman MLP'lerinin ara boyutu.
  • num_experts_per_tok (int, isteğe bağlı, varsayılan 8) — Her tokenın yönlendirileceği uzman sayısı. Bu, token seçimli yönlendirmede top-k değeridir.
  • num_experts (int, isteğe bağlı, varsayılan 256) — MoE katmanlarındaki yönlendirilen uzman sayısı.
  • norm_topk_prob (bool, isteğe bağlı, varsayılan True) — Yönlendirilen uzmanların ağırlıklarının normalize edilip edilmeyeceği.
  • output_router_logits (bool, isteğe bağlı, varsayılan False) — Modelin router logits'lerini döndürüp döndürmeyeceği. Bu özelliğin etkinleştirilmesi, modelin yük dengeleme kaybı ve router z-kaybı dahil olmak üzere yardımcı kaybı da çıkarmasına olanak tanır.
  • pad_token_id (int, isteğe bağlı) — Sözlükte dolgu için kullanılan token kimliği.
  • 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ı) — Sözlükte akış sonu için kullanılan token kimliği.
  • head_dim (int, isteğe bağlı, varsayılan 128) — Dikkat başlığı boyutu. None ise, varsayılan olarak hidden_size // num_attention_heads değerini alır.
  • layer_types (list[str], isteğe bağlı) — Her katman indeksini ilgili katman türüyle açıkça eşleyen bir liste. Sağlanmazsa, config değerlerine göre otomatik olarak oluşturulur.
  • mlp_layer_types (list[str], isteğe bağlı) — Katman başına MLP tipi, SwiGLU MLP için "dense" veya MoE bloğu için "sparse". Uzunluk num_hidden_layers ile eşit olmalıdır. Varsayılan olarak üç yoğun katman ardından seyrek katmanlar gelir.
  • n_group (int, isteğe bağlı, varsayılan 8) — Yönlendirilen uzmanlar için grup sayısı.
  • topk_group (int, isteğe bağlı, varsayılan 4) — 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).
  • routed_scaling_factor (Union[int, float], isteğe bağlı, varsayılan 2.5) — Ölçekleme faktörü veya yönlendirilen uzmanlar.
  • final_logit_softcapping (Union[int, float], isteğe bağlı, varsayılan 30.0) — Olasılık dağılımı hesaplanmadan önce son logitslere uygulanan yumuşak sınırlama değeri. Logitsler tanh(logit / cap) * cap ile ölçeklenir.

Bu, bir BeamModel yapılandırmasını depolamak için kullanılan yapılandırma sınıfıdır. Belirtilen argümanlara göre bir Beam modelini örneklemek ve model mimarisini tanımlamak için kullanılır. Varsayılanlarla bir yapılandırma örneği oluşturmak, reflection/Beam-1.0-501B-A23B modelinin yapılandırmasına benzer bir yapılandırma üretir.

Yapılandırma nesneleri PreTrainedConfig sınıfından devralır ve model çıktılarını kontrol etmek için kullanılabilir. Daha fazla bilgi için PreTrainedConfig belgesini okuyun.

>>> from transformers import BeamConfig

>>> # Initializing a Beam configuration
>>> configuration = BeamConfig()

BeamModel

sınıf transformers.BeamModel

< >

( config: BeamConfig )

Parametreler

  • config (BeamConfig) — Modelin tüm parametrelerini içeren model yapılandırma sınıfı. Bir yapılandırma dosyasıyla başlatmak, modelle ilişkili ağırlıkları yüklemez, yalnızca yapılandırmayı yükler. Model ağırlıklarını yüklemek için from_pretrained() yöntemine bakın.

Üzerinde herhangi bir özel head olmadan ham hidden-state'ler üreten çıplak Beam Model.

Bu model PreTrainedModel sınıfından devralır. Kütüphanenin tüm modelleri için uyguladığı genel yöntemler (indirme veya kaydetme, giriş gömme boyutlarını yeniden boyutlandırma, başları budama vb.) için üst sınıf belgelendirmesine bakın.

Bu model aynı zamanda bir PyTorch torch.nn.Module alt sınıfıdır. Bunu standart bir PyTorch Module olarak kullanın ve genel kullanım ve davranışla ilgili tüm konular için PyTorch dokümantasyonuna başvurun.

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → MoeModelOutputWithPast or tuple(torch.Tensor)

Parametreler

  • input_ids (torch.LongTensor şeklinde (batch_size, sequence_length), isteğe bağlı) — Sözlükteki girdi dizisi belirteçlerinin (token) indeksleri. Varsayılan olarak dolgu (padding) yok sayılır.

    Dizinler AutoTokenizer kullanılarak elde edilebilir. Ayrıntılar için PreTrainedTokenizer.encode() ve PreTrainedTokenizer.call() konularına bakın.

    Girdi kimlikleri nelerdir?

  • attention_mask (torch.Tensor şeklinde (batch_size, sequence_length), isteğe bağlı) — Doldurma (padding) token indekslerinde dikkat (attention) işlemi yapmaktan kaçınmak için kullanılan maske. Seçilen maske değerleri [0, 1]:
    • 1, maskelenmemiş jetonlar için,
    • maskelenmiş jetonlar için 0.

    Dikkat maskeleri nedir?

  • position_ids (torch.LongTensor şeklinde (batch_size, sequence_length), isteğe bağlı) — Girdi dizilerindeki her token'ın konum gömme (position embedding) içindeki konum indeksleri. Seçim aralığı [0, config.n_positions - 1].

    Pozisyon kimlikleri nedir?

  • past_key_values (~cache_utils.Cache, isteğe bağlı) — Sıralı çözümlemeyi hızlandırmak için kullanılabilen önceden hesaplanmış gizli durumlar (self-attention ve cross-attention bloklarındaki anahtar ve değerler). Bu genellikle past_key_values değerinin, çözümlemenin önceki bir aşamasında model tarafından döndürülen use_cache=True veya config.use_cache=True.

    Girdi olarak yalnızca Cache örneği kabul edilir, kv cache kılavuzumuza bakın. past_key_values geçirilmezse, varsayılan olarak DynamicCache başlatılır.

    Model, girdi olarak verilen aynı önbellek biçimini çıktı olarak üretecektir.

    past_key_values kullanılıyorsa, kullanıcının tüm input_ids (şekli (batch_size, sequence_length)) yerine, bu modele geçmiş anahtar değer durumları verilmemiş olan, işlenmemiş input_ids (şekli (batch_size, unprocessed_length)) girmesi beklenir.

  • inputs_embeds (torch.Tensor, şekli (batch_size, sequence_length, hidden_size), isteğe bağlı) — İsteğe bağlı olarak, input_ids yerine gömülü bir temsil doğrudan geçmeyi tercih edebilirsiniz. Bu, input_ids dizinlerini ilgili vektörlere dönüştürme biçimi üzerinde modelin dahili gömme arama matrisinden daha fazla kontrol sahibi olmak istiyorsanız faydalıdır.
  • use_cache (bool, isteğe bağlı) — True olarak ayarlanırsa, past_key_values anahtar değer durumları döndürülür ve çözümlemeyi hızlandırmak için kullanılabilir (bkz. past_key_values).

Dönüş değeri

MoeModelOutputWithPast veya tuple(torch.Tensor)

MoeModelOutputWithPast veya bir torch.Tensor demeti (return_dict=False geçirildiğinde veya config.return_dict=False olduğunda), yapılandırmaya (BeamConfig) ve girdilere bağlı olarak çeşitli öğelerden oluşur.

BeamModel forward metodu, __call__ özel metodunu geçersiz kılar.

İleri geçiş tarifi bu fonksiyon içinde tanımlanmalı olsa da, sonrasında bunun yerine Module örneğini çağırmak gerekir; çünkü önceki, ön ve son işleme adımlarını çalıştırmaktan sorumluyken ikincisi bunları sessizce yok sayar.

  • last_hidden_state (torch.Tensor, şekli (batch_size, sequence_length, hidden_size)) — Modelin son katmanının çıktısındaki gizli durumlar dizisi.

  • past_key_values (Cache, isteğe bağlı, use_cache=True geçirildiğinde veya config.use_cache=True olduğunda döndürülür) — Bir Cache örneğidir. Daha fazla ayrıntı için kv cache kılavuzumuza bakın.

    Sıralı çözümlemeyi hızlandırmak için (bkz. past_key_values girdisi) kullanılabilen, önceden hesaplanmış gizli durumları (self-attention bloklarındaki anahtar ve değerler ve isteğe bağlı olarak config.is_encoder_decoder=True ise cross-attention bloklarındaki anahtar ve değerler) içerir.

  • hidden_states (tuple(torch.Tensor), isteğe bağlı, output_hidden_states=True geçirildiğinde veya config.output_hidden_states=True olduğunda döndürülür) — torch.Tensor (modelin bir gömme katmanı varsa gömme katmanının çıktısı için bir tane + her katmanın çıktısı için birer tane) içeren, (batch_size, sequence_length, hidden_size) biçiminde bir demet.

    Her katmanın çıktısında modelin gizli durumları ve isteğe bağlı başlangıç gömme çıktıları.

  • attentions (tuple(torch.Tensor), isteğe bağlı, output_attentions=True geçirildiğinde veya config.output_attentions=True olduğunda döndürülür) — torch.Tensor (katman başına bir tane) içeren bir tuple, şekli (batch_size, num_heads, sequence_length, sequence_length).

    Dikkat softmax'ı sonrası dikkat ağırlıkları, öz-dikkat başlıklarında ağırlıklı ortalamanın hesaplanmasında kullanılır.

  • router_logits (tuple(torch.Tensor), isteğe bağlı, output_router_probs=True ve config.add_router_probs=True geçirildiğinde veya config.output_router_probs=True olduğunda döndürülür) — torch.Tensor (katman başına bir tane) içeren bir tuple, şekli (batch_size, sequence_length, num_experts).

    MoE yönlendiricileri tarafından hesaplanan ham yönlendirici logitleri (softmax sonrası), bu terimler Mixture of Experts modelleri için yardımcı kaybı hesaplamakta kullanılır.

BeamForCausalLM

sınıf transformers.BeamForCausalLM

< >

( config: BeamConfig )

Parametreler

  • config (BeamConfig) — Modelin tüm parametrelerini içeren model yapılandırma sınıfı. Bir yapılandırma dosyasıyla başlatmak, modelle ilişkili ağırlıkları yüklemez, yalnızca yapılandırmayı yükler. Model ağırlıklarını yüklemek için from_pretrained() yöntemine bakın.

Nedensel dil modellemesi için Beam Model.

Bu model PreTrainedModel sınıfından devralır. Kütüphanenin tüm modelleri için uyguladığı genel yöntemler (indirme veya kaydetme, giriş gömme boyutlarını yeniden boyutlandırma, başları budama vb.) için üst sınıf belgelendirmesine bakın.

Bu model aynı zamanda bir PyTorch torch.nn.Module alt sınıfıdır. Bunu standart bir PyTorch Module olarak kullanın ve genel kullanım ve davranışla ilgili tüm konular için PyTorch dokümantasyonuna başvurun.

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.LongTensor] = Noneuse_cache: bool | None = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → MoeCausalLMOutputWithPast or tuple(torch.Tensor)

Parametreler

  • input_ids (torch.LongTensor şeklinde (batch_size, sequence_length), isteğe bağlı) — Sözlükteki girdi dizisi belirteçlerinin (token) indeksleri. Varsayılan olarak dolgu (padding) yok sayılır.

    Dizinler AutoTokenizer kullanılarak elde edilebilir. Ayrıntılar için PreTrainedTokenizer.encode() ve PreTrainedTokenizer.call() konularına bakın.

    Girdi kimlikleri nelerdir?

  • attention_mask (torch.Tensor şeklinde (batch_size, sequence_length), isteğe bağlı) — Doldurma (padding) token indekslerinde dikkat (attention) işlemi yapmaktan kaçınmak için kullanılan maske. Seçilen maske değerleri [0, 1]:
    • 1, maskelenmemiş jetonlar için,
    • maskelenmiş jetonlar için 0.

    Dikkat maskeleri nedir?

  • position_ids (torch.LongTensor şeklinde (batch_size, sequence_length), isteğe bağlı) — Girdi dizilerindeki her token'ın konum gömme (position embedding) içindeki konum indeksleri. Seçim aralığı [0, config.n_positions - 1].

    Pozisyon kimlikleri nedir?

  • past_key_values (~cache_utils.Cache, isteğe bağlı) — Sıralı çözümlemeyi hızlandırmak için kullanılabilen önceden hesaplanmış gizli durumlar (self-attention ve cross-attention bloklarındaki anahtar ve değerler). Bu genellikle past_key_values değerinin, çözümlemenin önceki bir aşamasında model tarafından döndürülen use_cache=True veya config.use_cache=True.

    Girdi olarak yalnızca Cache örneği kabul edilir, kv cache kılavuzumuza bakın. past_key_values geçirilmezse, varsayılan olarak DynamicCache başlatılır.

    Model, girdi olarak verilen aynı önbellek biçimini çıktı olarak üretecektir.

    past_key_values kullanılıyorsa, kullanıcının tüm input_ids (şekli (batch_size, sequence_length)) yerine, bu modele geçmiş anahtar değer durumları verilmemiş olan, işlenmemiş input_ids (şekli (batch_size, unprocessed_length)) girmesi beklenir.

  • inputs_embeds (torch.Tensor, şekli (batch_size, sequence_length, hidden_size), isteğe bağlı) — İsteğe bağlı olarak, input_ids yerine gömülü bir temsil doğrudan geçmeyi tercih edebilirsiniz. Bu, input_ids dizinlerini ilgili vektörlere dönüştürme biçimi üzerinde modelin dahili gömme arama matrisinden daha fazla kontrol sahibi olmak istiyorsanız faydalıdır.
  • labels (torch.LongTensor, şekli (batch_size, sequence_length), isteğe bağlı) — Maskeli dil modelleme kaybını hesaplamak için etiketler. Endeksler [0, ..., config.vocab_size] aralığında olmalı ya da -100 olmalı (input_ids docstring'ine bakın). Endeksleri -100 olarak ayarlanan tokenlar yok sayılır (maskelenir), kayıp yalnızca etiketleri [0, ..., config.vocab_size] aralığında olan tokenlar için hesaplanır.
  • use_cache (bool, isteğe bağlı) — True olarak ayarlanırsa, past_key_values anahtar değer durumları döndürülür ve çözümlemeyi hızlandırmak için kullanılabilir (bkz. past_key_values).
  • logits_to_keep (Union[int, torch.Tensor], isteğe bağlı, varsayılan 0) — int ise, son logits_to_keep token için logits hesaplanır. 0 ise, tüm input_ids için logits hesaplanır (özel durum). Üretim için yalnızca son token logits'leri gereklidir ve bunların yalnızca o token için hesaplanması bellek tasarrufu sağlar; bu, uzun diziler veya büyük sözlük boyutu için oldukça önemli hale gelir. torch.Tensor ise, dizi uzunluğu boyutundaki korunacak indekslere karşılık gelen 1B olmalıdır. Bu, paketlenmiş tensor biçimini (batch ve dizi uzunluğu için tek boyut) kullanırken faydalıdır.

Dönüş değeri

MoeCausalLMOutputWithPast veya tuple(torch.Tensor)

MoeCausalLMOutputWithPast veya bir torch.Tensor demeti (return_dict=False geçirildiğinde veya config.return_dict=False olduğunda), yapılandırmaya (BeamConfig) ve girdilere bağlı olarak çeşitli öğelerden oluşur.

BeamForCausalLM forward metodu, __call__ özel metodunu geçersiz kılar.

İleri geçiş tarifi bu fonksiyon içinde tanımlanmalı olsa da, sonrasında bunun yerine Module örneğini çağırmak gerekir; çünkü önceki, ön ve son işleme adımlarını çalıştırmaktan sorumluyken ikincisi bunları sessizce yok sayar.

  • loss (torch.Tensor, şekli (1,), isteğe bağlı, labels sağlandığında döndürülür) — Dil modelleme kaybı (sonraki token tahmini için).

  • logits (torch.Tensor, şekli (batch_size, sequence_length, config.vocab_size)) — Dil modelleme başlığının tahmin puanları (SoftMax öncesi her sözlük jetonu için puanlar).

  • aux_loss (torch.Tensor, isteğe bağlı, output_router_logits=True geçirildiğinde veya config.output_router_logits=True olduğunda ve model, yük dengeleme kaybı ile router'ını eğittiğinde döndürülür) — Seyrek modüller için yük dengeleme yardımcı kaybı. Uzmanlarını router sapması ile dengeleyen modeller (DeepSeek-V3 ve ondan türetilen mimariler) burada None döndürürken yine de router_logits döndürür.

  • router_logits (tuple(torch.Tensor), isteğe bağlı, output_router_logits=True geçirildiğinde veya config.output_router_logits=True olduğunda döndürülür) — torch.Tensor (her seyrek katman için bir tane) içeren bir tuple, şekli (batch_size * sequence_length, num_experts).

    MoE yönlendiricileri tarafından hesaplanan ham yönlendirici logitleri. Bunlar, bir yük dengeleme kaybı hesaplamak veya tokenlerin uzmanlara nasıl dağıtıldığını incelemek için kullanılabilir.

  • past_key_values (Cache, isteğe bağlı, use_cache=True geçirildiğinde veya config.use_cache=True olduğunda döndürülür) — Bir Cache örneğidir. Daha fazla ayrıntı için kv cache kılavuzumuza bakın.

    Sıralı çözümlemeyi hızlandırmak için (bkz. past_key_values girdisi) kullanılabilen, önceden hesaplanmış gizli durumları (self-attention bloklarındaki anahtar ve değerler) içerir.

  • hidden_states (tuple(torch.Tensor), isteğe bağlı, output_hidden_states=True geçirildiğinde veya config.output_hidden_states=True olduğunda döndürülür) — torch.Tensor (modelin bir gömme katmanı varsa gömme katmanının çıktısı için bir tane + her katmanın çıktısı için birer tane) içeren, (batch_size, sequence_length, hidden_size) biçiminde bir demet.

    Her katmanın çıktısında modelin gizli durumları ve isteğe bağlı başlangıç gömme çıktıları.

  • attentions (tuple(torch.Tensor), isteğe bağlı, output_attentions=True geçirildiğinde veya config.output_attentions=True olduğunda döndürülür) — torch.Tensor (katman başına bir tane) içeren bir tuple, şekli (batch_size, num_heads, sequence_length, sequence_length).

    Dikkat softmax'ı sonrası dikkat ağırlıkları, öz-dikkat başlıklarında ağırlıklı ortalamanın hesaplanmasında kullanılır.

Örnek:

Update on GitHub