Hugging Face's logo

Transformers documentation

NemotronH

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 công bố trên HF papers vào ngày 04-04-2025 và được đóng góp cho Hugging Face Transformers vào ngày 03-03-2026.

FlashAttention SDPA

NemotronH

NemotronH là kiến trúc lai kết hợp các lớp attention và state-space để mô hình hóa ngôn ngữ ngữ cảnh dài một cách hiệu quả. Nó xen kẽ các khối Mamba2 và transformer, sử dụng một tỷ lệ cố định để cân bằng giữa khả năng diễn đạt và xử lý chuỗi thời gian tuyến tính.

Ví dụ dưới đây minh họa cách tạo văn bản bằng Pipeline hoặc lớp AutoModelForCausalLM.

Pipeline
AutoModelForCausalLM
from transformers import pipeline


pipe = pipeline(
    task="text-generation",
    model="nvidia/Nemotron-H-8B-Reasoning-128K",
)
pipe("Plants create energy through a process known as")

Ghi chú

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

NemotronHConfig

lớp transformers.NemotronHConfig

< >

( 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 = 131072hidden_size: int = 4096layers_block_type: list[str] | None = Nonetie_word_embeddings: bool = Falseuse_cache: bool = Truenum_logits_to_keep: int = 1pad_token_id: int | None = 0bos_token_id: int | None = 1eos_token_id: int | list[int] | None = 2num_attention_heads: int = 32num_key_value_heads: int = 8head_dim: int = 128max_position_embeddings: int = 4096attention_bias: bool = Falseattention_dropout: float | int = 0.0sliding_window: int | None = Noneintermediate_size: int = 21504mlp_hidden_act: str = 'relu2'mlp_bias: bool = Falseuse_mamba_kernels: bool = Truessm_state_size: int = 128mamba_num_heads: int = 128mamba_head_dim: int = 64mamba_hidden_act: str = 'silu'n_groups: int = 8conv_kernel: int = 4expand: int = 2time_step_min: float = 0.001time_step_max: float = 0.1time_step_limit: list[float] | tuple[float, ...] = (0.0, inf)time_step_floor: float = 0.0001use_conv_bias: bool = Truechunk_size: int = 128mamba_proj_bias: bool = Falsemamba_ssm_cache_dtype: str = 'float32'n_routed_experts: int = 8output_router_logits: bool = Falsen_shared_experts: int = 1moe_intermediate_size: int = 7688moe_shared_expert_intermediate_size: int = 7688moe_latent_size: int | None = Nonemoe_shared_expert_overlap: bool = Truenum_experts_per_tok: int = 2routed_scaling_factor: float | int = 1.0n_group: int = 1topk_group: int = 1norm_topk_prob: bool = Truenum_nextn_predict_layers: int = 0mtp_layers_block_type: list[str] | None = Noneuse_bias: bool = Falseinitializer_range: float = 0.02layer_norm_epsilon: float = 1e-05residual_in_fp32: bool = Falsehidden_dropout: float | int = 0.0rescale_prenorm_residual: bool = True )

Tham số

  • vocab_size (int, tuỳ chọn, mặc định là 131072) — 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.
  • layers_block_type (list, tùy chọn) — Danh sách rõ ràng các loại lớp cho từng lớp. Mỗi phần tử phải là một trong: “mlp”, “linear_attention”, “full_attention” hoặc “moe”. Số lượng lớp được xác định bởi độ dài của danh sách này.
  • 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.
  • 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, tùy chọn, mặc định là 1) — Số lượng prompt logits cần tính trong quá trình sinh. Nếu là None, tất cả các logits sẽ được tính.
  • 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.
  • 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.
  • head_dim (int, tùy chọn, mặc định là 128) — Kích thước chiều của đầu chú ý. Nếu là None, giá trị mặc định sẽ là hidden_size // num_attention_heads
  • max_position_embeddings (int, tùy chọn, mặc định là 4096) — Chiều dài chuỗi tối đa mà mô hình này có thể được sử dụng.
  • 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.
  • 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ú ý.
  • 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.
  • intermediate_size (int, tùy chọn, mặc định là 21504) — Kích thước của các biểu diễn MLP.
  • mlp_hidden_act (str, tùy chọn, mặc định là relu2) — 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.
  • 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.
  • use_mamba_kernels (bool, tùy chọn, mặc định là True) — Đã bị loại bỏ và không có tác dụng. Các kernel Mamba nhanh sẽ được sử dụng tự động khi khả dụng.
  • ssm_state_size (int, tùy chọn, mặc định là 128) — Kích thước của các ẩn không gian trạng thái mamba.
  • mamba_num_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_head_dim (int, tùy chọn, mặc định là 64) — Kích thước chiều nhúng của head
  • mamba_hidden_act (str, tùy chọn, mặc định là "silu") — Hàm kích hoạt phi tuyến trong các lớp Mamba.
  • n_groups (int, tùy chọn, mặc định là 8) — Số lượng nhóm cho các ma trận tiến hóa của các lớp Mamba.
  • conv_kernel (int, tuỳ chọn, mặc định là 4) — Kích thước của nhân tích chập.
  • expand (int, tùy 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 trong các lớp Mamba.
  • 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_limit (Union[list[float], tuple[float, ...]], tùy 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).
  • 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.
  • 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 Mamba hay không.
  • chunk_size (int, tùy chọn, mặc định là 128) — Kích thước của các khối cấu thành chuỗi trong các lớp Mamba.
  • 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_ssm_cache_dtype (str, tùy chọn, mặc định là "float32") — Kiểu dữ liệu cho các trạng thái cache của Mamba SSM.
  • n_routed_experts (int, tùy chọn, mặc định là 8) — Số lượng chuyên gia được định tuyến.
  • 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.
  • n_shared_experts (int, tùy chọn, mặc định là 1) — Số lượng chuyên gia dùng chung.
  • moe_intermediate_size (int, tùy chọn, mặc định là 7688) — Kích thước trung gian của các MLP chuyên gia được định tuyến.
  • moe_shared_expert_intermediate_size (int, tùy chọn, mặc định là 7688) — Kích thước của các biểu diễn MLP trong các chuyên gia dùng chung.
  • moe_latent_size (int, tùy chọn) — Kích thước ẩn cho các phép chiếu chuyên gia MoE. Nếu là None, sẽ sử dụng hidden_size.
  • moe_shared_expert_overlap (bool, tùy chọn, mặc định là True) — Xác định xem các chuyên gia dùng chung có chồng lấn với các chuyên gia được định tuyến hay không.
  • 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.
  • routed_scaling_factor (Union[float, int], tùy chọn, mặc định là 1.0) — Hệ số tỷ lệ hoặc chuyên gia được định tuyến.
  • n_group (int, tùy chọn, mặc định là 1) — Số lượng nhóm cho việc định tuyến chuyên gia.
  • topk_group (int, tuỳ chọn, mặc định là 1) — Số lượng nhóm được chọn cho mỗi token (với mỗi token, đảm bảo các chuyên gia được chọn chỉ nằm trong topk_group nhóm).
  • norm_topk_prob (bool, tùy chọn, mặc định là True) — Có nên chuẩn hóa trọng số của các chuyên gia được định tuyến hay không.
  • num_nextn_predict_layers (int, tùy chọn, mặc định là 0) — Số lượng lớp bổ sung cho dự đoán đa token. Nếu bằng 0, dự đoán đa token sẽ bị tắt.
  • mtp_layers_block_type (list, tùy chọn, mặc định là ['full_attention', 'moe']) — Danh sách rõ ràng các loại lớp cho các lớp dự đoán đa token khi num_nextn_predict_layers > 0.
  • use_bias (bool, tùy chọn, mặc định là False) — Có sử dụng bias trong mô hình hay khô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ố.
  • 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).
  • residual_in_fp32 (bool, tùy chọn, mặc định là False) — Xác định xem các phần dư (residuals) có nên ở dạng float32 hay không.
  • hidden_dropout (Union[float, int], tùy chọn, mặc định là 0.0) — Xác suất dropout cho tất cả các lớp fully connected trong embeddings, encoder và pooler.
  • rescale_prenorm_residual (bool, tùy chọn, mặc định là True) — Có nên điều chỉnh lại tỷ lệ các kết nối phần dư trước chuẩn hóa hay không.

Đây là lớp cấu hình để lưu trữ cấu hình của một NemotronHModel. Nó được sử dụng để khởi tạo một mô hình Nemotron H 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 nvidia/NVIDIA-Nemotron-3-Nano-30B-A3B-BF16

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.

>>> from transformers import NemotronHModel, NemotronHConfig

>>> # Initializing a NemotronH configuration
>>> configuration = NemotronHConfig()

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

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

validate_layer_type

< >

( )

Xác thực danh sách layers_block_type.

NemotronHModel

lớp transformers.NemotronHModel

< >

( config: NemotronHConfig )

forward

< >

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

NemotronHForCausalLM

lớp transformers.NemotronHForCausalLM

< >

( config: NemotronHConfig )

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 ) → 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).
  • 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 (NemotronHConfig) và đầu vào.

Phương thức forward của NemotronHForCausalLM 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, NemotronHForCausalLM

>>> model = NemotronHForCausalLM.from_pretrained("Zyphra/NemotronH-7B-v1")
>>> tokenizer = AutoTokenizer.from_pretrained("Zyphra/NemotronH-7B-v1")

>>> 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."
Update on GitHub

←Nemotron NemotronH Omni→