Hugging Face's logo

Transformers documentation

FalconH1

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

Mô hình này đã được đóng góp cho Hugging Face Transformers vào ngày 2025-05-21.

FalconH1

Tổng quan

Mô hình FalconH1 được phát triển bởi nhóm Tiền huấn luyện của TII. Một bài báo nghiên cứu toàn diện bao quát kiến trúc, động lực học tiền huấn luyện, kết quả thực nghiệm và kết luận sẽ sớm được công bố. Bạn có thể đọc thêm về dòng sản phẩm này tại trang web này.

Những người đóng góp

Mô hình này được đóng góp bởi DhiyaEddine, ybelkada, JingweiZuo, IlyasChahed và MaksimVelikanov. Mã nguồn gốc có thể được tìm thấy tại đây.

Ghi chú

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

FalconH1Config

Mô hìnhĐộ sâuChiềuĐầu AttnKVMamba Headsd_headd_stateĐộ dài ngữ cảnh
H1 0.5B361024822464 / 641284K, 16K-SFT
H1 1.5B2420488248128 / 64256128K
H1 1.5B-d6612806224128 / 64256128K
H1 3B32256010232128 / 128256128K
H1 7B44307212224128 / 128256256K
H1 34B72512020432128 / 128256256K

lớp transformers.FalconH1Config

< >

( 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 = 128000tie_word_embeddings: bool = Falsehidden_size: int = 4096intermediate_size: int = 14336num_hidden_layers: int = 32num_attention_heads: int = 32num_key_value_heads: int | None = 8hidden_act: str = 'silu'initializer_range: float = 0.02rms_norm_eps: float = 1e-05use_cache: bool | None = Truenum_logits_to_keep: int | None = 1pad_token_id: int | None = 0bos_token_id: int | None = 1eos_token_id: int | list[int] | None = 2max_position_embeddings: int = 8192attention_dropout: float | int | None = 0.0mamba_d_ssm: int | None = 1024mamba_n_heads: int | None = 128mamba_d_head: str | int | None = 'auto'mamba_n_groups: int | None = 1mamba_d_state: int | None = 256mamba_d_conv: int | None = 4mamba_expand: int | None = 2mamba_chunk_size: int | None = 256mamba_conv_bias: bool | None = Truemamba_proj_bias: bool | None = Falsemamba_norm_before_gate: bool | None = Truemamba_rms_norm: bool | None = Falsetime_step_limit: list[float, float] | tuple[float, float] | None = (0.0, inf)projectors_bias: bool | None = Falserope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = Nonelm_head_multiplier: float | None = 1.0embedding_multiplier: float | None = 1.0mlp_multipliers: list[float] | None = Nonekey_multiplier: float | None = 1.0attention_out_multiplier: float | None = 1.0attention_in_multiplier: float | None = 1.0ssm_multipliers: list[float] | None = Nonessm_in_multiplier: float | None = 1.0ssm_out_multiplier: float | None = 1.0attention_bias: bool = Falsemlp_bias: bool = False )

Tham số

  • vocab_size (int, tùy chọn, mặc định là 128000) — 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.
  • 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.
  • 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à 14336) — 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.
  • 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.
  • num_logits_to_keep (int hoặc None, tùy chọn, mặc định là 1) — Số lượng logits của prompt cần tính trong quá trình sinh. Nếu là None, tất cả các logits sẽ được tính. Nếu là một giá trị nguyên, chỉ các logits cuối cùng có số lượng bằng num_logits_to_keep sẽ được tính. Mặc định là 1 vì chỉ cần logits của token prompt cuối cùng để sinh. Đối với các chuỗi dài, logits cho toàn bộ chuỗi có thể sử dụng rất nhiều bộ nhớ, do đó, đặt num_logits_to_keep=1 sẽ giảm đáng kể lượng bộ nhớ sử dụng.
  • 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à 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.
  • max_position_embeddings (int, tùy chọn, mặc định là 8192) — Chiều dài chuỗi tối đa mà mô hình này có thể được sử dụng.
  • 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ú ý.
  • mamba_d_ssm (int, tuỳ chọn, mặc định là 1024) — Kích thước trạng thái bên trong của SSM (mô hình không gian trạng thái) trong các lớp Mamba của FalconH1.
  • mamba_n_heads (int, tùy chọn, mặc định là 128) — Số lượng đầu mamba được sử dụng trong triển khai v2.
  • mamba_d_head (Union[str, int], tùy chọn, mặc định là auto) — Kích thước chiều nhúng của head
  • mamba_n_groups (int, tùy chọn, mặc định là 1) — Số lượng nhóm mamba được sử dụng trong triển khai v2.
  • mamba_d_state (int, tùy chọn, mặc định là 256) — Kích thước của trạng thái SSM (chiều trạng thái ẩn) trong các lớp Mamba.
  • mamba_d_conv (int, tùy chọn, mặc định là 4) — Kích thước của nhân convolution trong mamba
  • mamba_expand (int, tùy chọn, mặc định là 2) — Hệ số mở rộng (so với hidden_size) được sử dụng để xác định kích thước trung gian của mamba
  • mamba_chunk_size (int, tùy chọn, mặc định là 256) — Các khối để chia nhỏ chuỗi khi thực hiện prefill/đào tạo
  • mamba_conv_bias (bool, tùy chọn, mặc định là True) — Cờ chỉ định có sử dụng bias trong lớp convolution của khối mamba mixer hay không.
  • mamba_proj_bias (bool, tùy chọn, mặc định là False) — Cờ chỉ định có sử dụng bias trong các phép chiếu đầu vào và đầu ra ([“in_proj”, “out_proj”]) của khối mamba mixer hay không
  • mamba_norm_before_gate (bool, tùy chọn, mặc định là True) — Có áp dụng chuẩn hóa trước cơ chế điều khiển (gating) trong bộ trộn Mamba hay không.
  • mamba_rms_norm (bool, tùy chọn, mặc định là False) — Có sử dụng chuẩn hóa RMS trong các lớp Mamba (thay vì LayerNorm tiêu chuẩn) hay không.
  • time_step_limit (Union[list[float, float], tuple[float, float]], tuỳ chọn, mặc định là (0.0, inf)) — Khoảng giá trị bước thời gian được chấp nhận để kẹp (clamp).
  • projectors_bias (bool, tùy chọn, mặc định là False) — Cờ chỉ định có sử dụng bias trong các phép chiếu đầu vào và đầu ra ([“in_proj”, “out_proj”]) của khối attention 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.
  • lm_head_multiplier (float, tùy chọn, mặc định là 1.0) — Hệ số nhân cho LM head. Giá trị này được dùng để điều chỉnh quy mô đầu ra của LM head.
  • embedding_multiplier (float, tùy chọn, mặc định là 1.0) — Hệ số nhân cho lớp embedding. Giá trị này được dùng để điều chỉnh quy mô đầu ra của lớp embedding.
  • mlp_multipliers (list[float], tùy chọn) — Các hệ số nhân cho các lớp MLP. Giá trị này được dùng để điều chỉnh kích thước đầu ra của các lớp MLP. Giá trị đầu tiên là hệ số nhân của lớp gate, giá trị thứ hai là hệ số nhân của lớp down_proj.
  • key_multiplier (float, tùy chọn) — Hệ số nhân cho lớp key. Hệ số này được dùng để điều chỉnh quy mô đầu ra của lớp key.
  • attention_out_multiplier (float, tùy chọn) — Hệ số nhân cho lớp đầu ra của attention. Giá trị này được dùng để điều chỉnh đầu ra của lớp attention output
  • attention_in_multiplier (float, tùy chọn) — Hệ số nhân cho lớp đầu vào của attention. Hệ số này được dùng để điều chỉnh (scale) đầu ra của lớp đầu vào attention.
  • ssm_multipliers (list[float], tùy chọn) — Các hệ số nhân cho các lớp SSM. Giá trị này được dùng để điều chỉnh (scale) đầu ra của các lớp SSM.
  • ssm_in_multiplier (float, tùy chọn) — Hệ số nhân cho lớp đầu vào SSM. Hệ số này được dùng để điều chỉnh quy mô đầu ra của lớp đầu vào SSM.
  • ssm_out_multiplier (float, tùy chọn) — Hệ số nhân cho lớp đầu ra SSM. Hệ số này được dùng để điều chỉnh quy mô đầu ra của lớp đầu ra SSM.
  • 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.
  • mlp_bias (bool, tùy chọn, mặc định là False) — Có sử dụng bias trong các lớp up_proj, down_proj và gate_proj của các lớp MLP hay không.

Đây là lớp cấu hình để lưu trữ cấu hình của một FalconH1Model. Nó được sử dụng để khởi tạo một mô hình Falcon H1 theo các đối số được chỉ định, xác định kiến trúc 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-H1-1.5B-Deep-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.

FalconH1ForCausalLM

from transformers import AutoModelForCausalLM, AutoTokenizer


model = AutoModelForCausalLM.from_pretrained("tiiuae/Falcon-H1-7B-Instruct", device_map="auto")
tokenizer = AutoTokenizer.from_pretrained("tiiuae/Falcon-H1-7B-Instruct")

message = ["Mamba is a snake with following properties  "]
inputs = tokenizer(message, return_tensors='pt', return_token_type_ids=False).to(model.device)
response = model.generate(**inputs, max_new_tokens=64)
print(tokenizer.batch_decode(response, skip_special_tokens=True)[0])

lớp transformers.FalconH1ForCausalLM

< >

( config: FalconH1Config )

Tham số

  • config (FalconH1Config) — 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 H1 cho mô hình hóa ngôn ngữ nhân quả.

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

< >

( 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 ) → CausalLMOutputWithPast 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).
  • 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ề

CausalLMOutputWithPast hoặc tuple(torch.Tensor)

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

Phương thức forward của FalconH1ForCausalLM 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).

  • 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, FalconH1ForCausalLM

>>> model = FalconH1ForCausalLM.from_pretrained("...")
>>> tokenizer = AutoTokenizer.from_pretrained("...")

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

Cài đặt HF này được đóng góp bởi younesbelkada và DhiaEddineRhaiem.

Update on GitHub

←Falcon3 FalconMamba→