Transformers documentation

PhiMoE

Transformers

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).

Join the Hugging Face community

and get access to the augmented documentation experience

Collaborate on models, datasets and Spaces

Faster examples with accelerated inference

Switch between documentation themes

to get started

Mô hình này được công bố trên HF papers vào ngày 2024-04-22 và được đóng góp cho Hugging Face Transformers vào ngày 2024-10-04.

PhiMoE

Tổng quan

Mô hình PhiMoE được đề xuất trong Báo cáo kỹ thuật Phi-3: Một mô hình ngôn ngữ có khả năng cao chạy cục bộ trên điện thoại của bạn do Microsoft thực hiện.

Tóm tắt

Tóm tắt từ bài báo về Phi-3 như sau:

Chúng tôi giới thiệu phi-3-mini, một mô hình ngôn ngữ có 3,8 tỷ tham số được huấn luyện trên 3,3 nghìn tỷ token, với hiệu suất tổng thể, được đo bằng cả các bộ chuẩn học thuật và kiểm thử nội bộ, sánh ngang với các mô hình như Mixtral 8x7B và GPT-3.5 (ví dụ, phi-3-mini đạt 69% trên MMLU và 8,38 trên MT-bench), mặc dù đủ nhỏ để triển khai trên điện thoại. Bộ dữ liệu huấn luyện của chúng tôi là phiên bản mở rộng của bộ dữ liệu được sử dụng cho phi-2, bao gồm dữ liệu web công khai được lọc kỹ và dữ liệu tổng hợp. Mô hình cũng được căn chỉnh thêm để tăng cường độ bền, an toàn và định dạng trò chuyện. Chúng tôi cũng cung cấp kết quả mở rộng tham số với các mô hình 7B, 14B được huấn luyện cho 4,8T token, gọi là phi-3-small, phi-3-medium, cả hai đều có khả năng vượt trội hơn đáng kể so với phi-3-mini (ví dụ, tương ứng 75%, 78% trên MMLU, và 8,7, 8,9 trên MT-bench). Để nâng cao khả năng đa ngôn ngữ, đa phương thức và ngữ cảnh dài, chúng tôi giới thiệu ba mô hình trong dòng phi-3.5: phi-3.5-mini, phi-3.5-MoE và phi-3.5-Vision. phi-3.5-MoE, một mô hình MoE 16 x 3.8B với 6,6 tỷ tham số hoạt động, đạt hiệu suất vượt trội trong các tác vụ suy luận ngôn ngữ, toán học và mã so với các mô hình mã nguồn mở khác ở quy mô tương tự, chẳng hạn như Llama 3.1 và dòng Mixtral, và ngang hàng với Gemini-1.5-Flash và GPT-4o-mini. Trong khi đó, phi-3.5-Vision, một mô hình 4,2 tỷ tham số được phát triển từ phi-3.5-mini, nổi bật trong các tác vụ suy luận và thành thạo trong việc xử lý cả các prompt gồm một hình ảnh và văn bản, cũng như các prompt gồm nhiều hình ảnh và văn bản.

Mã nguồn gốc của PhiMoE có thể được tìm thấy tại đây.

Mẹo sử dụng

Mô hình này rất giống với Mixtral, với sự khác biệt chính là Phi3LongRoPEScaledRotaryEmbedding, nơi chúng được sử dụng để mở rộng ngữ cảnh của các rotary embeddings. Query, key và values được hợp nhất, và các lớp projection up và gate của MLP cũng được hợp nhất.
Tokenizer được sử dụng cho mô hình này giống hệt với LlamaTokenizer, ngoại trừ việc có thêm các token bổ sung.

Cách sử dụng PhiMoE

Phi-3.5-MoE-instruct đã được tích hợp trong phiên bản phát triển (4.44.2.dev) của transformers. Cho đến khi phiên bản chính thức được phát hành qua pip, hãy đảm bảo bạn thực hiện các bước sau:

Khi tải mô hình, hãy đảm bảo rằng trust_remote_code=True được truyền như một đối số của hàm from_pretrained().

Phiên bản transformers hiện tại có thể được kiểm tra bằng: pip list | grep transformers.

Các ví dụ về các gói bắt buộc:
flash_attn==2.5.8
torch==2.3.1
accelerate==0.31.0
transformers==4.43.0

import torch
from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline 

torch.random.manual_seed(0) 

model = AutoModelForCausalLM.from_pretrained( 
    "microsoft/Phi-3.5-MoE-instruct",  
    device_map="auto",  ,
) 

tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3.5-MoE-instruct") 

messages = [ 
    {"role": "system", "content": "You are a helpful AI assistant."}, 
    {"role": "user", "content": "Can you provide ways to eat combinations of bananas and dragonfruits?"}, 
    {"role": "assistant", "content": "Sure! Here are some ways to eat bananas and dragonfruits together: 1. Banana and dragonfruit smoothie: Blend bananas and dragonfruits together with some milk and honey. 2. Banana and dragonfruit salad: Mix sliced bananas and dragonfruits together with some lemon juice and honey."}, 
    {"role": "user", "content": "What about solving an 2x + 3 = 7 equation?"}, 
] 

pipe = pipeline( 
    "text-generation", 
    model=model, 
    tokenizer=tokenizer, 
) 

generation_args = { 
    "max_new_tokens": 500, 
    "return_full_text": False, 
    "temperature": 0.0, 
    "do_sample": False, 
} 

output = pipe(messages, **generation_args) 
print(output[0]['generated_text'])

PhimoeConfig

lớp transformers.PhimoeConfig

< source >

( 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 = 32064hidden_size: int = 4096intermediate_size: int = 6400num_hidden_layers: int = 32num_attention_heads: int = 32num_key_value_heads: int = 8hidden_act: str = 'silu'max_position_embeddings: int = 131072initializer_range: float = 0.02rms_norm_eps: float = 1e-05use_cache: bool = Truepad_token_id: int | None = Nonebos_token_id: int | None = 1eos_token_id: int | list[int] | None = 2tie_word_embeddings: bool = Falserope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = Nonesliding_window: int | None = Noneattention_dropout: float | int = 0.0num_experts_per_tok: int = 2num_local_experts: int = 16output_router_logits: bool = Falserouter_aux_loss_coef: float = 0.001router_jitter_noise: float = 0.01input_jitter_noise: float = 0.0attention_bias: bool = Falselm_head_bias: bool = False )

Tham số

vocab_size (int, tuỳ chọn, mặc định là 32064) — Kích thước từ vựng của mô hình. Xác định số lượng token khác nhau có thể được biểu diễn bởi input_ids.
hidden_size (int, tùy chọn, mặc định là 4096) — Kích thước của các biểu diễn ẩn.
intermediate_size (int, tùy chọn, mặc định là 6400) — Kích thước của các biểu diễn MLP.
num_hidden_layers (int, tùy chọn, mặc định là 32) — Số lượng lớp ẩn trong bộ giải mã Transformer.
num_attention_heads (int, tùy chọn, mặc định là 32) — Số lượng đầu attention cho mỗi lớp attention trong bộ giải mã Transformer.
num_key_value_heads (int, tùy chọn, mặc định là 8) — Đây là số lượng key_value heads cần được sử dụng để triển khai Grouped Query Attention. Nếu num_key_value_heads=num_attention_heads, mô hình sẽ sử dụng Multi Head Attention (MHA), nếu num_key_value_heads=1 mô hình sẽ sử dụng Multi Query Attention (MQA), ngược lại sẽ sử dụng GQA. Khi chuyển đổi checkpoint multi-head sang checkpoint GQA, mỗi nhóm key và value head nên được xây dựng bằng cách meanpooling tất cả các head gốc trong nhóm đó. Để biết thêm chi tiết, hãy xem bài báo này. Nếu không được chỉ định, giá trị mặc định sẽ là num_attention_heads.
hidden_act (str, tùy chọn, mặc định là silu) — Hàm kích hoạt phi tuyến (hàm hoặc chuỗi) trong bộ giải mã. Ví dụ, "gelu", "relu", "silu", v.v.
max_position_embeddings (int, tùy chọn, mặc định là 131072) — Chiều dài chuỗi tối đa mà mô hình này có thể được sử dụng.
initializer_range (float, tùy chọn, mặc định là 0.02) — Độ lệch chuẩn của truncated_normal_initializer để khởi tạo tất cả các ma trận trọng số.
rms_norm_eps (float, tùy chọn, mặc định là 1e-05) — Giá trị epsilon được sử dụng bởi các lớp chuẩn hóa rms.
use_cache (bool, tùy chọn, mặc định là True) — Xác định xem mô hình có nên trả về các chú ý key/values cuối cùng hay không (không được sử dụng bởi tất cả các mô hình). Chỉ liên quan nếu config.is_decoder=True hoặc khi mô hình là mô hình sinh chỉ có decoder.
pad_token_id (int, tùy chọn) — Token id được sử dụng để đệm trong từ vựng.
bos_token_id (int, tùy chọn, mặc định là 1) — Token id được sử dụng cho beginning-of-stream trong bảng từ vựng.
eos_token_id (Union[int, list[int]], tùy chọn, mặc định là 2) — Token id được sử dụng cho end-of-stream trong bảng từ vựng.
tie_word_embeddings (bool, tùy chọn, mặc định là False) — Có nên gắn kết các trọng số nhúng theo ánh xạ tied_weights_keys của mô hình hay không.
rope_parameters (Union[~modeling_rope_utils.RopeParameters, dict], tùy chọn) — Từ điển chứa các tham số cấu hình cho các embedding RoPE. Từ điển phải chứa một giá trị cho rope_theta và tùy chọn các tham số được sử dụng để mở rộng trong trường hợp bạn muốn sử dụng RoPE với max_position_embeddings dài hơn.
sliding_window (int, tùy chọn) — Kích thước cửa sổ của cơ chế chú ý cửa sổ trượt. Nếu là None, sẽ không áp dụng cửa sổ trượt.
attention_dropout (Union[float, int], tùy chọn, mặc định là 0.0) — Tỷ lệ dropout cho các xác suất chú ý.
num_experts_per_tok (int, tuỳ chọn, mặc định là 2) — Số lượng chuyên gia để định tuyến mỗi token. Đây là giá trị top-k cho việc định tuyến chọn token.
num_local_experts (int, tùy chọn, mặc định là 16) — Số lượng chuyên gia cho mỗi lớp Sparse MLP.
output_router_logits (bool, tùy chọn, mặc định là False) — Xác định xem có nên trả về router logits từ mô hình hay không. Bật tùy chọn này cũng cho phép mô hình xuất ra tổn thất bổ trợ, bao gồm tổn thất cân bằng tải và router z-loss.
router_aux_loss_coef (float, tùy chọn, mặc định là 0.001) — Hệ số của tổn thất cân bằng tải phụ. Được sử dụng để phạt việc định tuyến chuyên gia không đồng đều trong các mô hình MoE.
router_jitter_noise (float, tùy chọn, mặc định là 0.01) — Lượng nhiễu cần thêm vào router logits trong quá trình huấn luyện để cân bằng tải tốt hơn.
input_jitter_noise (float, tùy chọn, mặc định là 0.0) — Tiếng ồn jitter đầu vào
attention_bias (bool, tùy chọn, mặc định là False) — Có sử dụng bias trong các lớp chiếu query, key, value và output trong quá trình tự chú ý hay không.
lm_head_bias (bool, tùy chọn, mặc định là False) — Bias của LM head

Đây là lớp cấu hình để lưu trữ cấu hình của một PhimoeModel. Nó được sử dụng để khởi tạo một mô hình Phimoe theo các đối số được chỉ định, xác định kiến trúc của mô hình. Khởi tạo một cấu hình với các giá trị mặc định sẽ tạo ra một cấu hình tương tự như cấu hình của microsoft/Phi-3.5-MoE-instruct

Các đối tượng cấu hình kế thừa từ PreTrainedConfig và có thể được sử dụng để kiểm soát đầu ra của mô hình. Đọc tài liệu từ PreTrainedConfig để biết thêm thông tin.

Ví dụ:

>>> from transformers import PhimoeModel, PhimoeConfig
>>> # Initializing a Phi-3 style configuration
>>> configuration = PhimoeConfig.from_pretrained("microsoft/Phi-3.5-MoE-instruct")
>>> # Initializing a model from the configuration
>>> model = PhimoeModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config

validate_rope

< source >

( )

Xác thực cấu hình rope_parameters.

PhimoeModel

lớp transformers.PhimoeModel

< source >

( config: PhimoeConfig )

Tham số

config (PhimoeConfig) — Lớp cấu hình mô hình chứa tất cả các tham số của mô hình. Khởi tạo bằng tệp cấu hình không tải trọng số liên quan đến mô hình, chỉ tải cấu hình. Xem phương thức from_pretrained() để tải trọng số của mô hình.

Mô hình Phimoe cơ bản, xuất ra các hidden-state thô mà không có bất kỳ head cụ thể nào ở phía trên.

Mô hình này kế thừa từ PreTrainedModel. Xem tài liệu của lớp cha để biết các phương thức chung mà thư viện triển khai cho tất cả các mô hình của nó (chẳng hạn như tải xuống hoặc lưu trữ, thay đổi kích thước các nhúng đầu vào, cắt tỉa các đầu, v.v.)

Mô hình này cũng là một lớp con của torch.nn.Module trong PyTorch. Hãy sử dụng nó như một Module PyTorch thông thường và tham khảo tài liệu PyTorch cho mọi vấn đề liên quan đến cách sử dụng và hành vi chung.

forward

< source >

( 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)

Tham số

input_ids (torch.LongTensor có dạng (batch_size, sequence_length), tùy chọn) — Chỉ số của các token trong chuỗi đầu vào theo từ điển. Mặc định, padding sẽ bị bỏ qua.
Các chỉ số có thể được lấy bằng cách sử dụng AutoTokenizer. Xem PreTrainedTokenizer.encode() và PreTrainedTokenizer.call() để biết thêm chi tiết.

ID đầu vào là gì?
attention_mask (torch.Tensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệm. Các giá trị mặt nạ được chọn trong [0, 1]:
- 1 cho các token không bị che,
- 0 cho các token bị che.
Mặt nạ chú ý là gì?
position_ids (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Chỉ số vị trí của các token trong mỗi chuỗi đầu vào trong các position embeddings. Được chọn trong khoảng [0, config.n_positions - 1].
ID vị trí là gì?
past_key_values (~cache_utils.Cache, tuỳ chọn) — Các hidden-state đã tính trước (key và value trong các khối self-attention và cross-attention) có thể được sử dụng để tăng tốc giải mã tuần tự. Điều này thường bao gồm past_key_values được trả về bởi mô hình ở một giai đoạn giải mã trước đó, khi use_cache=True hoặc config.use_cache=True.
Chỉ cho phép Cache instance làm đầu vào, xem hướng dẫn kv cache của chúng tôi. Nếu không truyền past_key_values, DynamicCache sẽ được khởi tạo theo mặc định.

Mô hình sẽ xuất ra cùng định dạng cache được đưa vào làm đầu vào.

Nếu past_key_values được sử dụng, người dùng được kỳ vọng chỉ nhập input_ids chưa được xử lý (những phần chưa có trạng thái key value quá khứ được cung cấp cho mô hình này) có hình dạng (batch_size, unprocessed_length) thay vì toàn bộ input_ids có hình dạng (batch_size, sequence_length).
inputs_embeds (torch.Tensor có hình dạng (batch_size, sequence_length, hidden_size), tùy chọn) — Tùy chọn, thay vì truyền input_ids, bạn có thể chọn truyền trực tiếp một biểu diễn nhúng. Điều này hữu ích nếu bạn muốn kiểm soát nhiều hơn cách chuyển đổi các chỉ số input_ids thành các vector liên quan so với ma trận tra cứu nhúng nội bộ của mô hình.
use_cache (bool, tùy chọn) — Nếu đặt thành True, các trạng thái key value của past_key_values sẽ được trả về và có thể được sử dụng để tăng tốc quá trình giải mã (xem past_key_values).

Trả về

MoeModelOutputWithPast hoặc tuple(torch.Tensor)

Một MoeModelOutputWithPast hoặc một tuple của torch.Tensor (nếu return_dict=False được truyền hoặc khi config.return_dict=False) bao gồm các thành phần khác nhau tùy thuộc vào cấu hình (PhimoeConfig) và đầu vào.

Phương thức forward của PhimoeModel ghi đè lên phương thức đặc biệt __call__.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, người dùng nên gọi instance của Module sau đó thay vì gọi hàm này, vì instance Module sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ lặng lẽ bỏ qua chúng.

last_hidden_state (torch.Tensor có hình dạng (batch_size, sequence_length, hidden_size)) — Chuỗi các hidden-state tại đầu ra của lớp cuối cùng của mô hình.
past_key_values (Cache, tùy chọn, được trả về khi use_cache=True được truyền vào hoặc khi config.use_cache=True) — Đây là một instance của Cache. Để biết thêm chi tiết, hãy xem hướng dẫn về kv cache của chúng tôi.

Chứa các hidden-states đã được tính trước (key và values trong các khối self-attention và tùy chọn nếu config.is_encoder_decoder=True trong các khối cross-attention) có thể được sử dụng (xem đầu vào past_key_values) để tăng tốc độ giải mã tuần tự.
hidden_states (tuple(torch.Tensor), tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Bộ tuple của torch.Tensor (một cho đầu ra của embeddings, nếu mô hình có lớp embedding, + một cho đầu ra của mỗi lớp) có hình dạng (batch_size, sequence_length, hidden_size).

Trạng thái ẩn của mô hình tại đầu ra của mỗi lớp cùng với các đầu ra embedding ban đầu tùy chọn.
attentions (tuple(torch.Tensor), tuỳ chọn, được trả về khi output_attentions=True được truyền vào hoặc khi config.output_attentions=True) — Tuple của torch.Tensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

Trọng số chú ý sau softmax của attention, được sử dụng để tính trung bình có trọng số trong các đầu self-attention.
router_logits (tuple(torch.Tensor), tuỳ chọn, được trả về khi output_router_probs=True và config.add_router_probs=True được truyền vào hoặc khi config.output_router_probs=True) — Bộ ba torch.Tensor (một cho mỗi lớp) có hình dạng (batch_size, sequence_length, num_experts).

Logits thô (sau softmax) được tính bởi các router MoE, các thuật ngữ này được sử dụng để tính toán tổn thất bổ trợ cho các mô hình Mixture of Experts.

PhimoeForCausalLM

lớp transformers.PhimoeForCausalLM

< source >

( config: PhimoeConfig )

Tham số

config (PhimoeConfig) — Lớp cấu hình mô hình chứa tất cả các tham số của mô hình. Khởi tạo bằng tệp cấu hình không tải trọng số liên quan đến mô hình, chỉ tải cấu hình. Xem phương thức from_pretrained() để tải trọng số của mô hình.

Mô hình Phimoe cho mô hình hóa ngôn ngữ nhân quả.

forward

< source >

( 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 = Noneoutput_router_logits: bool | None = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → MoeCausalLMOutputWithPast or tuple(torch.Tensor)

Tham số

input_ids (torch.LongTensor có dạng (batch_size, sequence_length), tùy chọn) — Chỉ số của các token trong chuỗi đầu vào theo từ điển. Mặc định, padding sẽ bị bỏ qua.
Các chỉ số có thể được lấy bằng cách sử dụng AutoTokenizer. Xem PreTrainedTokenizer.encode() và PreTrainedTokenizer.call() để biết thêm chi tiết.

ID đầu vào là gì?
attention_mask (torch.Tensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệm. Các giá trị mặt nạ được chọn trong [0, 1]:
- 1 cho các token không bị che,
- 0 cho các token bị che.
Mặt nạ chú ý là gì?
position_ids (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Chỉ số vị trí của các token trong mỗi chuỗi đầu vào trong các position embeddings. Được chọn trong khoảng [0, config.n_positions - 1].
ID vị trí là gì?
past_key_values (~cache_utils.Cache, tuỳ chọn) — Các hidden-state đã tính trước (key và value trong các khối self-attention và cross-attention) có thể được sử dụng để tăng tốc giải mã tuần tự. Điều này thường bao gồm past_key_values được trả về bởi mô hình ở một giai đoạn giải mã trước đó, khi use_cache=True hoặc config.use_cache=True.
Chỉ cho phép Cache instance làm đầu vào, xem hướng dẫn kv cache của chúng tôi. Nếu không truyền past_key_values, DynamicCache sẽ được khởi tạo theo mặc định.

Mô hình sẽ xuất ra cùng định dạng cache được đưa vào làm đầu vào.

Nếu past_key_values được sử dụng, người dùng được kỳ vọng chỉ nhập input_ids chưa được xử lý (những phần chưa có trạng thái key value quá khứ được cung cấp cho mô hình này) có hình dạng (batch_size, unprocessed_length) thay vì toàn bộ input_ids có hình dạng (batch_size, sequence_length).
inputs_embeds (torch.Tensor có hình dạng (batch_size, sequence_length, hidden_size), tùy chọn) — Tùy chọn, thay vì truyền input_ids, bạn có thể chọn truyền trực tiếp một biểu diễn nhúng. Điều này hữu ích nếu bạn muốn kiểm soát nhiều hơn cách chuyển đổi các chỉ số input_ids thành các vector liên quan so với ma trận tra cứu nhúng nội bộ của mô hình.
labels (torch.LongTensor có shape (batch_size, sequence_length), tùy chọn) — Nhãn để tính toán tổn thất mô hình hóa ngôn ngữ có che (masked language modeling loss). Chỉ số phải nằm trong [0, ..., config.vocab_size] hoặc -100 (xem docstring của input_ids). Các token có chỉ số được đặt thành -100 sẽ bị bỏ qua (che), tổn thất chỉ được tính cho các token có nhãn nằm trong [0, ..., config.vocab_size].
use_cache (bool, tùy chọn) — Nếu đặt thành True, các trạng thái key value của past_key_values sẽ được trả về và có thể được sử dụng để tăng tốc quá trình giải mã (xem past_key_values).
output_router_logits (bool, tùy chọn) — Có trả về logits của tất cả các router hay không. Chúng hữu ích để tính toán router loss và không nên được trả về trong quá trình suy luận.
logits_to_keep (Union[int, torch.Tensor], tùy chọn, mặc định là 0) — Nếu là int, tính logits cho logits_to_keep token cuối. Nếu là 0, tính logits cho tất cả input_ids (trường hợp đặc biệt). Chỉ cần logits của token cuối cho quá trình sinh, và việc chỉ tính cho token đó có thể tiết kiệm bộ nhớ, điều này trở nên khá đáng kể với các chuỗi dài hoặc kích thước từ vựng lớn. Nếu là torch.Tensor, phải là 1 chiều tương ứng với các chỉ số cần giữ trong chiều độ dài chuỗi. Điều này hữu ích khi sử dụng định dạng tensor đóng gói (một chiều duy nhất cho batch và độ dài chuỗi).

Trả về

MoeCausalLMOutputWithPast hoặc tuple(torch.Tensor)

Một MoeCausalLMOutputWithPast hoặc một tuple của torch.Tensor (nếu return_dict=False được truyền hoặc khi config.return_dict=False) bao gồm các thành phần khác nhau tùy thuộc vào cấu hình (PhimoeConfig) và đầu vào.

Phương thức forward của PhimoeForCausalLM ghi đè lên phương thức đặc biệt __call__.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, người dùng nên gọi instance của Module sau đó thay vì gọi hàm này, vì instance Module sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ lặng lẽ bỏ qua chúng.

loss (torch.Tensor có shape (1,), tùy chọn, được trả về khi labels được cung cấp) — Loss của language modeling (cho next-token prediction).
logits (torch.Tensor có hình dạng (batch_size, sequence_length, config.vocab_size)) — Điểm dự đoán của đầu mô hình hóa ngôn ngữ (điểm cho mỗi token trong từ vựng trước SoftMax).
aux_loss (torch.Tensor, tuỳ chọn, được trả về khi output_router_logits=True được truyền vào hoặc khi config.output_router_logits=True, và mô hình huấn luyện router của nó với tổn thất cân bằng tải) — Tổn thất phụ cân bằng tải cho các module thưa. Các mô hình cân bằng chuyên gia của chúng bằng router bias thay thế (DeepSeek-V3 và các kiến trúc phái sinh từ nó) sẽ trả về None tại đây trong khi vẫn trả về router_logits.
router_logits (tuple(torch.Tensor), tuỳ chọn, được trả về khi truyền output_router_logits=True hoặc khi config.output_router_logits=True) — Bộ tuple của torch.Tensor (một cho mỗi lớp thưa) có hình dạng (batch_size * sequence_length, num_experts).

Logits thô của router được tính toán bởi các router MoE. Chúng có thể được sử dụng để tính toán tổn thất cân bằng tải hoặc để kiểm tra cách các token được phân phối đến các chuyên gia.
past_key_values (Cache, tùy chọn, được trả về khi use_cache=True được truyền vào hoặc khi config.use_cache=True) — Đây là một instance của Cache. Để biết thêm chi tiết, hãy xem hướng dẫn về kv cache của chúng tôi.

Chứa các hidden-states đã được tính trước (key và values trong các khối self-attention) có thể được sử dụng (xem đầu vào past_key_values) để tăng tốc độ giải mã tuần tự.
hidden_states (tuple(torch.Tensor), tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Bộ tuple của torch.Tensor (một cho đầu ra của embeddings, nếu mô hình có lớp embedding, + một cho đầu ra của mỗi lớp) có hình dạng (batch_size, sequence_length, hidden_size).

Trạng thái ẩn của mô hình tại đầu ra của mỗi lớp cùng với các đầu ra embedding ban đầu tùy chọn.
attentions (tuple(torch.Tensor), tuỳ chọn, được trả về khi output_attentions=True được truyền vào hoặc khi config.output_attentions=True) — Tuple của torch.Tensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

Trọng số chú ý sau softmax của attention, được sử dụng để tính trung bình có trọng số trong các đầu self-attention.

Ví dụ:

>>> from transformers import AutoTokenizer, PhimoeForCausalLM

>>> model = PhimoeForCausalLM.from_pretrained("mistralai/Phimoe-8x7B-v0.1")
>>> tokenizer = AutoTokenizer.from_pretrained("mistralai/Phimoe-8x7B-v0.1")

>>> prompt = "Hey, are you conscious? Can you talk to me?"
>>> inputs = tokenizer(prompt, return_tensors="pt")

>>> # Generate
>>> generate_ids = model.generate(inputs.input_ids, max_length=30)
>>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"Hey, are you conscious? Can you talk to me?\nI'm not conscious, but I can talk to you."

generate

< source >

( inputs: typing.Optional[torch.Tensor] = Nonegeneration_config: transformers.generation.configuration_utils.GenerationConfig | None = Nonelogits_processor: transformers.generation.logits_process.LogitsProcessorList | None = Nonestopping_criteria: transformers.generation.stopping_criteria.StoppingCriteriaList | None = Noneprefix_allowed_tokens_fn: collections.abc.Callable[[int, torch.Tensor], list[int]] | None = Nonesynced_gpus: bool | None = Noneassistant_model: typing.Optional[ForwardRef('PreTrainedModel')] = Nonestreamer: typing.Optional[ForwardRef('BaseStreamer')] = Nonenegative_prompt_ids: typing.Optional[torch.Tensor] = Nonenegative_prompt_attention_mask: typing.Optional[torch.Tensor] = Nonecustom_generate: str | collections.abc.Callable | None = None**kwargs ) → ModelOutput or torch.LongTensor

Tham số

inputs (torch.Tensor có hình dạng thay đổi tùy theo chế độ, không bắt buộc) — Chuỗi được dùng làm prompt cho quá trình sinh hoặc làm đầu vào mô hình cho bộ mã hóa. Nếu None, phương thức sẽ khởi tạo nó với bos_token_id và kích thước batch là 1. Đối với các mô hình chỉ có bộ giải mã, inputs phải ở định dạng input_ids. Đối với các mô hình mã hóa-giải mã, inputs có thể đại diện cho bất kỳ input_ids, input_values, input_features, hoặc pixel_values.
generation_config (GenerationConfig, optional) — Cấu hình sinh được sử dụng làm tham số cơ sở cho lệnh gọi sinh. **kwargs được truyền vào generate và khớp với các thuộc tính của generation_config sẽ ghi đè lên chúng. Nếu generation_config không được cung cấp, giá trị mặc định sẽ được sử dụng, với thứ tự ưu tiên nạp như sau: 1) từ tệp mô hình generation_config.json, nếu tệp này tồn tại; 2) từ cấu hình mô hình. Vui lòng lưu ý rằng các tham số không được chỉ định sẽ kế thừa các giá trị mặc định của GenerationConfig, và tài liệu của chúng nên được kiểm tra để tham số hóa quá trình sinh.
logits_processor (LogitsProcessorList, tùy chọn) — Các logits processor tùy chỉnh bổ sung cho các logits processor mặc định được tạo từ các đối số và cấu hình sinh. Nếu một logit processor được truyền vào mà đã được tạo từ các đối số hoặc một cấu hình sinh, một lỗi sẽ được ném ra. Tính năng này dành cho người dùng nâng cao.
stopping_criteria (StoppingCriteriaList, tùy chọn) — Tiêu chí dừng tùy chỉnh bổ sung cho tiêu chí dừng mặc định được xây dựng từ các đối số và cấu hình sinh. Nếu một tiêu chí dừng được truyền vào mà đã được tạo từ các đối số hoặc cấu hình sinh, một lỗi sẽ được ném ra. Nếu tiêu chí dừng của bạn phụ thuộc vào đầu vào scores, hãy đảm bảo bạn truyền return_dict_in_generate=True, output_scores=True vào generate. Tính năng này dành cho người dùng nâng cao.
prefix_allowed_tokens_fn (Callable[[int, torch.Tensor], list[int]], tùy chọn) — Nếu được cung cấp, hàm này sẽ ràng buộc beam search chỉ sử dụng các token được phép ở mỗi bước. Nếu không được cung cấp, sẽ không áp dụng ràng buộc nào. Hàm này nhận 2 đối số: ID của batch batch_id và input_ids. Nó phải trả về một danh sách chứa các token được phép cho bước sinh tiếp theo, dựa trên ID của batch batch_id và các token đã được sinh trước đó inputs_ids. Đối số này hữu ích cho việc sinh có ràng buộc dựa trên tiền tố, như được mô tả trong Autoregressive Entity Retrieval.
synced_gpus (bool, tùy chọn) — Có tiếp tục chạy vòng lặp while cho đến max_length hay không. Trừ khi được ghi đè, cờ này sẽ được đặt thành True nếu sử dụng FullyShardedDataParallel hoặc DeepSpeed ZeRO Stage 3 với nhiều GPU để tránh tình trạng deadlock nếu một GPU hoàn thành việc tạo ra trước các GPU khác. Ngược lại, mặc định là False.
assistant_model (PreTrainedModel, tùy chọn) — Một mô hình trợ lý có thể được sử dụng để tăng tốc quá trình sinh. Mô hình trợ lý phải có cùng bộ phân từ (tokenizer) chính xác. Việc tăng tốc đạt được khi dự đoán các token ứng viên bằng mô hình trợ lý nhanh hơn nhiều so với việc chạy sinh bằng mô hình mà bạn đang gọi generate từ. Do đó, mô hình trợ lý nên nhỏ hơn nhiều.
streamer (BaseStreamer, tuỳ chọn) — Đối tượng Streamer sẽ được dùng để stream các chuỗi được tạo ra. Các token được tạo sẽ được truyền qua streamer.put(token_ids) và streamer chịu trách nhiệm cho mọi xử lý tiếp theo.
negative_prompt_ids (torch.LongTensor có shape (batch_size, sequence_length), tùy chọn) — Prompt âm cần thiết cho một số bộ xử lý như CFG. Kích thước batch phải khớp với kích thước batch đầu vào. Đây là tính năng thử nghiệm, có thể bị thay đổi API gây lỗi trong các phiên bản tương lai.
negative_prompt_attention_mask (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Attention_mask cho negative_prompt_ids.
custom_generate (str hoặc Callable, tùy chọn) — Một trong các lựa chọn sau:
- str (tên kho Hugging Face Hub): chạy hàm generate tùy chỉnh được định nghĩa tại custom_generate/generate.py trong kho đó thay vì phương thức generate tiêu chuẩn. Kho này thay thế hoàn toàn logic tạo ra, và kiểu trả về có thể khác.
- str (đường dẫn kho cục bộ): giống như trên nhưng từ một đường dẫn cục bộ. Các thư mục cục bộ cũng yêu cầu trust_remote_code=True vì custom_generate/generate.py cục bộ sẽ được thực thi.
- Callable: generate sẽ thực hiện các bước chuẩn bị đầu vào thông thường, sau đó gọi callable được cung cấp để chạy vòng lặp giải mã. Để biết thêm thông tin, xem tài liệu.
kwargs (dict[str, Any], tùy chọn) — Tham số hóa ad hoc cho generation_config và/hoặc các kwargs cụ thể của model bổ sung sẽ được chuyển tiếp đến hàm forward của model. Nếu model là model encoder-decoder, các kwargs cụ thể của encoder không nên có tiền tố và các kwargs cụ thể của decoder nên có tiền tố decoder_.

Trả về

ModelOutput hoặc torch.LongTensor

Một ModelOutput (nếu return_dict_in_generate=True hoặc khi config.return_dict_in_generate=True) hoặc một torch.LongTensor.

Nếu mô hình không phải là mô hình encoder-decoder (model.config.is_encoder_decoder=False), các kiểu ModelOutput có thể là:

Nếu mô hình là mô hình encoder-decoder (model.config.is_encoder_decoder=True), các kiểu ModelOutput có thể là:

Tạo ra các chuỗi id token cho các mô hình có đầu mô hình hóa ngôn ngữ.

Hầu hết các tham số kiểm soát quá trình sinh được đặt trong generation_config, nếu không được truyền vào, sẽ được đặt thành cấu hình sinh mặc định của mô hình. Bạn có thể ghi đè bất kỳ generation_config nào bằng cách truyền các tham số tương ứng vào generate(), ví dụ .generate(inputs, num_beams=4, do_sample=True).

Để xem tổng quan về các chiến lược sinh và ví dụ mã, hãy xem hướng dẫn sau.

PhimoeForSequenceClassification

lớp transformers.PhimoeForSequenceClassification

< source >

( config )

forward

< source >

Tham số

input_ids (torch.LongTensor có dạng (batch_size, sequence_length), tùy chọn) — Chỉ số của các token trong chuỗi đầu vào theo từ điển. Mặc định, padding sẽ bị bỏ qua.
Các chỉ số có thể được lấy bằng cách sử dụng AutoTokenizer. Xem PreTrainedTokenizer.encode() và PreTrainedTokenizer.call() để biết thêm chi tiết.

ID đầu vào là gì?
attention_mask (torch.Tensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệm. Các giá trị mặt nạ được chọn trong [0, 1]:
- 1 cho các token không bị che,
- 0 cho các token bị che.
Mặt nạ chú ý là gì?
position_ids (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Chỉ số vị trí của các token trong mỗi chuỗi đầu vào trong các position embeddings. Được chọn trong khoảng [0, config.n_positions - 1].
ID vị trí là gì?
past_key_values (Cache, tùy chọn) — Các hidden-states đã được tính trước (key và value trong các khối self-attention và cross-attention) có thể được sử dụng để tăng tốc độ giải mã tuần tự. Điều này thường bao gồm past_key_values được trả về bởi mô hình ở một giai đoạn giải mã trước đó, khi use_cache=True hoặc config.use_cache=True.
Chỉ cho phép Cache instance làm đầu vào, xem hướng dẫn kv cache của chúng tôi. Nếu không truyền past_key_values, DynamicCache sẽ được khởi tạo theo mặc định.

Mô hình sẽ xuất ra cùng định dạng cache được đưa vào làm đầu vào.

Nếu past_key_values được sử dụng, người dùng được kỳ vọng chỉ nhập input_ids chưa được xử lý (những phần chưa có trạng thái key value quá khứ được cung cấp cho mô hình này) có hình dạng (batch_size, unprocessed_length) thay vì toàn bộ input_ids có hình dạng (batch_size, sequence_length).
inputs_embeds (torch.Tensor có hình dạng (batch_size, sequence_length, hidden_size), tùy chọn) — Tùy chọn, thay vì truyền input_ids, bạn có thể chọn truyền trực tiếp một biểu diễn nhúng. Điều này hữu ích nếu bạn muốn kiểm soát nhiều hơn cách chuyển đổi các chỉ số input_ids thành các vector liên quan so với ma trận tra cứu nhúng nội bộ của mô hình.
labels (torch.LongTensor có shape (batch_size,), tùy chọn) — Nhãn để tính loss cho phân loại/hồi quy chuỗi. Chỉ số phải nằm trong [0, ..., config.num_labels - 1]. Nếu config.num_labels == 1, loss hồi quy sẽ được tính (Mean-Square loss). Nếu config.num_labels > 1, loss phân loại sẽ được tính (Cross-Entropy).
use_cache (bool, tùy chọn) — Nếu đặt thành True, các trạng thái key value của past_key_values sẽ được trả về và có thể được sử dụng để tăng tốc quá trình giải mã (xem past_key_values).

Trả về

SequenceClassifierOutputWithPast

Phương thức forward của GenericForSequenceClassification ghi đè lên phương thức đặc biệt __call__.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, người dùng nên gọi instance của Module sau đó thay vì gọi hàm này, vì instance Module sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ lặng lẽ bỏ qua chúng.

Update on GitHub

←Phi-3 PhoBERT→