Transformers documentation

FalconMamba

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-10-07 và được đóng góp cho Hugging Face Transformers vào ngày 2024-08-12.

FalconMamba

FalconMamba là một mô hình ngôn ngữ lớn 7B, có sẵn dưới dạng biến thể được huấn luyện trước và biến thể được tinh chỉnh theo chỉ thị, dựa trên Mamba. Mô hình này triển khai thiết kế Mamba thuần túy, tập trung vào hiệu quả tính toán trong khi vẫn duy trì hiệu suất mạnh mẽ. FalconMamba nhanh hơn đáng kể ở giai đoạn suy luận và yêu cầu ít bộ nhớ hơn đáng kể cho việc tạo chuỗi dài. Các mô hình được huấn luyện trước trên bộ dữ liệu 5,8T token đa dạng, bao gồm RefinedWeb, nội dung kỹ thuật, mã và dữ liệu toán học.

Bạn có thể tìm thấy các checkpoint chính thức của FalconMamba trong bộ sưu tập FalconMamba 7B.

Nhấp vào các mô hình FalconMamba ở thanh bên phải để xem thêm các ví dụ về cách áp dụng FalconMamba cho các tác vụ ngôn ngữ khác nhau.

Các ví dụ dưới đây minh họa cách tạo văn bản bằng Pipeline, AutoModel và từ dòng lệnh.

Pipeline

AutoModel

transformers CLI

Quantization giảm gánh nặng bộ nhớ của các mô hình lớn bằng cách biểu diễn trọng số ở độ chính xác thấp hơn. Tham khảo tổng quan về Quantization để biết thêm các backend quantization khả dụng.

Ví dụ bên dưới sử dụng bitsandbytes để lượng tử hóa trọng số xuống 4-bit.

from transformers import AutoTokenizer, BitsAndBytesConfig, FalconMambaForCausalLM


quantization_config = BitsAndBytesConfig(
    load_in_4bit=True,
    bnb_4bit_quant_type="nf4",
    bnb_4bit_use_double_quant=True,
)

tokenizer = AutoTokenizer.from_pretrained("tiiuae/falcon-mamba-7b")
model = FalconMambaForCausalLM.from_pretrained(
    "tiiuae/falcon-mamba-7b",
    device_map="auto",
    quantization_config=quantization_config,
)

inputs = tokenizer("Explain the concept of state space models in simple terms", return_tensors="pt").to(model.device)
outputs = model.generate(**inputs, max_new_tokens=100)
print(tokenizer.decode(outputs[0], skip_special_tokens=True))

Ghi chú

Sử dụng left padding cho việc tạo batched. Xem Padding side.

FalconMambaConfig

lớp transformers.FalconMambaConfig

< 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 = 50280hidden_size: int = 768state_size: int = 16num_hidden_layers: int = 32layer_norm_epsilon: float = 1e-05pad_token_id: int | None = 0bos_token_id: int | None = 0eos_token_id: int | list[int] | None = 0expand: int = 2conv_kernel: int = 4use_bias: bool = Falseuse_conv_bias: bool = Truehidden_act: str = 'silu'initializer_range: float = 0.1residual_in_fp32: bool = Truetime_step_rank: str | int = 'auto'time_step_scale: float = 1.0time_step_min: float = 0.001time_step_max: float = 0.1time_step_init_scheme: str = 'random'time_step_floor: float = 0.0001rescale_prenorm_residual: bool = Falseuse_cache: bool = Trueuse_mambapy: bool = Falseuse_associative_scan: bool = Truetie_word_embeddings: bool = Truemixer_rms_eps: float = 1e-06 )

Tham số

vocab_size (int, tùy chọn, mặc định là 50280) — 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à 768) — Kích thước của các biểu diễn ẩn.
state_size (int, tùy chọn, mặc định là 16) — Kích thước của trạng thái SSM (chiều của trạng thái ẩn) trong các lớp Mamba.
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.
layer_norm_epsilon (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 lớp (layer normalization).
pad_token_id (int, tùy chọn, mặc định là 0) — Token id được sử dụng để đệm (padding) trong từ vựng.
bos_token_id (int, tùy chọn, mặc định là 0) — Token id được sử dụng cho đầu luồng trong bảng từ vựng.
eos_token_id (Union[int, list[int]], tùy chọn, mặc định là 0) — Token id được sử dụng cho end-of-stream trong bảng từ vựng.
expand (int, tuỳ chọn, mặc định là 2) — Hệ số mở rộng được sử dụng để xác định kích thước trung gian.
conv_kernel (int, tuỳ chọn, mặc định là 4) — Kích thước của nhân tích chập.
use_bias (bool, tùy chọn, mặc định là False) — Có sử dụng bias trong [“in_proj”, “out_proj”] của khối mixer hay không
use_conv_bias (bool, tùy chọn, mặc định là True) — Có sử dụng bias trong lớp convolution của khối mixer hay không.
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.
initializer_range (float, tùy chọn, mặc định là 0.1) — Độ lệch chuẩn của truncated_normal_initializer để khởi tạo tất cả các ma trận trọng số.
residual_in_fp32 (bool, tùy chọn, mặc định là True) — Xác định xem các phần dư (residuals) có nên ở dạng float32 hay không. Nếu đặt thành False, các phần dư sẽ giữ nguyên dtype giống như phần còn lại của mô hình
time_step_rank (Union[str, int], tuỳ chọn, mặc định là auto) — Rank của phép chiếu delta (time step). Có thể đặt là "auto" để thiết lập tự động.
time_step_scale (float, tùy chọn, mặc định là 1.0) — Hệ số nhân áp dụng cho delta của bước thời gian trước khi rời rạc hóa.
time_step_min (float, tùy chọn, mặc định là 0.001) — time_step tối thiểu được dùng để giới hạn dt_proj.bias.
time_step_max (float, tùy chọn, mặc định là 0.1) — time_step tối đa được dùng để giới hạn dt_proj.bias.
time_step_init_scheme (str, tùy chọn, mặc định là random) — Phương án khởi tạo cho delta của bước thời gian. Có thể là "random" hoặc "uniform".
time_step_floor (float, tùy chọn, mặc định là 0.0001) — Giá trị tối thiểu được phép cho delta của bước thời gian rời rạc sau kích hoạt softplus.
rescale_prenorm_residual (bool, tùy chọn, mặc định là False) — Có nên điều chỉnh lại trọng số của out_proj khi khởi tạo hay không.
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.
use_mambapy (bool, tuỳ chọn, mặc định là False) — Xác định chiến lược dự phòng trong quá trình huấn luyện nếu bản triển khai chính thức của Mamba dựa trên CUDA không khả dụng. Nếu True, bản triển khai mamba.py sẽ được sử dụng. Nếu False, bản triển khai đơn giản và chậm hơn sẽ được sử dụng. Hãy cân nhắc chuyển sang phiên bản đơn giản nếu bộ nhớ bị hạn chế.
use_associative_scan (bool, tuỳ chọn, mặc định là True) — Có nên sử dụng torch._higher_order_ops.associative_scan của PyTorch cho phép quét song song thay cho cài đặt tuần tự đơn giản hay không. Quét kết hợp chỉ hoạt động trong quá trình theo dõi của torch.compile và yêu cầu torch >= 2.9.0. Cả hai đường dẫn đều được kiểm tra để cho kết quả giống hệt về mặt số học (xem test_associative_scan_matches_sequential). Đặt thành False để quay lại vòng lặp tuần tự.
tie_word_embeddings (bool, tùy chọn, mặc định là True) — 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.
mixer_rms_eps (float, tùy chọn, mặc định là 1e-06) — Giá trị epsilon của chuẩn hóa RMS được sử dụng trong Mixer RMS norm cho các trạng thái B, C và dt.

Đây là lớp cấu hình để lưu trữ cấu hình của một FalconMambaModel. Nó được sử dụng để khởi tạo một mô hình Falcon Mamba 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 tiiuae/falcon-mamba-7b

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 FalconMambaConfig, FalconMambaModel

>>> # Initializing a FalconMamba configuration
>>> configuration = FalconMambaConfig()

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

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

FalconMambaModel

lớp transformers.FalconMambaModel

< source >

( config: FalconMambaConfig )

Tham số

config (FalconMambaConfig) — 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ố mô hình.

Mô hình Falcon Mamba cơ bản, xuất ra các trạng thái ẩn thô mà không có bất kỳ đầu (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] = Noneinputs_embeds: typing.Optional[torch.LongTensor] = Nonecache_params: transformers.cache_utils.Cache | None = Noneuse_cache: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = Noneattention_mask: typing.Optional[torch.LongTensor] = None**kwargs ) → FalconMambaOutput 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ì?
inputs_embeds (torch.LongTensor 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 tương ứng so với ma trận tra cứu nhúng nội bộ của mô hình.
cache_params (Cache, tùy chọn) — Nếu được truyền vào, mô hình sẽ sử dụng trạng thái trước đó trong tất cả các khối (điều này sẽ tạo ra đầu ra cho input_ids được cung cấp như thể mô hình đã thêm state_input_ids + input_ids làm ngữ cảnh).
use_cache (bool, tùy chọn) — Nếu được đặt thành True, cache_params sẽ được trả về và có thể được sử dụng để nhanh chóng tạo ra các logits tiếp theo.
output_hidden_states (bool, tùy chọn) — Có trả về trạng thái ẩn (hidden states) của tất cả các lớp hay không. Xem hidden_states trong phần tensor trả về để biết thêm chi tiết.
return_dict (bool, tùy chọn) — Có nên trả về một ModelOutput thay vì một tuple thông thường hay không.
attention_mask (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện attention trên các chỉ số token padding. 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ì?

Trả về

FalconMambaOutput hoặc tuple(torch.Tensor)

Một FalconMambaOutput 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 (FalconMambaConfig) và đầu vào.

Phương thức forward của FalconMambaModel 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), tùy chọn) — Chuỗi các trạng thái ẩn (hidden-states) tại đầu ra của lớp cuối cùng của mô hình.
cache_params (~cache_utils.Cache, tùy chọn) — Trạng thái của mô hình tại bước thời gian cuối cùng. Có thể được sử dụng trong phương thức forward với input_ids tiếp theo để tránh việc cung cấp lại input_ids cũ.

Bao gồm cả các ma trận trạng thái của mô hình không gian trạng thái sau khi quét chọn lọc, và các trạng thái của lớp tích chập
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) — 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.

FalconMambaLMHeadModel

lớp transformers.FalconMambaForCausalLM

< source >

( config: FalconMambaConfig )

Tham số

config (FalconMambaConfig) — 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ố mô hình.

Model transformer FALCON_MAMBA với đầu mô hình hóa ngôn ngữ ở trên (tầng tuyến tính có trọng số được liên kết với các nhúng đầu vào).

forward

< source >

( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.LongTensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonecache_params: transformers.cache_utils.Cache | None = Nonelabels: typing.Optional[torch.LongTensor] = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = Noneuse_cache: bool | None = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs ) → FalconMambaCausalLMOutput 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.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện attention trên các chỉ số token padding. 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ì?
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.
cache_params (Cache, tùy chọn) — Nếu được truyền vào, mô hình sẽ sử dụng trạng thái trước đó trong tất cả các khối (điều này sẽ tạo ra đầu ra cho input_ids được cung cấp như thể mô hình đã thêm state_input_ids + input_ids làm ngữ cảnh).
labels (torch.LongTensor có shape (batch_size, sequence_length), tùy chọn) — Nhãn cho mô hình hóa ngôn ngữ. Lưu ý rằng các nhãn được dịch chuyển bên trong mô hình, tức là bạn có thể đặt labels = input_ids Các chỉ số được chọn trong [-100, 0, ..., config.vocab_size] Tất cả các nhãn được đặt thành -100 sẽ bị bỏ qua (che), loss chỉ được tính cho các nhãn trong [0, ..., config.vocab_size]
output_hidden_states (bool, tùy chọn) — Có trả về trạng thái ẩn (hidden states) của tất cả các lớp hay không. Xem hidden_states trong phần tensor trả về để biết thêm chi tiết.
return_dict (bool, tùy chọn) — Có nên trả về một ModelOutput thay vì một tuple thông thường hay không.
use_cache (bool, tùy chọn) — Nếu được đặt thành True, cache_params sẽ được trả về và có thể được sử dụng để nhanh chóng tạo ra các logits tiếp theo.
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ề

FalconMambaCausalLMOutput hoặc tuple(torch.Tensor)

Một FalconMambaCausalLMOutput 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 (FalconMambaConfig) và đầu vào.

Phương thức forward của FalconMambaForCausalLM 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).
cache_params (~cache_utils.Cache, tùy chọn) — Trạng thái của mô hình tại bước thời gian cuối cùng. Có thể được sử dụng trong phương thức forward với input_ids tiếp theo để tránh việc cung cấp lại input_ids cũ.

Bao gồm cả các ma trận trạng thái của mô hình không gian trạng thái sau khi quét chọn lọc, và các trạng thái của lớp tích chập
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) — 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.

Ví dụ:

Update on GitHub

←FalconH1 FLAN-T5→