nologik commited on
Commit
c55171a
·
verified ·
1 Parent(s): 3f3ca0c

Add README and supporting files for Nemotron Nano 12B v2 GGUF Q4_K_M

Browse files
.gitattributes CHANGED
@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
 
 
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
36
+ tokenizer.json filter=lfs diff=lfs merge=lfs -text
README.md CHANGED
@@ -1,3 +1,128 @@
1
- ---
2
- license: apache-2.0
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: other
3
+ base_model: nvidia/NVIDIA-Nemotron-Nano-12B-v2
4
+ library_name: llama.cpp
5
+ tags:
6
+ - gguf
7
+ - quantized
8
+ - 4-bit
9
+ - Q4_K_M
10
+ - nemotron
11
+ - 12B
12
+ - tool-calling
13
+ - thinking
14
+ - 128k
15
+ - multilingual
16
+ - llama.cpp
17
+ - ollama
18
+ ---
19
+
20
+ # NVIDIA Nemotron Nano 12B v2 - GGUF Q4_K_M (7GB)
21
+
22
+ This repository provides a 4-bit quantized GGUF build of NVIDIA Nemotron Nano 12B v2 using Q4_K_M, reducing the on-disk size to approximately 7GB from roughly 23GB for the original full precision weights, while preserving core capabilities.
23
+
24
+ **Upstream base model:** [nvidia/NVIDIA-Nemotron-Nano-12B-v2](https://huggingface.co/nvidia/NVIDIA-Nemotron-Nano-12B-v2)
25
+
26
+ **SHA256:** `82ea4805d2f9f37e3c67b06768141ff58e43fb0dcd3983a82e9c2f481eb7fea8`
27
+
28
+ ## What's included
29
+
30
+ - `model-q4.gguf` (7.0GB)
31
+ - `tokenizer.json`
32
+ - `tokenizer_config.json`
33
+ - `special_tokens_map.json`
34
+ - `config.json`
35
+ - `generation_config.json`
36
+ - `configuration_nemotron_h.py`
37
+ - `modeling_nemotron_h.py`
38
+ - `nemotron_toolcall_parser_no_streaming.py`
39
+ - `bias.md`, `explainability.md`, `privacy.md`, `safety.md`
40
+ - `acc-vs-budget.png`
41
+ - `README.md`
42
+
43
+ ## Capabilities
44
+
45
+ - ✓ Tool calling support via preserved special tokens and helper parser script
46
+ - ✓ Thinking mode tokens for structured reasoning
47
+ - ✓ Long-context up to 128k window
48
+ - ✓ Multilingual general-purpose LLM behavior
49
+
50
+ **Note:** GGUF inference backends may vary in their native support for tool-calling integrations; use the included parser or your own orchestration as needed.
51
+
52
+ ## Hardware notes
53
+
54
+ - **Disk space:** 8GB free recommended for the quantized file and metadata
55
+ - **CPU inference:** 16GB RAM recommended for 4k contexts; 32GB suggested for comfortable operation. For 128k contexts, memory usage grows significantly and 64 to 128GB system RAM may be required
56
+ - **GPU offload:** 8 to 16GB VRAM can accelerate decoding with llama.cpp `-ngl` offloading; very long contexts may require 24 to 48GB VRAM or hybrid CPU plus GPU offload
57
+ - **Throughput:** Depends on backend, threads, and offload settings
58
+
59
+ ## Usage
60
+
61
+ ### llama.cpp
62
+
63
+ Build llama.cpp, then run:
64
+
65
+ **Generate:**
66
+ ```bash
67
+ ./llama-cli -m model-q4.gguf -p "Hello, Nemotron." -n 128 -t 8 -c 4096 -ngl 35
68
+ ```
69
+
70
+ **Server:**
71
+ ```bash
72
+ ./llama-server -m model-q4.gguf -c 4096 -ngl 35
73
+ ```
74
+
75
+ For very long contexts, increase `-c` accordingly and ensure sufficient RAM or VRAM for KV cache.
76
+
77
+ ### Python via llama-cpp-python
78
+
79
+ ```bash
80
+ pip install llama-cpp-python
81
+ ```
82
+
83
+ ```python
84
+ from llama_cpp import Llama
85
+ llm = Llama(model_path="model-q4.gguf", n_ctx=4096, n_threads=8)
86
+ out = llm("Write a short greeting.", max_tokens=128)
87
+ print(out)
88
+ ```
89
+
90
+ ### Ollama
91
+
92
+ Create a Modelfile referencing this repo, then create and run:
93
+
94
+ **Modelfile:**
95
+ ```
96
+ FROM hf.co/Avarok/nvidia-nemotron-nano-12b-v2-q4_k_m
97
+ PARAMETER num_ctx 4096
98
+ ```
99
+
100
+ **Commands:**
101
+ ```bash
102
+ ollama create nemotron-nano-12b-q4km -f Modelfile
103
+ ollama run nemotron-nano-12b-q4km
104
+ ```
105
+
106
+ **Note:** Ollama versions and syntax may evolve; consult Ollama docs if the Modelfile interface changes.
107
+
108
+ ## License and attribution
109
+
110
+ - **Base model:** NVIDIA Nemotron Nano 12B v2
111
+ - **License:** This GGUF quantized derivative is subject to the original model's license and terms. See the [upstream model card](https://huggingface.co/nvidia/NVIDIA-Nemotron-Nano-12B-v2) and license. By using this repository you agree to comply with NVIDIA's licensing for Nemotron models
112
+ - **Attribution:** If you use this model, please attribute both NVIDIA for the base model and this repository for the quantized packaging
113
+
114
+ ## Reproducibility
115
+
116
+ This artifact was produced by converting the upstream weights to GGUF and quantizing with Q4_K_M. An equivalent quantization command with llama.cpp tools is:
117
+
118
+ ```bash
119
+ llama-quantize input.gguf model-q4.gguf Q4_K_M
120
+ ```
121
+
122
+ Exact commands may differ based on the conversion workflow for the upstream model version.
123
+
124
+ ## Safety
125
+
126
+ Review the included bias, privacy, and safety documents. As with all LLMs, outputs may be inaccurate or unsafe without proper safeguards and human oversight.
127
+
128
+ ![Accuracy vs Budget](acc-vs-budget.png)
acc-vs-budget.png ADDED
bias.md ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ | Field | Response |
2
+ | :---- | :---- |
3
+ | Participation considerations from adversely impacted groups [protected classes](https://www.senate.ca.gov/content/protected-classes) in model design and testing: | None |
4
+ | Bias Metric (If Measured): | [BBQ Accuracy Scores in Ambiguous Contexts](https://github.com/nyu-mll/BBQ/) |
5
+ | Which characteristic (feature) show(s) the greatest difference in performance?: | The model shows high variance in the characteristics when it is used with a high temperature. |
6
+ | Which feature(s) have the worst performance overall? | Age |
7
+ | Measures taken to mitigate against unwanted bias: | None |
8
+ | If using internal data, description of methods implemented in data acquisition or processing, if any, to address the prevalence of identifiable biases in the training, testing, and validation data: | The training datasets contain a large amount of synthetic data generated by LLMs. We manually curated prompts. |
9
+ | Tools used to assess statistical imbalances and highlight patterns that may introduce bias into AI models: | [BBQ](https://github.com/nyu-mll/BBQ/) |
10
+ | Tools used to assess statistical imbalances and highlight patterns that may introduce bias into AI models: | These datasets, such as Common Crawl, CC-News, and Wikimedia, do not collectively or exhaustively represent all demographic groups (and proportionally therein). For instance, these datasets do not contain explicit mentions of demographic classes such as age, gender, or ethnicity in over 85% of samples. In the subset where such terms are present, Common Crawl and CC-News contain notable representational skews—for example, references to "male" significantly outnumber those to "female," and mentions of "White" are the most frequent among ethnic identifiers. To mitigate these imbalances, we recommend considering evaluation techniques such as bias audits, fine-tuning with demographically balanced datasets, and mitigation strategies like counterfactual data augmentation to align with the desired model behavior. This evaluation used a 3,000-sample subset per dataset, identified as the optimal threshold for maximizing embedder accuracy, and includes outputs from uncalibrated embedders; as such, certain limitations may exist in the reliability of the embedding. |
config.json ADDED
@@ -0,0 +1,57 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "architectures": [
3
+ "NemotronHForCausalLM"
4
+ ],
5
+ "attention_bias": false,
6
+ "attention_dropout": 0.0,
7
+ "head_dim": 128,
8
+ "auto_map": {
9
+ "AutoConfig": "configuration_nemotron_h.NemotronHConfig",
10
+ "AutoModelForCausalLM": "modeling_nemotron_h.NemotronHForCausalLM"
11
+ },
12
+ "bos_token_id": 1,
13
+ "chunk_size": 128,
14
+ "conv_kernel": 4,
15
+ "eos_token_id": 12,
16
+ "hidden_dropout": 0.0,
17
+ "hidden_size": 5120,
18
+ "hybrid_override_pattern": "M-M-M-M*-M-M-M-M*-M-M-M-M*-M-M-M-M*-M-M-M-M*-M-M-M-M*-M-M-M-M-",
19
+ "initializer_range": 0.02,
20
+ "intermediate_size": 20480,
21
+ "layer_norm_epsilon": 1e-05,
22
+ "mamba_head_dim": 80,
23
+ "mamba_hidden_act": "silu",
24
+ "mamba_num_heads": 128,
25
+ "mamba_proj_bias": false,
26
+ "max_position_embeddings": 131072,
27
+ "mlp_bias": false,
28
+ "mlp_hidden_act": "relu2",
29
+ "model_type": "nemotron_h",
30
+ "n_groups": 8,
31
+ "num_attention_heads": 40,
32
+ "num_hidden_layers": 62,
33
+ "num_key_value_heads": 8,
34
+ "num_logits_to_keep": 1,
35
+ "pad_token_id": 0,
36
+ "rescale_prenorm_residual": true,
37
+ "residual_in_fp32": false,
38
+ "rms_norm_eps": 1e-05,
39
+ "sliding_window": null,
40
+ "ssm_state_size": 128,
41
+ "tie_word_embeddings": false,
42
+ "time_step_floor": 0.0001,
43
+ "time_step_limit": [
44
+ 0.0,
45
+ Infinity
46
+ ],
47
+ "time_step_max": 0.1,
48
+ "time_step_min": 0.001,
49
+ "time_step_rank": 256,
50
+ "torch_dtype": "bfloat16",
51
+ "transformers_version": "4.51.3",
52
+ "use_bias": false,
53
+ "use_cache": true,
54
+ "use_conv_bias": true,
55
+ "use_mamba_kernels": true,
56
+ "vocab_size": 131072
57
+ }
configuration_nemotron_h.py ADDED
@@ -0,0 +1,245 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # coding=utf-8
2
+ # Copyright 2024 AI21 Labs Ltd. and the HuggingFace Inc. team. All rights reserved.
3
+ # Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+ """NemotronH model configuration"""
17
+
18
+ import re
19
+
20
+ from transformers.configuration_utils import PretrainedConfig
21
+ from transformers.utils import logging
22
+
23
+
24
+ logger = logging.get_logger(__name__)
25
+
26
+
27
+ class NemotronHConfig(PretrainedConfig):
28
+ r"""
29
+ This is the configuration class to store the configuration of a [`NemotronHModel`]. It is used to instantiate a
30
+ NemotronH model according to the specified arguments, defining the model architecture. Instantiating a configuration
31
+ with the defaults will yield a similar configuration to that of the NemotronH-v0.1 model.
32
+
33
+ [todo](todo)
34
+
35
+ Configuration objects inherit from [`PretrainedConfig`] and can be used to control the model outputs. Read the
36
+ documentation from [`PretrainedConfig`] for more information.
37
+
38
+
39
+ Args:
40
+ vocab_size (`int`, *optional*, defaults to 131072):
41
+ Vocabulary size of the NemotronH model. Defines the number of different tokens that can be represented by the
42
+ `inputs_ids` passed when calling [`NemotronHModel`]
43
+ tie_word_embeddings (`bool`, *optional*, defaults to `False`):
44
+ Whether the model's input and output word embeddings should be tied. Note that this is only relevant if the
45
+ model has a output word embedding layer.
46
+ hidden_size (`int`, *optional*, defaults to 4096):
47
+ Dimension of the hidden representations.
48
+ intermediate_size (`int`, *optional*, defaults to 21504):
49
+ Dimension of the MLP representations.
50
+ num_hidden_layers (`int`, *optional*, defaults to 52):
51
+ Number of hidden layers in the Transformer encoder.
52
+ hybrid_override_pattern (`str`, *optional*, defaults to `"M-M-M-M*-M-M-M-M-M*-M-M-M-M-M*-M-M-M-M-M*-M-M-M-M-M-"`):
53
+ The pattern of the hybrid model. The pattern is a string of characters where each character represents M: Mamba2, *: Attention, -: MLP
54
+ num_attention_heads (`int`, *optional*, defaults to 32):
55
+ Number of attention heads for each attention layer in the Transformer encoder.
56
+ attention_head_dim (`int`, *optional*, defaults to 128):
57
+ Dimension of each attention head.
58
+ num_key_value_heads (`int`, *optional*, defaults to 8):
59
+ This is the number of key_value heads that should be used to implement Grouped Query Attention. If
60
+ `num_key_value_heads=num_attention_heads`, the model will use Multi Head Attention (MHA), if
61
+ `num_key_value_heads=1` the model will use Multi Query Attention (MQA) otherwise GQA is used.
62
+ mlp_hidden_act (`str`, *optional*, defaults to "relu2"):
63
+ The non-linear activation function in the MLP layers.
64
+ attention_bias (`bool`, *optional*, defaults to `False`):
65
+ Whether to use bias in attention layers.
66
+ mlp_bias (`bool`, *optional*, defaults to `False`):
67
+ Whether to use bias in MLP layers.
68
+ use_bias (`bool`, *optional*, defaults to `False`):
69
+ Whether to use bias in the model.
70
+ initializer_range (`float`, *optional*, defaults to 0.02):
71
+ The standard deviation of the truncated_normal_initializer for initializing all weight matrices.
72
+ layer_norm_epsilon (`float`, *optional*, defaults to 1e-5):
73
+ The epsilon used by the layer normalization layers.
74
+ residual_in_fp32 (`bool`, *optional*, defaults to `False`):
75
+ Whether or not residuals should be in `float32`. If set to `False` residuals will keep the same `dtype` as the rest of the model.
76
+ use_cache (`bool`, *optional*, defaults to `True`):
77
+ Whether or not the model should return the last key/values attentions (not used by all models). Only
78
+ relevant if `config.is_decoder=True`.
79
+ num_logits_to_keep (`int` or `None`, *optional*, defaults to 1):
80
+ Number of prompt logits to calculate during generation. If `None`, all logits will be calculated. If an
81
+ integer value, only last `num_logits_to_keep` logits will be calculated.
82
+ pad_token_id (`int`, *optional*, defaults to 0):
83
+ The id of the padding token.
84
+ bos_token_id (`int`, *optional*, defaults to 1):
85
+ The id of the "beginning-of-sequence" token.
86
+ eos_token_id (`int`, *optional*, defaults to 2):
87
+ The id of the "end-of-sequence" token.
88
+ sliding_window (`int`, *optional*, defaults to None):
89
+ Sliding window attention window size.
90
+ max_position_embeddings (`int`, *optional*, defaults to 4096):
91
+ The maximum sequence length that this model might ever be used with.
92
+ attention_dropout (`float`, *optional*, defaults to 0.0):
93
+ The dropout ratio for the attention probabilities.
94
+ hidden_dropout (`float`, *optional*, defaults to 0.0):
95
+ The dropout ratio for the hidden states.
96
+ use_mamba_kernels (`bool`, *optional*, defaults to `True`):
97
+ Flag indicating whether or not to use the fast mamba kernels. These are available only if `mamba-ssm` and
98
+ `causal-conv1d` are installed, and the mamba modules are running on a CUDA device.
99
+ ssm_state_size (`int`, *optional*, defaults to 128):
100
+ The dimension of the mamba state space latents.
101
+ mamba_num_heads (`int`, *optional*, defaults to 128):
102
+ Number of heads in Mamba layers.
103
+ mamba_n_groups (`int`, *optional*, defaults to 8):
104
+ Number of groups in Mamba layers.
105
+ mamba_head_dim (`int`, *optional*, defaults to 64):
106
+ Dimension of each Mamba head.
107
+ mamba_d_conv (`int`, *optional*, defaults to 4):
108
+ The size of the mamba convolution kernel.
109
+ mamba_expand (`int`, *optional*, defaults to 2):
110
+ Expanding factor used to determine the mamba intermediate size.
111
+ mamba_hidden_act (`str`, *optional*, defaults to "silu"):
112
+ The non-linear activation function in the Mamba layers.
113
+ mamba_dt_min (`float`, *optional*, defaults to 0.001):
114
+ Minimum value for the time step in Mamba.
115
+ mamba_dt_max (`float`, *optional*, defaults to 0.1):
116
+ Maximum value for the time step in Mamba.
117
+ mamba_dt_limit (`tuple`, *optional*, defaults to (0.0, float("inf"))):
118
+ Limits for the time step in Mamba.
119
+ mamba_dt_init_floor (`float`, *optional*, defaults to 1e-4):
120
+ Floor value for time step initialization in Mamba.
121
+ mamba_conv_bias (`bool`, *optional*, defaults to `True`):
122
+ Whether to use bias in the convolution layer of the mamba mixer block.
123
+ mamba_proj_bias (`bool`, *optional*, defaults to `False`):
124
+ Whether to use bias in the input and output projections of the mamba mixer block.
125
+ mamba_chunk_size (`int`, *optional*, defaults to 256):
126
+ Size of chunks for Mamba processing.
127
+ rescale_prenorm_residual (`bool`, *optional*, defaults to `True`):
128
+ Whether to rescale the pre-normalization residual connections.
129
+ """
130
+
131
+ model_type = "nemotron_h"
132
+ keys_to_ignore_at_inference = ["past_key_values"]
133
+
134
+ def __init__(
135
+ self,
136
+ vocab_size=131072,
137
+ tie_word_embeddings=False,
138
+ hidden_size=4096,
139
+ intermediate_size=21504,
140
+ num_hidden_layers=52,
141
+ hybrid_override_pattern="M-M-M-M*-M-M-M-M-M*-M-M-M-M-M*-M-M-M-M-M*-M-M-M-M-M-",
142
+ num_attention_heads=32,
143
+ #attention_head_dim=128,
144
+ head_dim=128,
145
+ num_key_value_heads=8, # nemo: num_query_groups
146
+ mlp_hidden_act="relu2",
147
+ attention_bias=False,
148
+ mlp_bias=False,
149
+ use_bias=False,
150
+ initializer_range=0.02, # nemo: init_method_std
151
+ layer_norm_epsilon=1e-5, # nemo: layernorm_epsilon
152
+ residual_in_fp32=False, # Megatron Core default value
153
+ use_cache=True,
154
+ num_logits_to_keep=1,
155
+ pad_token_id=0,
156
+ bos_token_id=1,
157
+ eos_token_id=2,
158
+ sliding_window=None,
159
+ max_position_embeddings=4096,
160
+ attention_dropout=0.0,
161
+ hidden_dropout=0.0, # * ADDED
162
+ use_mamba_kernels=True,
163
+ ssm_state_size=128, # mamba_state_size
164
+ mamba_num_heads=128,
165
+ mamba_n_groups=8, # nemo: mamba_ssm_ngroups = num_heads
166
+ mamba_head_dim=64,
167
+ mamba_d_conv=4,
168
+ mamba_expand=2,
169
+ mamba_hidden_act="silu",
170
+ mamba_dt_min=0.001,
171
+ mamba_dt_max=0.1,
172
+ mamba_dt_limit=(0.0, float("inf")),
173
+ mamba_dt_init_floor=1e-4,
174
+ mamba_conv_bias=True,
175
+ mamba_proj_bias=False,
176
+ mamba_chunk_size=256,
177
+ rescale_prenorm_residual=True,
178
+ **kwargs,
179
+ ):
180
+ self.vocab_size = vocab_size
181
+ self.tie_word_embeddings = tie_word_embeddings
182
+ self.hidden_size = hidden_size
183
+ self.intermediate_size = intermediate_size
184
+ self.num_hidden_layers = num_hidden_layers
185
+ self.hybrid_override_pattern = hybrid_override_pattern
186
+ self.num_attention_heads = num_attention_heads
187
+ #self.attention_head_dim = attention_head_dim
188
+ self.head_dim = head_dim
189
+ self.sliding_window = sliding_window
190
+ self.max_position_embeddings = max_position_embeddings
191
+ self.attention_dropout = attention_dropout
192
+ self.hidden_dropout = hidden_dropout
193
+
194
+ # Validate hybrid_override_pattern
195
+ # M: Mamba2, *: Attention, -: MLP
196
+ assert len(self.hybrid_override_pattern) == self.num_hidden_layers, "hybrid_override_pattern must have the same length as num_hidden_layers"
197
+ assert re.match(r"^[*-M]+$", self.hybrid_override_pattern), "hybrid_override_pattern must only contain characters 'M', '*', or '-'"
198
+
199
+ # for backward compatibility
200
+ if num_key_value_heads is None:
201
+ num_key_value_heads = num_attention_heads
202
+
203
+ self.num_key_value_heads = num_key_value_heads
204
+ self.mlp_hidden_act = mlp_hidden_act
205
+ self.attention_bias = attention_bias
206
+ self.mlp_bias = mlp_bias
207
+ self.use_bias = use_bias
208
+ self.initializer_range = initializer_range
209
+ self.layer_norm_epsilon = layer_norm_epsilon
210
+ self.residual_in_fp32 = residual_in_fp32
211
+
212
+ self.use_cache = use_cache
213
+ self.num_logits_to_keep = num_logits_to_keep
214
+
215
+ self.use_mamba_kernels = use_mamba_kernels
216
+ self.n_groups = mamba_n_groups
217
+ self.mamba_head_dim = mamba_head_dim
218
+ self.ssm_state_size = ssm_state_size
219
+ self.mamba_num_heads = mamba_num_heads
220
+ self.conv_kernel = mamba_d_conv
221
+ self.expand = mamba_expand
222
+ self.mamba_hidden_act = mamba_hidden_act
223
+ self.time_step_min = mamba_dt_min
224
+ self.time_step_max = mamba_dt_max
225
+ self.time_step_limit = mamba_dt_limit
226
+ self.time_step_floor = mamba_dt_init_floor
227
+ self.use_conv_bias = mamba_conv_bias
228
+ self.mamba_proj_bias = mamba_proj_bias
229
+ self.chunk_size = mamba_chunk_size
230
+ self.rescale_prenorm_residual = rescale_prenorm_residual
231
+
232
+ super().__init__(
233
+ pad_token_id=pad_token_id,
234
+ bos_token_id=bos_token_id,
235
+ eos_token_id=eos_token_id,
236
+ tie_word_embeddings=tie_word_embeddings,
237
+ **kwargs,
238
+ )
239
+
240
+ @property
241
+ def layers_block_type(self):
242
+ return [
243
+ "mamba" if self.hybrid_override_pattern[i] == "M" else
244
+ "attention" if self.hybrid_override_pattern[i] == "*" else "mlp"
245
+ for i in range(self.num_hidden_layers)]
explainability.md ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ | Field | Response |
2
+ | :---- | :---- |
3
+ | Intended Task/Domain: | Text generation, reasoning, and chat |
4
+ | Model Type: | Text-to-text Mamba2-Transformer Hybrid |
5
+ | Intended Users: | Generative AI creators working with conversational AI models and image content. |
6
+ | Output: | Text |
7
+ | Tools used to evaluate datasets to identify synthetic data and ensure data authenticity. | We used a Gemma-3 4B-based filtering model fine-tuned on [Nemotron Content Safety Dataset v2](https://huggingface.co/datasets/nvidia/Aegis-AI-Content-Safety-Dataset-2.0) to ensure the quality of synthetic data. |
8
+ | Describe how the model works: | Generates text by predicting the next word or token based on the context provided in the input sequence using multiple self-attention layers. |
9
+ | Name the adversely impacted groups this has been tested to deliver comparable outcomes regardless of: | Not Applicable |
10
+ | Technical Limitations & Mitigation: | The model demonstrates weakness to alignment-breaking attacks. Users are advised to deploy language model guardrails alongside this model to prevent potentially harmful outputs. The Model may generate answers that are inaccurate, omit key information, or include irrelevant or redundant text. |
11
+ | Verified to have met prescribed NVIDIA quality standards: | Yes |
12
+ | Performance Metrics: | Accuracy, Throughput, and User-side throughput |
13
+ | Potential Known Risks: | The model was optimized explicitly for instruction following and as such is more susceptible to prompt injection and jailbreaking in various forms as a result of its instruction tuning. This means that the model should be paired with additional rails or system filtering to limit exposure to instructions from malicious sources \-- either directly or indirectly by retrieval (e.g. via visiting a website) \-- as they may yield outputs that can lead to harmful, system-level outcomes up to and including remote code execution in agentic systems when effective security controls including guardrails are not in place. The model was trained on data that contains toxic language and societal biases originally crawled from the internet. Therefore, the model may amplify those biases and return toxic responses especially when prompted with toxic prompts. The model may generate answers that may be inaccurate, omit key information, or include irrelevant or redundant text producing socially unacceptable or undesirable text, even if the prompt itself does not include anything explicitly offensive. |
14
+ | Licensing: | [NVIDIA Open Model License Agreement](https://www.nvidia.com/en-us/agreements/enterprise-software/nvidia-open-model-license/) |
generation_config.json ADDED
@@ -0,0 +1,11 @@
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_from_model_config": true,
3
+ "bos_token_id": 1,
4
+ "eos_token_id": [
5
+ 2,
6
+ 11,
7
+ 12
8
+ ],
9
+ "pad_token_id": 0,
10
+ "transformers_version": "4.51.3"
11
+ }
modeling_nemotron_h.py ADDED
@@ -0,0 +1,1638 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # coding=utf-8
2
+ # Copyright 2024 HuggingFace Inc. team.
3
+ # Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+ """PyTorch NemotronH model."""
17
+
18
+ import math
19
+ from dataclasses import dataclass
20
+ from typing import Any, Dict, Optional, Tuple, Union
21
+
22
+ import torch
23
+ import torch.utils.checkpoint
24
+ from torch import nn
25
+ from torch.nn import CrossEntropyLoss
26
+
27
+ from transformers.activations import ACT2FN
28
+ from transformers.cache_utils import DynamicCache # we need __iter__ and __len__ of pkv
29
+ from transformers.generation import GenerationMixin
30
+ from transformers.modeling_attn_mask_utils import (
31
+ AttentionMaskConverter,
32
+ )
33
+ from transformers.modeling_utils import PreTrainedModel
34
+ from transformers.utils import (
35
+ ModelOutput,
36
+ add_code_sample_docstrings,
37
+ add_start_docstrings,
38
+ add_start_docstrings_to_model_forward,
39
+ logging,
40
+ )
41
+ from transformers.utils.import_utils import (
42
+ is_causal_conv1d_available,
43
+ is_flash_attn_2_available,
44
+ is_flash_attn_greater_or_equal_2_10,
45
+ is_mamba_2_ssm_available,
46
+ )
47
+ from .configuration_nemotron_h import NemotronHConfig
48
+
49
+
50
+ logger = logging.get_logger(__name__)
51
+
52
+
53
+ # Copied from transformers.models.mamba.modeling_mamba2.modeling_mamba2.py with MAMBA2->NEMOTRONH,Mamba2->NemotronH
54
+ # For Mamba2 components Mamba2->NemotronHMamba2
55
+ if is_mamba_2_ssm_available():
56
+ from mamba_ssm.ops.triton.selective_state_update import selective_state_update
57
+ from mamba_ssm.ops.triton.ssd_combined import mamba_chunk_scan_combined, mamba_split_conv1d_scan_combined
58
+ else:
59
+ mamba_chunk_scan_combined, mamba_split_conv1d_scan_combined, selective_state_update = None, None, None
60
+
61
+ try:
62
+ #from mamba_ssm.ops.triton.layernorm_gated import RMSNorm as RMSNormGated
63
+ from mamba_ssm.ops.triton.layernorm_gated import rmsnorm_fn
64
+ except ImportError:
65
+ raise ImportError("mamba-ssm is required by the Mamba model but cannot be imported")
66
+
67
+ if is_causal_conv1d_available():
68
+ from causal_conv1d import causal_conv1d_fn, causal_conv1d_update
69
+ else:
70
+ causal_conv1d_update, causal_conv1d_fn = None, None
71
+
72
+ if is_flash_attn_2_available():
73
+ from transformers.modeling_flash_attention_utils import _flash_attention_forward
74
+
75
+ is_fast_path_available = all(
76
+ (
77
+ selective_state_update,
78
+ mamba_chunk_scan_combined,
79
+ mamba_split_conv1d_scan_combined,
80
+ causal_conv1d_fn,
81
+ causal_conv1d_update,
82
+ )
83
+ )
84
+
85
+
86
+ _CHECKPOINT_FOR_DOC = "nvidia/Nemotron-H-56B-Base-8K"
87
+ _CONFIG_FOR_DOC = "NemotronHConfig"
88
+
89
+
90
+ # Helper methods for segment sum computation
91
+
92
+
93
+ def pad_tensor_by_size(input_tensor: torch.Tensor, pad_size: int):
94
+ """
95
+ Padding x tensor with `pad_size` on the seq_len dim (dim=1)
96
+
97
+ Assumes that we only have tensors of either size 4 or 3
98
+ """
99
+ pad_shape = (0, 0, 0, 0, 0, pad_size, 0, 0) if len(input_tensor.shape) == 4 else (0, 0, 0, pad_size, 0, 0)
100
+
101
+ return torch.nn.functional.pad(input_tensor, pad_shape, mode="constant", value=0)
102
+
103
+
104
+ def reshape_into_chunks(input_tensor, pad_size, chunk_size):
105
+ """
106
+ Padding input_tensor with `pad_size` on the seq_len dim (dim=1) and
107
+ simultaneously splitting it into chunk sequences.
108
+
109
+ Assumes that we only have tensors of either size 4 or 3
110
+ """
111
+ # [bsz, seq_len, ...] -> [bsz, seq_len multiple of chunk_size, ...]
112
+ input_tensor = pad_tensor_by_size(input_tensor, pad_size)
113
+
114
+ if len(input_tensor.shape) == 3:
115
+ # [bsz, seq_len multiple of chunk_size, num_heads] -> [bsz, -1, chunk_size, num_heads]
116
+ return input_tensor.reshape(input_tensor.shape[0], -1, chunk_size, input_tensor.shape[2])
117
+ else:
118
+ # [bsz, seq_len multiple of chunk_size, num_heads, head_dim or state_size] -> [bsz, -1, chunk_size, num_heads, head_dim or state_size]
119
+ return input_tensor.reshape(
120
+ input_tensor.shape[0], -1, chunk_size, input_tensor.shape[2], input_tensor.shape[3]
121
+ )
122
+
123
+
124
+ def segment_sum(input_tensor):
125
+ """
126
+ More stable segment sum calculation. Uses cumulative sums and masking instead of direct subtractions.
127
+ """
128
+ chunk_size = input_tensor.size(-1)
129
+ # 1. expand input tensor to have an additional dimension and repeat along that dimension
130
+ # [..., chunk_size] -> [..., chunk_size, chunk_size]
131
+ input_tensor = input_tensor[..., None].expand(*input_tensor.size(), chunk_size)
132
+ # 2. create a lower triangular mask with the diagonal set to 0 to 0 out elements above diag
133
+ mask = torch.tril(torch.ones(chunk_size, chunk_size, device=input_tensor.device, dtype=torch.bool), diagonal=-1)
134
+ input_tensor = input_tensor.masked_fill(~mask, 0)
135
+ # 3. compute actual cumsum
136
+ tensor_segsum = torch.cumsum(input_tensor, dim=-2)
137
+
138
+ # 4. apply mask to keep only the lower triangular part of the cumulative sum result (incl diagonal this time)
139
+ mask = torch.tril(torch.ones(chunk_size, chunk_size, device=input_tensor.device, dtype=torch.bool), diagonal=0)
140
+ tensor_segsum = tensor_segsum.masked_fill(~mask, -torch.inf)
141
+ return tensor_segsum
142
+
143
+
144
+ def apply_mask_to_padding_states(hidden_states, attention_mask):
145
+ """
146
+ Tunes out the hidden states for padding tokens, see https://github.com/state-spaces/mamba/issues/66
147
+ """
148
+ if attention_mask is not None and attention_mask.shape[1] > 1 and attention_mask.shape[0] > 1:
149
+ dtype = hidden_states.dtype
150
+ hidden_states = (hidden_states * attention_mask[:, :, None]).to(dtype)
151
+
152
+ return hidden_states
153
+
154
+ # Copied from https://github.com/huggingface/transformers/blob/main/src/transformers/models/jamba/modeling_jamba.py
155
+ class HybridMambaAttentionDynamicCache(DynamicCache):
156
+ """
157
+ A dynamic cache that can handle both the attention cache (which has a seq_len dimension) and the mamba cache
158
+ (which has a constant shape regardless of seq_len).
159
+
160
+ This cache has two sets of lists of tensors: `key_cache` and `value_cache` for attention cache and `conv_states`
161
+ and `ssm_states` for mamba cache. Each of these lists has `num_layers` tensors. The expected shape for each tensor
162
+ For attention layers, `key_cache` and `value_cache` have a shape of `(batch_size, num_heads, seq_len, head_dim)`,
163
+ while `conv_states` and `ssm_states` have a shape of `(batch_size, 0)` (empty tensors).
164
+ For mamba layers, `key_cache` and `value_cache` have a shape of `(batch_size, 0)` (empty tensors),
165
+ while `conv_states` represents the convolution state and has a shape of `(batch_size, d_inner, d_conv)`,
166
+ and `ssm_states` represents the ssm state and has a shape of `(batch_size, d_inner, d_state)`.
167
+ """
168
+
169
+ def __init__(self, config, batch_size, dtype=torch.float16, device=None):
170
+ super().__init__()
171
+ self.dtype = dtype
172
+ self.hybrid_override_pattern = config.hybrid_override_pattern
173
+ self.has_previous_state = False # only used by mamba
174
+ #intermediate_size = config.expand * config.hidden_size
175
+ intermediate_size = config.mamba_num_heads * config.mamba_head_dim
176
+ ssm_state_size = config.ssm_state_size
177
+ conv_kernel_size = config.conv_kernel
178
+ self.conv_states = []
179
+ self.ssm_states = []
180
+ self.transformer_layers = []
181
+ for i in range(config.num_hidden_layers):
182
+ if self.hybrid_override_pattern[i] == "M":
183
+ # Mamba layer
184
+ self.conv_states += [
185
+ torch.zeros(batch_size, intermediate_size, conv_kernel_size, device=device, dtype=dtype)
186
+ ]
187
+ self.ssm_states += [
188
+ torch.zeros(batch_size, intermediate_size, ssm_state_size, device=device, dtype=dtype)
189
+ ]
190
+ else:
191
+ # Attention or MLP layer
192
+ self.conv_states += [torch.tensor([[]] * batch_size, device=device)]
193
+ self.ssm_states += [torch.tensor([[]] * batch_size, device=device)]
194
+ self.transformer_layers.append(i)
195
+
196
+ self.key_cache = [torch.tensor([[]] * batch_size, device=device) for _ in range(config.num_hidden_layers)]
197
+ self.value_cache = [torch.tensor([[]] * batch_size, device=device) for _ in range(config.num_hidden_layers)]
198
+
199
+ def update(
200
+ self,
201
+ key_states: torch.Tensor,
202
+ value_states: torch.Tensor,
203
+ layer_idx: int,
204
+ cache_kwargs: Optional[Dict[str, Any]] = None,
205
+ ) -> Tuple[torch.Tensor, torch.Tensor]:
206
+ # Update the cache
207
+ if self.key_cache[layer_idx].shape[-1] == 0:
208
+ self.key_cache[layer_idx] = key_states
209
+ self.value_cache[layer_idx] = value_states
210
+ else:
211
+ self.key_cache[layer_idx] = torch.cat([self.key_cache[layer_idx], key_states], dim=2)
212
+ self.value_cache[layer_idx] = torch.cat([self.value_cache[layer_idx], value_states], dim=2)
213
+
214
+ return self.key_cache[layer_idx], self.value_cache[layer_idx]
215
+
216
+ def reorder_cache(self, beam_idx: torch.LongTensor):
217
+ """Reorders the cache for beam search, given the selected beam indices."""
218
+ for layer_idx in range(len(self.key_cache)):
219
+ device = self.key_cache[layer_idx].device
220
+ self.key_cache[layer_idx] = self.key_cache[layer_idx].index_select(0, beam_idx.to(device))
221
+ device = self.value_cache[layer_idx].device
222
+ self.value_cache[layer_idx] = self.value_cache[layer_idx].index_select(0, beam_idx.to(device))
223
+
224
+ device = self.conv_states[layer_idx].device
225
+ self.conv_states[layer_idx] = self.conv_states[layer_idx].index_select(0, beam_idx.to(device))
226
+ device = self.ssm_states[layer_idx].device
227
+ self.ssm_states[layer_idx] = self.ssm_states[layer_idx].index_select(0, beam_idx.to(device))
228
+
229
+ def get_seq_length(self, layer_idx: Optional[int] = 0) -> int:
230
+ """Returns the sequence length of the cached states. A layer index can be optionally passed."""
231
+ # take any layer that contains cache and not empty tensor
232
+ layer_idx = self.transformer_layers[0] if layer_idx not in self.transformer_layers else layer_idx
233
+ if len(self.key_cache) <= layer_idx:
234
+ return 0
235
+ return self.key_cache[layer_idx].shape[-2]
236
+
237
+ def to_legacy_cache(self) -> Tuple[Tuple[torch.Tensor], Tuple[torch.Tensor]]:
238
+ raise NotImplementedError("HybridMambaAttentionDynamicCache does not have a legacy cache equivalent.")
239
+
240
+ @classmethod
241
+ def from_legacy_cache(cls, past_key_values: Optional[Tuple[Tuple[torch.FloatTensor]]] = None) -> "DynamicCache":
242
+ raise NotImplementedError("HybridMambaAttentionDynamicCache does not have a legacy cache equivalent.")
243
+
244
+ # Copied from modeling_mamba2.py
245
+ def update_conv_state(
246
+ self, layer_idx: int, new_conv_state: torch.Tensor, cache_init: bool = False
247
+ ) -> torch.Tensor:
248
+ if cache_init:
249
+ self.conv_states[layer_idx] = new_conv_state.to(self.conv_states.device)
250
+ else:
251
+ self.conv_states[layer_idx] = self.conv_states[layer_idx].roll(shifts=-1, dims=-1)
252
+ self.conv_states[layer_idx][:, :, -1] = new_conv_state[:, 0, :].to(self.conv_states.device)
253
+ return self.conv_states[layer_idx]
254
+
255
+ def update_ssm_state(self, layer_idx: int, new_ssm_state: torch.Tensor):
256
+ self.ssm_states[layer_idx] = new_ssm_state.to(self.ssm_states.device)
257
+ return self.ssm_states[layer_idx]
258
+
259
+ def reset(self):
260
+ self.conv_states.zero_()
261
+ self.ssm_states.zero_()
262
+
263
+ class MambaRMSNormGated(torch.nn.Module):
264
+ def __init__(self, hidden_size, group_size, eps=1e-5):
265
+ super().__init__()
266
+ self.weight = nn.Parameter(torch.ones(hidden_size))
267
+ self.variance_epsilon = eps
268
+ self.group_size = group_size
269
+
270
+ # jan28b version
271
+ def forward(self, hidden_states, gate=None):
272
+ return rmsnorm_fn(x=hidden_states,
273
+ weight=self.weight,
274
+ bias=None, # No bias
275
+ z=gate,
276
+ eps=self.variance_epsilon,
277
+ group_size=self.group_size,
278
+ norm_before_gate=False
279
+ )
280
+
281
+ class NemotronHMamba2Mixer(nn.Module):
282
+ """
283
+ Compute ∆, A, B, C, and D the state space parameters and compute the `contextualized_states`.
284
+ A, D are input independent (see Mamba paper [1] Section 3.5.2 "Interpretation of A" for why A isn't selective)
285
+ ∆, B, C are input-dependent (this is a key difference between Mamba and the linear time invariant S4,
286
+ and is why Mamba is called **selective** state spaces)
287
+ """
288
+
289
+ def __init__(self, config: NemotronHConfig, layer_idx: int):
290
+ super().__init__()
291
+ self.num_heads = config.mamba_num_heads
292
+ self.hidden_size = config.hidden_size
293
+ self.ssm_state_size = config.ssm_state_size
294
+ self.conv_kernel_size = config.conv_kernel
295
+ self.intermediate_size = config.mamba_num_heads * config.mamba_head_dim
296
+ self.layer_idx = layer_idx
297
+ self.use_conv_bias = config.use_conv_bias
298
+ self.activation = config.mamba_hidden_act
299
+ self.act = ACT2FN[config.mamba_hidden_act]
300
+
301
+ self.layer_norm_epsilon = config.layer_norm_epsilon
302
+
303
+ self.n_groups = config.n_groups
304
+ self.head_dim = config.mamba_head_dim
305
+ self.chunk_size = config.chunk_size
306
+
307
+ self.time_step_limit = config.time_step_limit
308
+ self.time_step_min = config.time_step_min
309
+ self.time_step_max = config.time_step_max
310
+
311
+ self.conv_dim = self.intermediate_size + 2 * self.n_groups * self.ssm_state_size
312
+ self.conv1d = nn.Conv1d(
313
+ in_channels=self.conv_dim,
314
+ out_channels=self.conv_dim,
315
+ bias=config.use_conv_bias,
316
+ kernel_size=config.conv_kernel,
317
+ groups=self.conv_dim,
318
+ padding=config.conv_kernel - 1,
319
+ )
320
+
321
+ # projection of the input hidden states
322
+ projection_size = self.intermediate_size + self.conv_dim + self.num_heads
323
+ self.in_proj = nn.Linear(
324
+ self.hidden_size,
325
+ projection_size,
326
+ bias=config.use_bias,
327
+ )
328
+ # selective projection used to make dt, B and C input dependant
329
+
330
+ # time step projection (discretization)
331
+ # instantiate once and copy inv_dt in init_weights of PretrainedModel
332
+ self.dt_bias = nn.Parameter(torch.ones(self.num_heads))
333
+
334
+ # S4D real initialization. These are not discretized!
335
+ # The core is to load them, compute the discrete states, then write the updated state. Keeps the memory bounded
336
+ A = torch.arange(1, self.num_heads + 1)
337
+ self.A_log = nn.Parameter(torch.log(A))
338
+ self.A_log._no_weight_decay = True
339
+ self.norm = MambaRMSNormGated(self.intermediate_size, eps=self.layer_norm_epsilon, group_size=self.intermediate_size // self.n_groups)
340
+ self.D = nn.Parameter(torch.ones(self.num_heads))
341
+ self.D._no_weight_decay = True
342
+
343
+ self.out_proj = nn.Linear(self.intermediate_size, self.hidden_size, bias=config.use_bias)
344
+ self.use_bias = config.use_bias
345
+
346
+ if not is_fast_path_available:
347
+ logger.warning_once(
348
+ "The fast path is not available because on of `(selective_state_update, causal_conv1d_fn, causal_conv1d_update)`"
349
+ " is None. Falling back to the naive implementation. To install follow https://github.com/state-spaces/mamba/#installation and"
350
+ " https://github.com/Dao-AILab/causal-conv1d"
351
+ )
352
+
353
+ def cuda_kernels_forward(
354
+ self,
355
+ hidden_states: torch.Tensor,
356
+ cache_params: Optional[HybridMambaAttentionDynamicCache] = None,
357
+ cache_position: Optional[torch.LongTensor] = None,
358
+ attention_mask: Optional[torch.Tensor] = None,
359
+ ):
360
+ # 1. Gated MLP's linear projection
361
+ hidden_states = apply_mask_to_padding_states(hidden_states, attention_mask)
362
+ projected_states = self.in_proj(hidden_states)
363
+
364
+ # Set up dimensions for reshapes later
365
+ batch_size, seq_len, _ = hidden_states.shape
366
+ groups_time_state_size = self.n_groups * self.ssm_state_size
367
+ d_mlp = (
368
+ projected_states.shape[-1]
369
+ - 2 * self.intermediate_size
370
+ - 2 * self.n_groups * self.ssm_state_size
371
+ - self.num_heads
372
+ ) // 2
373
+
374
+ # Single step calculations via cache
375
+ if cache_params is not None and cache_position is not None and cache_position[0] > 0:
376
+ _, _, gate, hidden_states_B_C, dt = projected_states.squeeze(1).split(
377
+ [d_mlp, d_mlp, self.intermediate_size, self.conv_dim, self.num_heads], dim=-1
378
+ )
379
+
380
+ # 2. Convolution sequence transformation
381
+ hidden_states_B_C = causal_conv1d_update(
382
+ hidden_states_B_C,
383
+ cache_params.conv_states[self.layer_idx],
384
+ self.conv1d.weight.squeeze(1),
385
+ self.conv1d.bias,
386
+ self.activation,
387
+ )
388
+
389
+ hidden_states, B, C = torch.split(
390
+ hidden_states_B_C,
391
+ [self.intermediate_size, groups_time_state_size, groups_time_state_size],
392
+ dim=-1,
393
+ )
394
+
395
+ # 3. SSM transformation
396
+ A = -torch.exp(self.A_log.float()) # (nheads,)
397
+ A = A[:, None, ...][:, :, None].expand(-1, self.head_dim, self.ssm_state_size).to(dtype=torch.float32)
398
+ dt = dt[:, :, None].expand(-1, -1, self.head_dim)
399
+ dt_bias = self.dt_bias[:, None, ...].expand(-1, self.head_dim)
400
+ D = self.D[:, None, ...].expand(-1, self.head_dim)
401
+ B = B.view(batch_size, self.n_groups, B.shape[1] // self.n_groups)
402
+ C = C.view(batch_size, self.n_groups, C.shape[1] // self.n_groups)
403
+ hidden_states_reshaped = hidden_states.view(batch_size, self.num_heads, self.head_dim)
404
+ hidden_states = selective_state_update(
405
+ cache_params.ssm_states[self.layer_idx],
406
+ hidden_states_reshaped,
407
+ dt,
408
+ A,
409
+ B,
410
+ C,
411
+ D,
412
+ z=None,
413
+ dt_bias=dt_bias,
414
+ dt_softplus=True,
415
+ )
416
+ hidden_states = hidden_states.view(batch_size, self.num_heads * self.head_dim)
417
+ hidden_states = self.norm(hidden_states, gate)
418
+
419
+ # 4. Final linear projection
420
+ out = self.out_proj(hidden_states)[:, None, ...]
421
+
422
+ # Fused calculations or step by step if no initialized cache is found
423
+ else:
424
+ A = -torch.exp(self.A_log.float()) # (num_heads) or (intermediate_size, state_size)
425
+ dt_limit_kwargs = {} if self.time_step_limit == (0.0, float("inf")) else {"dt_limit": self.time_step_limit}
426
+
427
+ # 2-4. Fused kernel for conv1d, SSM, and the final projection
428
+ if self.training and cache_params is None:
429
+ out = mamba_split_conv1d_scan_combined(
430
+ projected_states,
431
+ self.conv1d.weight.squeeze(1),
432
+ self.conv1d.bias,
433
+ self.dt_bias,
434
+ A,
435
+ D=self.D,
436
+ chunk_size=self.chunk_size,
437
+ seq_idx=None, # was seq_idx
438
+ activation=self.activation,
439
+ rmsnorm_weight=self.norm.weight,
440
+ rmsnorm_eps=self.norm.variance_epsilon,
441
+ outproj_weight=self.out_proj.weight,
442
+ outproj_bias=self.out_proj.bias,
443
+ headdim=self.head_dim,
444
+ ngroups=self.n_groups,
445
+ norm_before_gate=False,
446
+ return_final_states=False,
447
+ **dt_limit_kwargs,
448
+ )
449
+
450
+ else:
451
+ _, _, gate, hidden_states_B_C, dt = projected_states.split(
452
+ [d_mlp, d_mlp, self.intermediate_size, self.conv_dim, self.num_heads], dim=-1
453
+ )
454
+
455
+ # 2. Convolution sequence transformation
456
+ # Init cache
457
+ if cache_params is not None:
458
+ hidden_states_B_C_transposed = hidden_states_B_C.transpose(1, 2)
459
+ conv_states = nn.functional.pad(
460
+ hidden_states_B_C_transposed,
461
+ (cache_params.conv_kernel_size - hidden_states_B_C_transposed.shape[-1], 0),
462
+ )
463
+ cache_params.update_conv_state(
464
+ layer_idx=self.layer_idx, new_conv_state=conv_states, cache_init=True
465
+ )
466
+
467
+ if self.activation not in ["silu", "swish"]:
468
+ hidden_states_B_C = self.act(
469
+ self.conv1d(hidden_states_B_C.transpose(1, 2))[..., :seq_len].transpose(1, 2)
470
+ )
471
+ else:
472
+ hidden_states_B_C = causal_conv1d_fn(
473
+ x=hidden_states_B_C.transpose(1, 2),
474
+ weight=self.conv1d.weight.squeeze(1),
475
+ bias=self.conv1d.bias,
476
+ activation=self.activation,
477
+ ).transpose(1, 2)
478
+ hidden_states_B_C = apply_mask_to_padding_states(hidden_states_B_C, attention_mask)
479
+ hidden_states, B, C = torch.split(
480
+ hidden_states_B_C,
481
+ [self.intermediate_size, groups_time_state_size, groups_time_state_size],
482
+ dim=-1,
483
+ )
484
+
485
+ # 3. SSM transformation
486
+ scan_output, ssm_state = mamba_chunk_scan_combined(
487
+ hidden_states.view(batch_size, seq_len, -1, self.head_dim),
488
+ dt,
489
+ A,
490
+ B.view(batch_size, seq_len, self.n_groups, -1),
491
+ C.view(batch_size, seq_len, self.n_groups, -1),
492
+ chunk_size=self.chunk_size,
493
+ D=self.D,
494
+ z=None,
495
+ seq_idx=None,
496
+ return_final_states=True,
497
+ dt_bias=self.dt_bias,
498
+ dt_softplus=True,
499
+ **dt_limit_kwargs,
500
+ )
501
+
502
+ # Init cache
503
+ if ssm_state is not None and cache_params is not None:
504
+ cache_params.update_ssm_state(layer_idx=self.layer_idx, new_ssm_state=ssm_state)
505
+
506
+ scan_output = scan_output.view(batch_size, seq_len, -1)
507
+
508
+ # Multiply "gate" branch and apply extra normalization layer
509
+ scan_output = self.norm(scan_output, gate)
510
+
511
+ # 4. Final linear projection
512
+ out = self.out_proj(scan_output)
513
+ return out
514
+
515
+ # fmt: off
516
+ def torch_forward(self, input_states, cache_params: Optional[HybridMambaAttentionDynamicCache]=None, cache_position:Optional[torch.LongTensor]=None, attention_mask: Optional[torch.Tensor]=None):
517
+ batch_size, seq_len, _ = input_states.shape
518
+ dtype = input_states.dtype
519
+
520
+ # 1. Gated MLP's linear projection
521
+ input_states = apply_mask_to_padding_states(input_states, attention_mask)
522
+ projected_states = self.in_proj(input_states)
523
+ d_mlp = (projected_states.shape[-1] - 2 * self.intermediate_size - 2 * self.n_groups * self.ssm_state_size-self.num_heads) // 2
524
+ _, _, gate, hidden_states_B_C, dt = projected_states.split(
525
+ [d_mlp, d_mlp, self.intermediate_size, self.conv_dim, self.num_heads], dim=-1
526
+ )
527
+
528
+ # 2. Convolution sequence transformation
529
+ if cache_params is not None and cache_position is not None and cache_position[0] > 0:
530
+ cache_params.update_conv_state(layer_idx=self.layer_idx, new_conv_state=hidden_states_B_C, cache_init=False)
531
+
532
+ # We need to guarantee that anything regarding the cache is on the same device
533
+ conv_states = cache_params.conv_states[self.layer_idx].to(device=self.conv1d.weight.device)
534
+
535
+ hidden_states_B_C = torch.sum(
536
+ conv_states * self.conv1d.weight.squeeze(1), dim=-1
537
+ )
538
+ if self.use_conv_bias:
539
+ hidden_states_B_C = hidden_states_B_C + self.conv1d.bias
540
+ hidden_states_B_C = self.act(hidden_states_B_C)
541
+ else:
542
+ # Init cache
543
+ if cache_params is not None:
544
+ hidden_states_B_C_transposed = hidden_states_B_C.transpose(1, 2)
545
+ conv_states = nn.functional.pad(
546
+ hidden_states_B_C_transposed, (cache_params.conv_kernel_size - hidden_states_B_C_transposed.shape[-1], 0)
547
+ )
548
+ cache_params.update_conv_state(layer_idx=self.layer_idx, new_conv_state=conv_states, cache_init=True)
549
+
550
+ hidden_states_B_C = self.act(self.conv1d(hidden_states_B_C.transpose(1, 2))[..., :seq_len].transpose(1, 2))
551
+
552
+ hidden_states_B_C = apply_mask_to_padding_states(hidden_states_B_C, attention_mask)
553
+ hidden_states, B, C = torch.split(
554
+ hidden_states_B_C,
555
+ [self.intermediate_size, self.n_groups * self.ssm_state_size, self.n_groups * self.ssm_state_size],
556
+ dim=-1
557
+ )
558
+
559
+ # 3. SSM transformation
560
+ A = -torch.exp(self.A_log.float()) # [num_heads]
561
+ if cache_params is not None and cache_position is not None and cache_position[0] > 0:
562
+ # We need to guarantee that anything regarding the cache is on the same device
563
+ cache_device = cache_params.ssm_states.device
564
+
565
+ # Note: there is no need to pad parameter matrices here, as there is just one new token
566
+ # for batched generation
567
+ dt = dt[:, 0, :][:, None, ...]
568
+ dt = dt.transpose(1, 2).expand(batch_size, dt.shape[-1], self.head_dim)
569
+ # [num_heads] -> [num_heads, head_dim]
570
+ dt_bias = self.dt_bias[..., None].expand(self.dt_bias.shape[0], self.head_dim)
571
+
572
+ dt = torch.nn.functional.softplus(dt + dt_bias.to(dt.dtype))
573
+ dt = torch.clamp(dt, self.time_step_limit[0], self.time_step_limit[1])
574
+ A = A[..., None, None].expand(self.num_heads, self.head_dim, self.ssm_state_size).to(dtype=torch.float32)
575
+ # [bsz, num_heads, head_dim, state_size]
576
+ dA = (torch.exp(dt[..., None] * A)).to(device=cache_device)
577
+
578
+ # Discretize B
579
+ # [bsz, n_groups * state_size] -> [bsz, n_groups, 1, state_size] ->
580
+ # -> [bsz, n_groups, group to head repetition factor, state_size] -> [bsz, num_heads, state_size]
581
+ B = B.reshape(batch_size, self.n_groups, -1)[..., None, :]
582
+ B = B.expand(batch_size, self.n_groups, self.num_heads // self.n_groups, B.shape[-1]).contiguous()
583
+ B = B.reshape(batch_size, -1, B.shape[-1])
584
+ # [bsz, num_heads, head_dim, state_size]
585
+ dB = dt[..., None] * B[..., None, :]
586
+
587
+ # Discretize x into dB
588
+ # [bsz, intermediate_size] -> [bsz, num_heads, head_dim]
589
+ hidden_states = hidden_states.reshape(batch_size, -1, self.head_dim)
590
+ dBx = (dB * hidden_states[..., None]).to(device=cache_device)
591
+
592
+ # State calculation
593
+ cache_params.update_ssm_state(
594
+ layer_idx=self.layer_idx,
595
+ new_ssm_state=cache_params.ssm_states[self.layer_idx] * dA + dBx
596
+ )
597
+
598
+ # Subsequent output
599
+ # [bsz, n_groups * state_size] -> [bsz, num_heads, state_size]
600
+ C = C.reshape(batch_size, self.n_groups, -1)[..., None, :]
601
+ C = C.expand(batch_size, self.n_groups, self.num_heads // self.n_groups, C.shape[-1]).contiguous()
602
+ C = C.reshape(batch_size, -1, C.shape[-1])
603
+ # [bsz, num_heads, head_dim]
604
+
605
+ ssm_states = cache_params.ssm_states[self.layer_idx].to(device=C.device, dtype=C.dtype) # Shape: [b, h, d, n]
606
+ # Reshape ssm_states to merge the first two dimensions
607
+ ssm_states_reshaped = ssm_states.view(batch_size * self.num_heads, self.head_dim, self.ssm_state_size) # Shape: [b*h, d, n]
608
+ C_reshaped = C.view(batch_size * self.num_heads, self.ssm_state_size, 1) # Shape: [b*h, n, 1]
609
+ y = torch.bmm(ssm_states_reshaped, C_reshaped)
610
+ y = y.view(batch_size, self.num_heads, self.head_dim)
611
+
612
+ # D skip connection
613
+ # [num_heads] -> [num_heads, head_dim]
614
+ D = self.D[..., None].expand(self.D.shape[0], self.head_dim)
615
+ y = (y + hidden_states * D).to(y.dtype)
616
+
617
+ # [bsz, num_heads, head_dim] -> [bsz, 1, intermediate_size]
618
+ y = y.reshape(batch_size, -1)[:, None, ...]
619
+ else:
620
+ # begin ssd naive implementation without einsums
621
+ dt = nn.functional.softplus(dt + self.dt_bias)
622
+ dt = torch.clamp(dt, self.time_step_limit[0], self.time_step_limit[1])
623
+ hidden_states = hidden_states.reshape(batch_size, seq_len, -1, self.head_dim).float()
624
+ B = B.reshape(batch_size, seq_len, -1, self.ssm_state_size).float()
625
+ C = C.reshape(batch_size, seq_len, -1, self.ssm_state_size).float()
626
+ B = B.repeat(1, 1, self.num_heads // self.n_groups, 1)
627
+ C = C.repeat(1, 1, self.num_heads // self.n_groups, 1)
628
+ pad_size = (self.chunk_size - seq_len % self.chunk_size) % self.chunk_size
629
+
630
+ D_residual = self.D[..., None] * pad_tensor_by_size(hidden_states, pad_size)
631
+
632
+ # Discretize x and A
633
+ hidden_states = hidden_states * dt[..., None]
634
+ A = A.to(hidden_states.dtype) * dt
635
+
636
+ # Rearrange into blocks/chunks
637
+ hidden_states, A, B, C = [reshape_into_chunks(t, pad_size, self.chunk_size) for t in (hidden_states, A, B, C)]
638
+
639
+ # [bsz, -1, chunk_size, num_heads] -> [bsz, num_heads, -1, chunk_size]
640
+ A = A.permute(0, 3, 1, 2)
641
+ A_cumsum = torch.cumsum(A, dim=-1)
642
+
643
+ # 1. Compute the output for each intra-chunk (diagonal blocks)
644
+ # This is the analog of a causal mask
645
+ L = torch.exp(segment_sum(A))
646
+
647
+ # Contraction of C and B to get G (attention-weights like)
648
+ G_intermediate = C[:, :, :, None, :, :] * B[:, :, None, :, :, :] # shape: (b, c, l, s, h, n)
649
+ G = G_intermediate.sum(dim=-1) # shape: (b, c, l, s, h)
650
+
651
+ # Compute M, equivalent to applying attention mask to weights
652
+ M_intermediate = G[..., None] * L.permute(0, 2, 3, 4, 1)[..., None]
653
+ M = M_intermediate.sum(dim=-1)
654
+
655
+ # Compute Y_diag (apply to values)
656
+ Y_diag = (M[..., None] * hidden_states[:, :, None]).sum(dim=3)
657
+
658
+ # 2. Compute the state for each intra-chunk
659
+ # (right term of low-rank factorization of off-diagonal blocks; B terms)
660
+ decay_states = torch.exp((A_cumsum[:, :, :, -1:] - A_cumsum))
661
+ B_decay = B * decay_states.permute(0, -2, -1, 1)[..., None]
662
+ states = (B_decay[..., None, :] * hidden_states[..., None]).sum(dim=2)
663
+
664
+ # 3. Compute the inter-chunk SSM recurrence; produces correct SSM states at chunk boundaries
665
+ # (middle term of factorization of off-diag blocks; A terms)
666
+ if cache_params is not None and cache_position is not None and cache_position[0] > 0:
667
+ previous_states = cache_params.ssm_states[self.layer_idx][:, None, ...].to(device=states.device)
668
+ else:
669
+ previous_states = torch.zeros_like(states[:, :1])
670
+ states = torch.cat([previous_states, states], dim=1)
671
+ decay_chunk = torch.exp(segment_sum(nn.functional.pad(A_cumsum[:, :, :, -1], (1, 0))))
672
+ decay_chunk = decay_chunk.transpose(1, 3)
673
+ new_states = (decay_chunk[..., None, None] * states[:, :, None, ...]).sum(dim=1)
674
+ states, ssm_state = new_states[:, :-1], new_states[:, -1]
675
+
676
+ # 4. Compute state -> output conversion per chunk
677
+ # (left term of low-rank factorization of off-diagonal blocks; C terms)
678
+ state_decay_out = torch.exp(A_cumsum)
679
+ C_times_states = (C[..., None, :] * states[:, :, None, ...])
680
+ state_decay_out_permuted = state_decay_out.permute(0, 2, 3, 1)
681
+ Y_off = (C_times_states.sum(-1) * state_decay_out_permuted[..., None])
682
+
683
+ # Add output of intra-chunk and inter-chunk terms (diagonal and off-diagonal blocks)
684
+ y = Y_diag + Y_off
685
+ # [bsz, -1, self.chunk_size, num_heads, head_dim] -> [bsz, (padded) seq_len, num_heads, head_dim]
686
+ y = y.reshape(batch_size, -1, self.num_heads, self.head_dim)
687
+
688
+ y = y + D_residual
689
+ # Cutting off padded chunks
690
+ if pad_size > 0:
691
+ y = y[:, :seq_len, :, :]
692
+ y = y.reshape(batch_size, seq_len, -1)
693
+
694
+ # Init cache
695
+ if ssm_state is not None and cache_params is not None:
696
+ cache_params.update_ssm_state(layer_idx=self.layer_idx, new_ssm_state=ssm_state)
697
+
698
+ scan_output = self.norm(y, gate)
699
+
700
+ # end ssd naive
701
+
702
+ # 4. Final linear projection
703
+ contextualized_states = self.out_proj(scan_output.to(dtype)) # [batch, seq_len, hidden_size]
704
+ return contextualized_states
705
+ # fmt: on
706
+
707
+ def forward(
708
+ self,
709
+ hidden_states,
710
+ cache_params: Optional[HybridMambaAttentionDynamicCache] = None,
711
+ cache_position: Optional[torch.LongTensor] = None,
712
+ attention_mask: Optional[torch.Tensor] = None,
713
+ ):
714
+ if is_fast_path_available and "cuda" in self.in_proj.weight.device.type:
715
+ return self.cuda_kernels_forward(hidden_states, cache_params, cache_position, attention_mask)
716
+ dtype = hidden_states.dtype
717
+ if attention_mask is not None and attention_mask.shape[1] > 1 and attention_mask.shape[0] > 1:
718
+ # tune out hidden states for pad tokens, see https://github.com/state-spaces/mamba/issues/66
719
+ hidden_states = (hidden_states * attention_mask[:, :, None]).to(dtype)
720
+
721
+ return self.torch_forward(hidden_states, cache_params, cache_position, attention_mask)
722
+
723
+
724
+ class NemotronHRMSNorm(nn.Module):
725
+ def __init__(self, hidden_size, eps=1e-6):
726
+ """
727
+ NemotronHRMSNorm is equivalent to T5LayerNorm and LlamaRMSNorm
728
+ """
729
+ super().__init__()
730
+ self.weight = nn.Parameter(torch.ones(hidden_size))
731
+ self.variance_epsilon = eps
732
+
733
+ def forward(self, hidden_states):
734
+ input_dtype = hidden_states.dtype
735
+ hidden_states = hidden_states.to(torch.float32)
736
+ variance = hidden_states.pow(2).mean(-1, keepdim=True)
737
+ hidden_states = hidden_states * torch.rsqrt(variance + self.variance_epsilon)
738
+ # Weights are in float32
739
+ return (self.weight.to(torch.float32) * hidden_states).to(input_dtype)
740
+
741
+ class NemotronHBlock(nn.Module):
742
+ def __init__(self, config, layer_idx):
743
+ super().__init__()
744
+ self.config = config
745
+ self.layer_idx = layer_idx
746
+ self.residual_in_fp32 = config.residual_in_fp32
747
+ self.norm = NemotronHRMSNorm(config.hidden_size, eps=config.layer_norm_epsilon)
748
+
749
+ # M: Mamba2, *: Attention, -: MLP
750
+ self.block_type = config.layers_block_type[layer_idx]
751
+ if self.block_type == "mamba":
752
+ self.mixer = NemotronHMamba2Mixer(config, layer_idx=layer_idx)
753
+ elif self.block_type == "attention":
754
+ self.mixer = NEMOTRONH_ATTENTION_CLASSES[config._attn_implementation](config, layer_idx=layer_idx)
755
+ elif self.block_type == "mlp":
756
+ self.mixer = NemotronHMLP(config, layer_idx=layer_idx)
757
+ else:
758
+ raise ValueError(f"Invalid layer pattern {config.hybrid_override_pattern[layer_idx]}")
759
+
760
+ def forward(
761
+ self,
762
+ hidden_states,
763
+ cache_params: Optional[HybridMambaAttentionDynamicCache] = None,
764
+ cache_position: Optional[torch.LongTensor] = None,
765
+ attention_mask: Optional[torch.Tensor] = None,
766
+ ):
767
+ with torch.cuda.stream(torch.cuda.default_stream(hidden_states.device)):
768
+ # * Use torch.cuda.stream() to avoid NaN issues when using multiple GPUs
769
+ residual = hidden_states
770
+ hidden_states = self.norm(hidden_states.to(dtype=self.norm.weight.dtype))
771
+ if self.residual_in_fp32:
772
+ residual = residual.to(torch.float32)
773
+
774
+ if self.block_type == "mamba":
775
+ hidden_states = self.mixer(
776
+ hidden_states, cache_params=cache_params, cache_position=cache_position
777
+ )
778
+ elif self.block_type == "attention":
779
+ hidden_states = self.mixer(
780
+ hidden_states, cache_position=cache_position
781
+ )
782
+ hidden_states = hidden_states[0]
783
+ elif self.block_type == "mlp":
784
+ hidden_states = self.mixer(
785
+ hidden_states
786
+ )
787
+ else:
788
+ raise ValueError(f"Invalid block_type: {self.block_type}")
789
+
790
+ hidden_states = residual + hidden_states
791
+ return hidden_states
792
+
793
+
794
+ # Copied from transformers.models.nemotron.modeling_nemotron Nemotron->NemotronH
795
+ class NemotronHMLP(nn.Module):
796
+ def __init__(self, config, layer_idx: Optional[int] = None):
797
+ super().__init__()
798
+ self.config = config
799
+ self.layer_idx = layer_idx
800
+ if layer_idx is None:
801
+ logger.warning_once(
802
+ f"Instantiating {self.__class__.__name__} without passing a `layer_idx` is not recommended and will "
803
+ "lead to errors during the forward call if caching is used. Please make sure to provide a `layer_idx` "
804
+ "when creating this class."
805
+ )
806
+ self.hidden_size = config.hidden_size
807
+ #intermediate_size = config.expand * config.hidden_size
808
+ self.intermediate_size = config.intermediate_size
809
+ self.up_proj = nn.Linear(self.hidden_size, self.intermediate_size, bias=config.mlp_bias)
810
+ self.down_proj = nn.Linear(self.intermediate_size, self.hidden_size, bias=config.mlp_bias)
811
+ self.act_fn = ACT2FN[config.mlp_hidden_act]
812
+
813
+ def forward(self, x):
814
+ return self.down_proj(self.act_fn(self.up_proj(x)))
815
+
816
+
817
+ # Copied from transformers.models.llama.modeling_llama.repeat_kv
818
+ def repeat_kv(hidden_states: torch.Tensor, n_rep: int) -> torch.Tensor:
819
+ """
820
+ This is the equivalent of torch.repeat_interleave(x, dim=1, repeats=n_rep). The hidden states go from (batch,
821
+ num_key_value_heads, seqlen, head_dim) to (batch, num_attention_heads, seqlen, head_dim)
822
+ """
823
+ batch, num_key_value_heads, slen, head_dim = hidden_states.shape
824
+ if n_rep == 1:
825
+ return hidden_states
826
+ hidden_states = hidden_states[:, :, None, :, :].expand(batch, num_key_value_heads, n_rep, slen, head_dim)
827
+ return hidden_states.reshape(batch, num_key_value_heads * n_rep, slen, head_dim)
828
+
829
+
830
+ class NemotronHAttention(nn.Module):
831
+ """Multi-headed attention from 'Attention Is All You Need' paper"""
832
+
833
+ def __init__(self, config: NemotronHConfig, layer_idx: Optional[int] = None):
834
+ super().__init__()
835
+ self.config = config
836
+ self.layer_idx = layer_idx
837
+ if layer_idx is None:
838
+ logger.warning_once(
839
+ f"Instantiating {self.__class__.__name__} without passing a `layer_idx` is not recommended and will "
840
+ "lead to errors during the forward call if caching is used. Please make sure to provide a `layer_idx` "
841
+ "when creating this class."
842
+ )
843
+
844
+ self.attention_dropout = config.attention_dropout
845
+ self.hidden_size = config.hidden_size
846
+ self.num_heads = config.num_attention_heads
847
+ if config.head_dim is not None:
848
+ self.head_dim = config.head_dim
849
+ else:
850
+ self.head_dim = config.hidden_size // config.num_attention_heads
851
+ self.num_key_value_heads = config.num_key_value_heads
852
+ self.num_key_value_groups = self.num_heads // self.num_key_value_heads
853
+ self.max_position_embeddings = config.max_position_embeddings
854
+ self.is_causal = True
855
+
856
+ self.q_proj = nn.Linear(self.hidden_size, self.num_heads * self.head_dim, bias=config.attention_bias)
857
+ self.k_proj = nn.Linear(self.hidden_size, self.num_key_value_heads * self.head_dim, bias=config.attention_bias)
858
+ self.v_proj = nn.Linear(self.hidden_size, self.num_key_value_heads * self.head_dim, bias=config.attention_bias)
859
+ self.o_proj = nn.Linear(self.head_dim * self.num_heads, self.hidden_size, bias=config.attention_bias)
860
+
861
+ def forward(
862
+ self,
863
+ hidden_states: torch.Tensor,
864
+ # position_embeddings: Tuple[torch.Tensor, torch.Tensor], #TODO
865
+ attention_mask: Optional[torch.Tensor] = None,
866
+ position_ids: Optional[torch.LongTensor] = None,
867
+ past_key_value: Optional[HybridMambaAttentionDynamicCache] = None,
868
+ output_attentions: bool = False,
869
+ use_cache: bool = False,
870
+ cache_position: Optional[torch.LongTensor] = None,
871
+ ) -> Tuple[torch.Tensor, Optional[torch.Tensor], Optional[Tuple[torch.Tensor]]]:
872
+ bsz, q_len, _ = hidden_states.size()
873
+
874
+ query_states = self.q_proj(hidden_states)
875
+ key_states = self.k_proj(hidden_states)
876
+ value_states = self.v_proj(hidden_states)
877
+
878
+ query_states = query_states.view(bsz, q_len, self.num_heads, self.head_dim).transpose(1, 2)
879
+ key_states = key_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
880
+ value_states = value_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
881
+
882
+ if past_key_value is not None:
883
+ key_states, value_states = past_key_value.update(key_states, value_states, self.layer_idx)
884
+
885
+ key_states = repeat_kv(key_states, self.num_key_value_groups)
886
+ value_states = repeat_kv(value_states, self.num_key_value_groups)
887
+
888
+ causal_mask = attention_mask
889
+ if attention_mask is not None: # no matter the length, we just slice it
890
+ causal_mask = attention_mask[:, :, :, : key_states.shape[-2]]
891
+
892
+ if query_states.device.type == "cuda" and attention_mask is not None:
893
+ query_states = query_states.contiguous()
894
+ key_states = key_states.contiguous()
895
+ value_states = value_states.contiguous()
896
+
897
+ is_causal = True if causal_mask is None and q_len > 1 else False
898
+
899
+ attn_output = torch.nn.functional.scaled_dot_product_attention(
900
+ query_states,
901
+ key_states,
902
+ value_states,
903
+ attn_mask=causal_mask,
904
+ dropout_p=self.attention_dropout if self.training else 0.0,
905
+ is_causal=is_causal,
906
+ )
907
+ attn_output = attn_output.transpose(1, 2).contiguous()
908
+ #attn_output = attn_output.view(bsz, q_len, self.hidden_size)
909
+ attn_output = attn_output.view(bsz, q_len, self.num_heads * self.head_dim)
910
+
911
+ attn_output = self.o_proj(attn_output)
912
+
913
+ return attn_output, None, past_key_value
914
+
915
+
916
+ # Adapted from transformers.models.mistral.modeling_mistral.MistralFlashAttention2 with Mistral->Jamba
917
+ #class JambaFlashAttention2(JambaAttention):
918
+ class NemotronHFlashAttention2(NemotronHAttention):
919
+ """
920
+ Jamba flash attention module. This module inherits from `JambaAttention` as the weights of the module stays
921
+ untouched. The only required change would be on the forward pass where it needs to correctly call the public API of
922
+ flash attention and deal with padding tokens in case the input contains any of them.
923
+ """
924
+ def __init__(self, *args, **kwargs):
925
+ super().__init__(*args, **kwargs)
926
+
927
+ # TODO: Should be removed once Flash Attention for RoCm is bumped to 2.1.
928
+ # flash_attn<2.1 generates top-left aligned causal mask, while what is needed here is bottom-right alignement, that was made default for flash_attn>=2.1. This attribute is used to handle this difference. Reference: https://github.com/Dao-AILab/flash-attention/releases/tag/v2.1.0.
929
+ # Beware that with flash_attn<2.1, using q_seqlen != k_seqlen (except for the case q_seqlen == 1) produces a wrong mask (top-left).
930
+ self._flash_attn_uses_top_left_mask = not is_flash_attn_greater_or_equal_2_10()
931
+
932
+ def forward(
933
+ self,
934
+ hidden_states: torch.Tensor,
935
+ attention_mask: Optional[torch.Tensor] = None,
936
+ position_ids: Optional[torch.LongTensor] = None,
937
+ past_key_value: Optional[HybridMambaAttentionDynamicCache] = None,
938
+ output_attentions: bool = False,
939
+ use_cache: bool = False,
940
+ cache_position: Optional[torch.LongTensor] = None,
941
+ **kwargs,
942
+ ):
943
+ bsz, q_len, _ = hidden_states.size()
944
+
945
+ query_states = self.q_proj(hidden_states)
946
+ key_states = self.k_proj(hidden_states)
947
+ value_states = self.v_proj(hidden_states)
948
+
949
+ # Flash attention requires the input to have the shape
950
+ # batch_size x seq_length x head_dim x hidden_dim
951
+ # therefore we just need to keep the original shape
952
+ query_states = query_states.view(bsz, q_len, self.num_heads, self.head_dim)
953
+ key_states = key_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
954
+ value_states = value_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
955
+
956
+ if past_key_value is not None:
957
+ key_states, value_states = past_key_value.update(key_states, value_states, self.layer_idx)
958
+
959
+ # repeat k/v heads if n_kv_heads < n_heads
960
+ key_states = repeat_kv(key_states, self.num_key_value_groups)
961
+ value_states = repeat_kv(value_states, self.num_key_value_groups)
962
+ dropout_rate = 0.0 if not self.training else self.attention_dropout
963
+
964
+ # In PEFT, usually we cast the layer norms in float32 for training stability reasons
965
+ # therefore the input hidden states gets silently casted in float32. Hence, we need
966
+ # cast them back in float16 just to be sure everything works as expected.
967
+ input_dtype = query_states.dtype
968
+ if input_dtype == torch.float32:
969
+ if torch.is_autocast_enabled():
970
+ target_dtype = torch.get_autocast_gpu_dtype()
971
+ # Handle the case where the model is quantized
972
+ elif hasattr(self.config, "_pre_quantization_dtype"):
973
+ target_dtype = self.config._pre_quantization_dtype
974
+ else:
975
+ target_dtype = self.q_proj.weight.dtype
976
+
977
+ logger.warning_once(
978
+ f"The input hidden states seems to be silently casted in float32, this might be related to"
979
+ f" the fact you have upcasted embedding or layer norm layers in float32. We will cast back the input in"
980
+ f" {target_dtype}."
981
+ )
982
+
983
+ query_states = query_states.to(target_dtype)
984
+ key_states = key_states.to(target_dtype)
985
+ value_states = value_states.to(target_dtype)
986
+
987
+ # Reashape to the expected shape for Flash Attention
988
+ key_states = key_states.transpose(1, 2)
989
+ value_states = value_states.transpose(1, 2)
990
+
991
+ attn_output = _flash_attention_forward(
992
+ query_states,
993
+ key_states,
994
+ value_states,
995
+ attention_mask,
996
+ q_len,
997
+ dropout=dropout_rate,
998
+ sliding_window=getattr(self.config, "sliding_window", None),
999
+ is_causal=self.is_causal,
1000
+ use_top_left_mask=self._flash_attn_uses_top_left_mask,
1001
+ )
1002
+
1003
+ #attn_output = attn_output.reshape(bsz, q_len, self.hidden_size).contiguous()
1004
+ attn_output = attn_output.reshape(bsz, q_len, self.num_heads * self.head_dim).contiguous()
1005
+ attn_output = self.o_proj(attn_output)
1006
+
1007
+ if not output_attentions:
1008
+ attn_weights = None
1009
+
1010
+ return attn_output, attn_weights, past_key_value
1011
+
1012
+
1013
+ # Adapted from transformers.models.mistral.modeling_mistral.MistralSdpaAttention with Mistral->Jamba
1014
+ #class JambaSdpaAttention(JambaAttention):
1015
+ class NemotronHSdpaAttention(NemotronHAttention):
1016
+ """
1017
+ Jamba attention module using torch.nn.functional.scaled_dot_product_attention. This module inherits from
1018
+ `JambaAttention` as the weights of the module stays untouched. The only changes are on the forward pass to adapt to
1019
+ SDPA API.
1020
+ """
1021
+
1022
+ # Adapted from NemotronHAttention.forward
1023
+ def forward(
1024
+ self,
1025
+ hidden_states: torch.Tensor,
1026
+ attention_mask: Optional[torch.Tensor] = None,
1027
+ position_ids: Optional[torch.LongTensor] = None,
1028
+ past_key_value: Optional[HybridMambaAttentionDynamicCache] = None,
1029
+ output_attentions: bool = False,
1030
+ use_cache: bool = False,
1031
+ cache_position: Optional[torch.LongTensor] = None,
1032
+ ) -> Tuple[torch.Tensor, Optional[torch.Tensor], Optional[Tuple[torch.Tensor]]]:
1033
+ if output_attentions:
1034
+ # TODO: Improve this warning with e.g. `model.config.attn_implementation = "manual"` once this is implemented.
1035
+ logger.warning_once(
1036
+ "NemotronHModel is using NemotronHSdpaAttention, but `torch.nn.functional.scaled_dot_product_attention` does not support `output_attentions=True`. Falling back to the manual attention implementation, "
1037
+ 'but specifying the manual implementation will be required from Transformers version v5.0.0 onwards. This warning can be removed using the argument `attn_implementation="eager"` when loading the model.'
1038
+ )
1039
+ return super().forward(
1040
+ hidden_states=hidden_states,
1041
+ attention_mask=attention_mask,
1042
+ position_ids=position_ids,
1043
+ past_key_value=past_key_value,
1044
+ output_attentions=output_attentions,
1045
+ use_cache=use_cache,
1046
+ )
1047
+
1048
+ bsz, q_len, _ = hidden_states.size()
1049
+
1050
+ query_states = self.q_proj(hidden_states)
1051
+ key_states = self.k_proj(hidden_states)
1052
+ value_states = self.v_proj(hidden_states)
1053
+
1054
+ query_states = query_states.view(bsz, q_len, self.num_heads, self.head_dim).transpose(1, 2)
1055
+ key_states = key_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
1056
+ value_states = value_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
1057
+
1058
+ if past_key_value is not None:
1059
+ key_states, value_states = past_key_value.update(key_states, value_states, self.layer_idx)
1060
+
1061
+ key_states = repeat_kv(key_states, self.num_key_value_groups)
1062
+ value_states = repeat_kv(value_states, self.num_key_value_groups)
1063
+
1064
+ causal_mask = attention_mask
1065
+ if attention_mask is not None:
1066
+ causal_mask = causal_mask[:, :, :, : key_states.shape[-2]]
1067
+
1068
+ # SDPA with memory-efficient backend is currently (torch==2.1.2) bugged with non-contiguous inputs with custom attn_mask,
1069
+ # Reference: https://github.com/pytorch/pytorch/issues/112577.
1070
+ if query_states.device.type == "cuda" and attention_mask is not None:
1071
+ query_states = query_states.contiguous()
1072
+ key_states = key_states.contiguous()
1073
+ value_states = value_states.contiguous()
1074
+
1075
+ # We dispatch to SDPA's Flash Attention or Efficient kernels via this `is_causal` if statement instead of an inline conditional assignment
1076
+ # in SDPA to support both torch.compile's dynamic shapes and full graph options. An inline conditional prevents dynamic shapes from compiling.
1077
+ # The q_len > 1 is necessary to match with AttentionMaskConverter.to_causal_4d that does not create a causal mask in case q_len == 1.
1078
+ is_causal = True if self.is_causal and causal_mask is None and q_len > 1 else False
1079
+
1080
+ attn_output = torch.nn.functional.scaled_dot_product_attention(
1081
+ query_states,
1082
+ key_states,
1083
+ value_states,
1084
+ attn_mask=causal_mask,
1085
+ dropout_p=self.attention_dropout if self.training else 0.0,
1086
+ is_causal=is_causal,
1087
+ )
1088
+
1089
+ attn_output = attn_output.transpose(1, 2).contiguous()
1090
+ attn_output = attn_output.view(bsz, q_len, self.hidden_size)
1091
+
1092
+ attn_output = self.o_proj(attn_output)
1093
+
1094
+ return attn_output, None, past_key_value
1095
+
1096
+
1097
+ NEMOTRONH_ATTENTION_CLASSES = {
1098
+ "eager": NemotronHAttention,
1099
+ "flash_attention_2": NemotronHFlashAttention2,
1100
+ "sdpa": NemotronHSdpaAttention,
1101
+ }
1102
+
1103
+ # Copied from transformers.models.mamba.modeling_mamba2.Mamba2PreTrainedModel
1104
+ class NemotronHPreTrainedModel(PreTrainedModel):
1105
+ """
1106
+ An abstract class to handle weights initialization and a simple interface for downloading and loading pretrained
1107
+ models.
1108
+ """
1109
+
1110
+ config_class = NemotronHConfig
1111
+ base_model_prefix = "backbone"
1112
+ _no_split_modules = ["NemotronHBlock"]
1113
+ supports_gradient_checkpointing = True
1114
+ _is_stateful = True
1115
+
1116
+ def _init_weights(self, module):
1117
+ """Initialize the weights."""
1118
+ if isinstance(module, NemotronHMamba2Mixer):
1119
+ module.A_log._no_weight_decay = True
1120
+ module.D._no_weight_decay = True
1121
+
1122
+ dt = torch.exp(
1123
+ torch.rand(self.config.mamba_num_heads)
1124
+ * (math.log(self.config.time_step_max) - math.log(self.config.time_step_min))
1125
+ + math.log(self.config.time_step_min)
1126
+ ).clamp(min=self.config.time_step_floor)
1127
+
1128
+ # # Inverse of softplus: https://github.com/pytorch/pytorch/issues/72759
1129
+ inv_dt = dt + torch.log(-torch.expm1(-dt))
1130
+ with torch.no_grad():
1131
+ module.dt_bias.copy_(inv_dt)
1132
+ module.dt_bias._no_reinit = True
1133
+
1134
+ if isinstance(module, nn.Linear):
1135
+ if module.bias is not None:
1136
+ if not getattr(module.bias, "_no_reinit", False):
1137
+ nn.init.zeros_(module.bias)
1138
+ elif isinstance(module, nn.Embedding):
1139
+ nn.init.normal_(module.weight, std=self.config.initializer_range)
1140
+
1141
+ # TODO: Check
1142
+ if self.config.rescale_prenorm_residual:
1143
+ # Reinitialize selected weights subject to the OpenAI GPT-2 Paper Scheme:
1144
+ # > A modified initialization which accounts for the accumulation on the residual path with model depth. Scale
1145
+ # > the weights of residual layers at initialization by a factor of 1/√N where N is the # of residual layers.
1146
+ # > -- GPT-2 :: https://openai.com/blog/better-language-models/
1147
+ #
1148
+ # Reference (Megatron-LM): https://github.com/NVIDIA/Megatron-LM/blob/main/megatron/model/gpt_model.py
1149
+ for name, p in module.named_parameters():
1150
+ if name in ["out_proj.weight"]:
1151
+ # Special Scaled Initialization --> There are 2 Layer Norms per Transformer Block
1152
+ # Following Pytorch init, except scale by 1/sqrt(2 * n_layer)
1153
+ # We need to reinit p since this code could be called multiple times
1154
+ # Having just p *= scale would repeatedly scale it down
1155
+ nn.init.kaiming_uniform_(p, a=math.sqrt(5))
1156
+ with torch.no_grad():
1157
+ p /= math.sqrt(self.config.num_hidden_layers)
1158
+
1159
+
1160
+ @dataclass
1161
+ # Copied from transformers.models.mamba.modeling_mamba2.Mamba2Output with MAMBA2->NemotronH,Mamba2->NemotronH
1162
+ class NemotronHOutput(ModelOutput):
1163
+ """
1164
+ Class for the NemotronH model outputs.
1165
+
1166
+ Args:
1167
+ last_hidden_state (`torch.FloatTensor` of shape `(batch_size, sequence_length, hidden_size)`):
1168
+ Sequence of hidden-states at the output of the last layer of the model.
1169
+ cache_params (`HybridMambaAttentionDynamicCache`):
1170
+ The state of the model at the last time step. Can be used in a forward method with the next `input_ids` to
1171
+ avoid providing the old `input_ids`.
1172
+
1173
+ Includes both the State space model state matrices after the selective scan, and the Convolutional states
1174
+ hidden_states (`tuple(torch.FloatTensor)`, *optional*, returned when `output_hidden_states=True` is passed or when `config.output_hidden_states=True`):
1175
+ Tuple of `torch.FloatTensor` (one for the output of the embeddings, if the model has an embedding layer, +
1176
+ one for the output of each layer) of shape `(batch_size, sequence_length, hidden_size)`.
1177
+
1178
+ Hidden-states of the model at the output of each layer plus the optional initial embedding outputs.
1179
+ """
1180
+
1181
+ last_hidden_state: Optional[torch.FloatTensor] = None
1182
+ cache_params: Optional[HybridMambaAttentionDynamicCache] = None
1183
+ hidden_states: Optional[Tuple[torch.FloatTensor]] = None
1184
+ attentions: Optional[Tuple[torch.FloatTensor]] = None
1185
+
1186
+
1187
+ @dataclass
1188
+ # Copied from transformers.models.mamba2.modeling_mamba2.MambaCausalLMOutput with Mamba2->NemotronH
1189
+ class NemotronHCausalLMOutput(ModelOutput):
1190
+ """
1191
+ Base class for causal language model (or autoregressive) outputs.
1192
+
1193
+ Args:
1194
+ loss (`torch.FloatTensor` of shape `(1,)`, *optional*, returned when `labels` is provided):
1195
+ Language modeling loss (for next-token prediction).
1196
+ logits (`torch.FloatTensor` of shape `(batch_size, sequence_length, config.vocab_size)`):
1197
+ Prediction scores of the language modeling head (scores for each vocabulary token before SoftMax).
1198
+ cache_params (`HybridMambaAttentionDynamicCache`):
1199
+ The state of the model at the last time step. Can be used in a forward method with the next `input_ids` to
1200
+ avoid providing the old `input_ids`.
1201
+
1202
+ Includes both the State space model state matrices after the selective scan, and the Convolutional states
1203
+ hidden_states (`tuple(torch.FloatTensor)`, *optional*, returned when `output_hidden_states=True` is passed or when `config.output_hidden_states=True`):
1204
+ Tuple of `torch.FloatTensor` (one for the output of the embeddings, if the model has an embedding layer, +
1205
+ one for the output of each layer) of shape `(batch_size, sequence_length, hidden_size)`.
1206
+
1207
+ Hidden-states of the model at the output of each layer plus the optional initial embedding outputs.
1208
+ """
1209
+
1210
+ loss: Optional[torch.FloatTensor] = None
1211
+ logits: Optional[torch.FloatTensor] = None
1212
+ cache_params: Optional[HybridMambaAttentionDynamicCache] = None
1213
+ hidden_states: Optional[Tuple[torch.FloatTensor]] = None
1214
+ attentions: Optional[Tuple[torch.FloatTensor]] = None
1215
+
1216
+
1217
+ NEMOTRONH_START_DOCSTRING = r"""
1218
+
1219
+ This model inherits from [`PreTrainedModel`]. Check the superclass documentation for the generic methods the
1220
+ library implements for all its model (such as downloading or saving, resizing the input embeddings, pruning heads
1221
+ etc.)
1222
+
1223
+ This model is also a PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) subclass.
1224
+ Use it as a regular PyTorch Module and refer to the PyTorch documentation for all matter related to general usage
1225
+ and behavior.
1226
+
1227
+ Parameters:
1228
+ config ([`NemotronHConfig`]): Model configuration class with all the parameters of the model.
1229
+ Initializing with a config file does not load the weights associated with the model, only the
1230
+ configuration. Check out the [`~PreTrainedModel.from_pretrained`] method to load the model weights.
1231
+ """
1232
+
1233
+ NEMOTRONH_INPUTS_DOCSTRING = r"""
1234
+ Args:
1235
+ input_ids (`torch.LongTensor` of shape `(batch_size, input_ids_length)`, *optional*):
1236
+ Indices of input sequence tokens in the vocabulary.
1237
+
1238
+ If `cache_params.seqlen_offset>0`, only `input_ids` that do not have their past calculated should be passed as
1239
+ `input_ids`.
1240
+
1241
+ Indices can be obtained using [`AutoTokenizer`]. See [`PreTrainedTokenizer.encode`] and
1242
+ [`PreTrainedTokenizer.__call__`] for details.
1243
+
1244
+ [What are input IDs?](../glossary#input-ids)
1245
+ inputs_embeds (`torch.FloatTensor` of shape `(batch_size, sequence_length, hidden_size)`, *optional*):
1246
+ Optionally, instead of passing `input_ids` you can choose to directly pass an embedded representation. This
1247
+ is useful if you want more control over how to convert `input_ids` indices into associated vectors than the
1248
+ model's internal embedding lookup matrix.
1249
+ position_ids (`torch.LongTensor` of shape `(batch_size,)`, *optional*):
1250
+ Indices of positions of each input sequence tokens in the position embeddings.
1251
+ cache_params (`HybridMambaAttentionDynamicCache`, *optional*):
1252
+ If passed along, the model uses the previous state in all the blocks (which will give the output for the
1253
+ `input_ids` provided as if the model add `state_input_ids + input_ids` as context).
1254
+ use_cache (`bool`, *optional*):
1255
+ If set to `True`, the `cache_params` is returned and can be used to quickly generate the next logits.
1256
+ output_attentions (`bool`, *optional*):
1257
+ Whether or not to return the attentions tensors of all attention layers.
1258
+ output_hidden_states (`bool`, *optional*):
1259
+ Whether or not to return the hidden states of all layers. See `hidden_states` under returned tensors for
1260
+ more detail.
1261
+ return_dict (`bool`, *optional*):
1262
+ Whether or not to return a [`~utils.ModelOutput`] instead of a plain tuple.
1263
+ cache_position (`torch.LongTensor` of shape `(batch_size,)`, *optional*):
1264
+ The position of the current input in the cache. This is used to ensure that the cache is correctly updated.
1265
+ If `cache_params` is passed, `cache_position` should also be passed.
1266
+ attention_mask (`torch.FloatTensor` of shape `(batch_size, sequence_length)`, *optional*):
1267
+ Mask to avoid performing attention on padding token indices. Mask values selected in `[0, 1]`:
1268
+
1269
+ - 1 for tokens that are **not masked**,
1270
+ - 0 for tokens that are **masked**.
1271
+
1272
+ [What are attention masks?](../glossary#attention-mask)
1273
+ """
1274
+
1275
+
1276
+ @add_start_docstrings(
1277
+ "The bare NemotronH Model transformer outputting raw hidden-states without any specific head on top.",
1278
+ NEMOTRONH_START_DOCSTRING,
1279
+ )
1280
+ class NemotronHModel(NemotronHPreTrainedModel):
1281
+ def __init__(self, config):
1282
+ super().__init__(config)
1283
+
1284
+ self.embeddings = nn.Embedding(config.vocab_size, config.hidden_size)
1285
+ self.layers = nn.ModuleList([NemotronHBlock(config, layer_idx=idx) for idx in range(config.num_hidden_layers)])
1286
+
1287
+ self.gradient_checkpointing = False
1288
+ self.norm_f = NemotronHRMSNorm(config.hidden_size, eps=config.layer_norm_epsilon)
1289
+ # Initialize weights and apply final processing
1290
+ self._register_load_state_dict_pre_hook(self.load_hook)
1291
+ self.post_init()
1292
+
1293
+ def load_hook(self, state_dict, prefix, *args):
1294
+ for k in state_dict:
1295
+ if "embedding." in k:
1296
+ state_dict[k.replace("embedding.", "embeddings.")] = state_dict.pop(k)
1297
+ break
1298
+
1299
+ def get_input_embeddings(self):
1300
+ return self.embeddings
1301
+
1302
+ def set_input_embeddings(self, new_embeddings):
1303
+ self.embeddings = new_embeddings
1304
+
1305
+ @add_start_docstrings_to_model_forward(NEMOTRONH_INPUTS_DOCSTRING)
1306
+ @add_code_sample_docstrings(
1307
+ checkpoint=_CHECKPOINT_FOR_DOC,
1308
+ output_type=NemotronHOutput,
1309
+ config_class=_CONFIG_FOR_DOC,
1310
+ )
1311
+ def forward(
1312
+ self,
1313
+ input_ids: Optional[torch.LongTensor] = None,
1314
+ inputs_embeds: Optional[torch.LongTensor] = None,
1315
+ position_ids: Optional[torch.LongTensor] = None,
1316
+ cache_params: Optional[HybridMambaAttentionDynamicCache] = None,
1317
+ use_cache: Optional[bool] = None,
1318
+ output_attentions: Optional[bool] = None,
1319
+ output_hidden_states: Optional[bool] = None,
1320
+ return_dict: Optional[bool] = None,
1321
+ cache_position: Optional[torch.LongTensor] = None,
1322
+ attention_mask: Optional[torch.Tensor] = None,
1323
+ **kwargs,
1324
+ ) -> Union[Tuple, NemotronHOutput]:
1325
+ output_attentions = output_attentions if output_attentions is not None else self.config.output_attentions
1326
+ output_hidden_states = (
1327
+ output_hidden_states if output_hidden_states is not None else self.config.output_hidden_states
1328
+ )
1329
+ # use_cache = use_cache if use_cache is not None else self.config.use_cache
1330
+ use_cache = use_cache if use_cache is not None else (self.config.use_cache if not self.training else False)
1331
+
1332
+ return_dict = return_dict if return_dict is not None else self.config.use_return_dict
1333
+
1334
+ if (input_ids is None) ^ (inputs_embeds is not None): # ^ is python for xor
1335
+ raise ValueError("You must specify exactly one of input_ids or inputs_embeds")
1336
+
1337
+ if inputs_embeds is None:
1338
+ inputs_embeds = self.embeddings(input_ids)
1339
+
1340
+ if self.gradient_checkpointing and self.training and use_cache:
1341
+ logger.warning_once(
1342
+ "`use_cache=True` is incompatible with gradient checkpointing. Setting `use_cache=False`."
1343
+ )
1344
+ use_cache = False
1345
+
1346
+ # From zamba_modeling.py
1347
+ if use_cache and cache_params is None:
1348
+ logger.warning_once(
1349
+ "NemotronH requires an initialized `NemotronHHybridDynamicCache` to return a cache. None was "
1350
+ "provided, so no cache will be returned."
1351
+ )
1352
+
1353
+ hidden_states = inputs_embeds
1354
+
1355
+ if cache_position is None:
1356
+ cache_position = torch.arange(hidden_states.shape[1], device=hidden_states.device)
1357
+ if position_ids is None:
1358
+ position_ids = cache_position.unsqueeze(0)
1359
+
1360
+ causal_mask = self._update_causal_mask(attention_mask, inputs_embeds, cache_position)
1361
+ mamba_mask = self._update_mamba_mask(attention_mask, cache_position)
1362
+
1363
+ all_hidden_states = () if output_hidden_states else None
1364
+ all_self_attns = () if output_attentions else None
1365
+ # Until HERE
1366
+
1367
+ for layer_idx, mixer_block in enumerate(self.layers):
1368
+ # Depending on the layer type we opt for 2D base attention mask (Mamba) or 4D causal mask (Attention)
1369
+ if mixer_block.block_type == "mamba":
1370
+ layer_mask = mamba_mask
1371
+ elif mixer_block.block_type == "attention":
1372
+ layer_mask = causal_mask
1373
+ elif mixer_block.block_type == "mlp":
1374
+ layer_mask = None
1375
+ else:
1376
+ raise ValueError(f"Invalid block_type: {self.block_type}")
1377
+
1378
+ if output_hidden_states:
1379
+ all_hidden_states += (hidden_states,)
1380
+
1381
+ if self.gradient_checkpointing and self.training:
1382
+ hidden_states = self._gradient_checkpointing_func(
1383
+ mixer_block.__call__, hidden_states, cache_params, cache_position, layer_mask
1384
+ )
1385
+ else:
1386
+ hidden_states = mixer_block(
1387
+ hidden_states,
1388
+ cache_params=cache_params,
1389
+ cache_position=cache_position,
1390
+ attention_mask=layer_mask,
1391
+ )
1392
+
1393
+ # TODO: Store attentions
1394
+ # if output_attentions:
1395
+ # if layer_outputs[1] is not None:
1396
+ # # append attentions only of attention layers. Mamba layers return `None` as the attention weights
1397
+ # all_self_attns += (layer_outputs[1],)
1398
+
1399
+ # TODO (Check): should it happen before the forward pass?
1400
+ # if output_hidden_states:
1401
+ # all_hidden_states = all_hidden_states + (hidden_states,)
1402
+
1403
+ hidden_states = self.norm_f(hidden_states)
1404
+
1405
+ if output_hidden_states:
1406
+ all_hidden_states = all_hidden_states + (hidden_states,)
1407
+
1408
+ if not return_dict:
1409
+ return tuple(v for v in [hidden_states, cache_params, all_hidden_states] if v is not None)
1410
+
1411
+ return NemotronHOutput(
1412
+ last_hidden_state=hidden_states,
1413
+ cache_params=cache_params if use_cache else None,
1414
+ hidden_states=all_hidden_states,
1415
+ attentions=all_self_attns,
1416
+ )
1417
+
1418
+ # Copied from transformers.models.jamba.modeling_jamba.JambaModel._update_causal_mask
1419
+ def _update_causal_mask(self, attention_mask, input_tensor, cache_position):
1420
+ if self.config._attn_implementation == "flash_attention_2":
1421
+ if attention_mask is not None and 0.0 in attention_mask:
1422
+ return attention_mask
1423
+ return None
1424
+
1425
+ dtype, device = input_tensor.dtype, input_tensor.device
1426
+ min_dtype = torch.finfo(dtype).min
1427
+ sequence_length = input_tensor.shape[1]
1428
+ target_length = cache_position[-1] + 1
1429
+
1430
+ causal_mask = torch.full((sequence_length, target_length), fill_value=min_dtype, dtype=dtype, device=device)
1431
+ if sequence_length != 1:
1432
+ causal_mask = torch.triu(causal_mask, diagonal=1)
1433
+ causal_mask *= torch.arange(target_length, device=device) > cache_position.reshape(-1, 1)
1434
+ causal_mask = causal_mask[None, None, :, :].expand(input_tensor.shape[0], 1, -1, -1)
1435
+ if attention_mask is not None:
1436
+ causal_mask = causal_mask.clone() # copy to contiguous memory for in-place edit
1437
+ if attention_mask.dim() == 2:
1438
+ mask_length = attention_mask.shape[-1]
1439
+ padding_mask = causal_mask[..., :mask_length].eq(0.0) * attention_mask[:, None, None, :].eq(0.0)
1440
+ causal_mask[..., :mask_length] = causal_mask[..., :mask_length].masked_fill(padding_mask, min_dtype)
1441
+
1442
+ if (
1443
+ self.config._attn_implementation == "sdpa"
1444
+ and attention_mask is not None
1445
+ and attention_mask.device.type == "cuda"
1446
+ ):
1447
+ # Attend to all tokens in fully masked rows in the causal_mask, for example the relevant first rows when
1448
+ # using left padding. This is required by F.scaled_dot_product_attention memory-efficient attention path.
1449
+ # Details: https://github.com/pytorch/pytorch/issues/110213
1450
+ causal_mask = AttentionMaskConverter._unmask_unattended(causal_mask, min_dtype)
1451
+
1452
+ return causal_mask
1453
+
1454
+ def _update_mamba_mask(self, attention_mask, cache_position):
1455
+ """
1456
+ No need for zeroing states when
1457
+ 1. Cached forward
1458
+ 2. Attending to all inputs
1459
+ """
1460
+ mamba_mask = attention_mask
1461
+ if cache_position[0] > 0 or (attention_mask is not None and torch.all(attention_mask == 1)):
1462
+ mamba_mask = None
1463
+ return mamba_mask
1464
+
1465
+
1466
+ @add_start_docstrings(
1467
+ """
1468
+ The NEMOTRONH Model transformer with a language modeling head on top (linear layer with weights not tied to the input
1469
+ embeddings).
1470
+ """,
1471
+ NEMOTRONH_START_DOCSTRING,
1472
+ )
1473
+ class NemotronHForCausalLM(NemotronHPreTrainedModel, GenerationMixin):
1474
+ _tied_weights_keys = ["lm_head.weight"]
1475
+
1476
+ def __init__(self, config):
1477
+ super().__init__(config)
1478
+ self.backbone = NemotronHModel(config)
1479
+ self.vocab_size = config.vocab_size
1480
+ self.lm_head = nn.Linear(config.hidden_size, config.vocab_size, bias=False)
1481
+
1482
+ # Initialize weights and apply final processing
1483
+ self.post_init()
1484
+
1485
+ def get_input_embeddings(self):
1486
+ return self.backbone.get_input_embeddings()
1487
+
1488
+ def set_input_embeddings(self, new_embeddings):
1489
+ return self.backbone.set_input_embeddings(new_embeddings)
1490
+
1491
+ def get_output_embeddings(self):
1492
+ return self.lm_head
1493
+
1494
+ def set_output_embeddings(self, new_embeddings):
1495
+ self.lm_head = new_embeddings
1496
+
1497
+ def get_decoder(self):
1498
+ return self.model
1499
+
1500
+ def set_decoder(self, decoder):
1501
+ self.model = decoder
1502
+
1503
+ def prepare_inputs_for_generation(
1504
+ self,
1505
+ input_ids,
1506
+ past_key_values=None,
1507
+ attention_mask=None,
1508
+ inputs_embeds=None,
1509
+ cache_position=None,
1510
+ position_ids=None,
1511
+ use_cache=True,
1512
+ **kwargs,
1513
+ ):
1514
+ # Copy from https://github.com/huggingface/transformers/blob/main/src/transformers/models/jamba/modeling_jamba.py
1515
+ # Overwitten -- uses `cache_params` as opposed to `past_key_values`
1516
+ empty_past_kv = past_key_values is None
1517
+
1518
+ # If we have cache: let's slice `input_ids` through `cache_position`, to keep only the unprocessed tokens
1519
+ # Exception 1: when passing input_embeds, input_ids may be missing entries
1520
+ # Exception 2: some generation methods do special slicing of input_ids, so we don't need to do it here
1521
+ # Exception 3: with synced GPUs cache_position may go out of bounds, but we only want dummy token in that case.
1522
+ # (we can't check exception 3 while compiling)
1523
+ if not empty_past_kv:
1524
+ if (
1525
+ inputs_embeds is not None # Exception 1
1526
+ or cache_position[-1] >= input_ids.shape[1] # Exception 3
1527
+ ):
1528
+ input_ids = input_ids[:, -cache_position.shape[0] :]
1529
+ elif input_ids.shape[1] != cache_position.shape[0]: # Default case (the "else", a no op, is Exception 2)
1530
+ input_ids = input_ids[:, cache_position]
1531
+ else:
1532
+ past_key_values = HybridMambaAttentionDynamicCache(
1533
+ self.config, input_ids.shape[0], self.dtype, device=self.device
1534
+ )
1535
+
1536
+ if attention_mask is not None and position_ids is None:
1537
+ # create position_ids on the fly for batch generation
1538
+ position_ids = attention_mask.long().cumsum(-1) - 1
1539
+ position_ids.masked_fill_(attention_mask == 0, 1)
1540
+ if not empty_past_kv:
1541
+ position_ids = position_ids[:, -input_ids.shape[1] :]
1542
+
1543
+ # if `inputs_embeds` are passed, we only want to use them in the 1st generation step
1544
+ if inputs_embeds is not None and empty_past_kv:
1545
+ # TODO(pjin): workaround fix for properly extending inputs_embeds;
1546
+ # longer term, may be better handled elsewhere in .generate().
1547
+ if input_ids is not None and inputs_embeds.shape[1] < input_ids.shape[1]:
1548
+ new_token_embeds = self.get_input_embeddings()(input_ids[:,inputs_embeds.shape[1]:])
1549
+ inputs_embeds = torch.cat([inputs_embeds, new_token_embeds], dim=1)
1550
+ model_inputs = {"inputs_embeds": inputs_embeds}
1551
+ else:
1552
+ model_inputs = {"input_ids": input_ids.contiguous()} # `contiguous()` needed for compilation use cases
1553
+
1554
+ model_inputs.update(
1555
+ {
1556
+ "position_ids": position_ids,
1557
+ "past_key_values": past_key_values,
1558
+ "use_cache": use_cache,
1559
+ "attention_mask": attention_mask,
1560
+ "logits_to_keep": self.config.num_logits_to_keep,
1561
+ "cache_position": cache_position,
1562
+ }
1563
+ )
1564
+ return model_inputs
1565
+
1566
+ @add_start_docstrings_to_model_forward(NEMOTRONH_INPUTS_DOCSTRING)
1567
+ @add_code_sample_docstrings(
1568
+ checkpoint=_CHECKPOINT_FOR_DOC,
1569
+ output_type=NemotronHCausalLMOutput,
1570
+ config_class=_CONFIG_FOR_DOC,
1571
+ )
1572
+ def forward(
1573
+ self,
1574
+ input_ids: Optional[torch.LongTensor] = None,
1575
+ inputs_embeds: Optional[torch.FloatTensor] = None,
1576
+ position_ids: Optional[torch.LongTensor] = None,
1577
+ cache_params: Optional[HybridMambaAttentionDynamicCache] = None,
1578
+ labels: Optional[torch.LongTensor] = None,
1579
+ output_attentions: Optional[bool] = None,
1580
+ output_hidden_states: Optional[bool] = None,
1581
+ return_dict: Optional[bool] = None,
1582
+ use_cache: Optional[bool] = None,
1583
+ cache_position: Optional[torch.Tensor] = None,
1584
+ attention_mask: Optional[torch.Tensor] = None,
1585
+ **kwargs, # for now we need this for generation
1586
+ ) -> Union[Tuple, NemotronHCausalLMOutput]:
1587
+ r"""
1588
+ labels (`torch.LongTensor` of shape `(batch_size, sequence_length)`, *optional*):
1589
+ Labels for language modeling. Note that the labels **are shifted** inside the model, i.e. you can set
1590
+ `labels = input_ids` Indices are selected in `[-100, 0, ..., config.vocab_size]` All labels set to `-100`
1591
+ are ignored (masked), the loss is only computed for labels in `[0, ..., config.vocab_size]`
1592
+ """
1593
+ output_attentions = output_attentions if output_attentions is not None else self.config.output_attentions
1594
+
1595
+ output_hidden_states = (
1596
+ output_hidden_states if output_hidden_states is not None else self.config.output_hidden_states
1597
+ )
1598
+ return_dict = return_dict if return_dict is not None else self.config.use_return_dict
1599
+
1600
+ nemotron_h_outputs = self.backbone(
1601
+ input_ids,
1602
+ cache_params=cache_params,
1603
+ inputs_embeds=inputs_embeds,
1604
+ output_attentions=output_attentions,
1605
+ output_hidden_states=output_hidden_states,
1606
+ return_dict=return_dict,
1607
+ use_cache=use_cache,
1608
+ cache_position=cache_position,
1609
+ attention_mask=attention_mask,
1610
+ )
1611
+ hidden_states = nemotron_h_outputs[0]
1612
+
1613
+ # TODO: Check zamba_modeling.py: https://github.com/huggingface/transformers/blob/d7188ba600e36d3fd191b12e19f1b3bb81a8404f/src/transformers/models/zamba/modeling_zamba.py#L1284C1-L1286C2
1614
+ #logits = self.lm_head(hidden_states.to(self.lm_head.weight.dtype)).float()
1615
+ logits = self.lm_head(hidden_states.to(self.lm_head.weight.dtype)).float()
1616
+
1617
+ loss = None
1618
+ if labels is not None:
1619
+ # move labels to correct device to enable model parallelism
1620
+ labels = labels.to(logits.device)
1621
+ # Shift so that tokens < n predict n
1622
+ shift_logits = logits[..., :-1, :].contiguous()
1623
+ shift_labels = labels[..., 1:].contiguous()
1624
+ # Flatten the tokens
1625
+ loss_fct = CrossEntropyLoss()
1626
+ loss = loss_fct(shift_logits.view(-1, shift_logits.size(-1)), shift_labels.view(-1))
1627
+
1628
+ if not return_dict:
1629
+ output = (logits,) + nemotron_h_outputs[1:]
1630
+ return ((loss,) + output) if loss is not None else output
1631
+
1632
+ return NemotronHCausalLMOutput(
1633
+ loss=loss,
1634
+ logits=logits,
1635
+ cache_params=nemotron_h_outputs.cache_params,
1636
+ hidden_states=nemotron_h_outputs.hidden_states,
1637
+ attentions=nemotron_h_outputs.attentions,
1638
+ )
nemotron_toolcall_parser_no_streaming.py ADDED
@@ -0,0 +1,110 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # SPDX-License-Identifier: Apache-2.0
2
+
3
+ import ast
4
+ import json
5
+ import re
6
+ from collections.abc import Sequence
7
+ from typing import Union
8
+
9
+ import partial_json_parser
10
+ from partial_json_parser.core.options import Allow
11
+
12
+ from vllm.entrypoints.openai.protocol import (
13
+ ChatCompletionRequest,
14
+ DeltaFunctionCall, DeltaMessage,
15
+ DeltaToolCall,
16
+ ExtractedToolCallInformation,
17
+ FunctionCall,
18
+ ToolCall,
19
+ )
20
+ from vllm.entrypoints.openai.tool_parsers.abstract_tool_parser import (
21
+ ToolParser,
22
+ ToolParserManager,
23
+ )
24
+ from vllm.logger import init_logger
25
+ from vllm.transformers_utils.tokenizer import AnyTokenizer
26
+ from vllm.utils import random_uuid
27
+
28
+ logger = init_logger(__name__)
29
+
30
+
31
+ @ToolParserManager.register_module("nemotron_json")
32
+ class NemotronJSONToolParser(ToolParser):
33
+
34
+ def __init__(self, tokenizer: AnyTokenizer):
35
+ super().__init__(tokenizer)
36
+
37
+ self.current_tool_name_sent: bool = False
38
+ self.prev_tool_call_arr: list[dict] = []
39
+ self.current_tool_id: int = -1
40
+ self.streamed_args_for_tool: list[str] = []
41
+
42
+ self.tool_call_start_token: str = "<TOOLCALL>"
43
+ self.tool_call_end_token: str = "</TOOLCALL>"
44
+
45
+ self.tool_call_regex = re.compile(r"<TOOLCALL>(.*?)</TOOLCALL>", re.DOTALL)
46
+
47
+ def extract_tool_calls(
48
+ self,
49
+ model_output: str,
50
+ request: ChatCompletionRequest,
51
+ ) -> ExtractedToolCallInformation:
52
+
53
+ if self.tool_call_start_token not in model_output:
54
+ return ExtractedToolCallInformation(
55
+ tools_called=False,
56
+ tool_calls=[],
57
+ content=model_output,
58
+ )
59
+
60
+ else:
61
+
62
+ try:
63
+ str_tool_calls = self.tool_call_regex.findall(model_output)[0].strip()
64
+ if not str_tool_calls.startswith("["):
65
+ str_tool_calls = "[" + str_tool_calls
66
+ if not str_tool_calls.endswith("]"):
67
+ str_tool_calls = "]" + str_tool_calls
68
+ json_tool_calls = json.loads(str_tool_calls)
69
+ tool_calls = []
70
+ for tool_call in json_tool_calls:
71
+ try:
72
+ tool_calls.append(ToolCall(
73
+ type="function",
74
+ function=FunctionCall(
75
+ name=tool_call["name"],
76
+ arguments=json.dumps(tool_call["arguments"], ensure_ascii=False) \
77
+ if isinstance(tool_call["arguments"], dict) else tool_call["arguments"],
78
+ ),
79
+ ))
80
+ except:
81
+ continue
82
+
83
+ content = model_output[:model_output.rfind(self.tool_call_start_token)]
84
+
85
+ return ExtractedToolCallInformation(
86
+ tools_called=True,
87
+ tool_calls=tool_calls,
88
+ content=content if content else None,
89
+ )
90
+
91
+ except Exception:
92
+ logger.exception(f"Error in extracting tool call from response. Response: {model_output}")
93
+ return ExtractedToolCallInformation(
94
+ tools_called=False,
95
+ tool_calls=[],
96
+ content=model_output,
97
+ )
98
+
99
+ def extract_tool_calls_streaming(
100
+ self,
101
+ previous_text: str,
102
+ current_text: str,
103
+ delta_text: str,
104
+ previous_token_ids: Sequence[int],
105
+ current_token_ids: Sequence[int],
106
+ delta_token_ids: Sequence[int],
107
+ request: ChatCompletionRequest,
108
+ ) -> Union[DeltaMessage, None]:
109
+
110
+ raise NotImplementedError("Tool calling is not supported in streaming mode!")
privacy.md ADDED
@@ -0,0 +1,13 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ | Field | Response |
2
+ | :---- | :---- |
3
+ | Generatable or reverse engineerable personal data? | No |
4
+ | Personal data used to create this model? | No |
5
+ | Was consent obtained for any personal data used? | Not Applicable |
6
+ | A description of any methods implemented in data acquisition or processing, if any, to address the prevalence of personal data in the training data, where relevant and applicable. | We used only prompts that do not contain any personal data for synthetic data generation. |
7
+ | How often is the dataset reviewed? | Before Release |
8
+ | Is there provenance for all datasets used in training? | Yes |
9
+ | Does data labeling (annotation, metadata) comply with privacy laws? | Yes |
10
+ | Is data compliant with data subject requests for data correction or removal, if such a request was made? | No, not possible with externally-sourced data. |
11
+ | Applicable Privacy Policy | [NVIDIA Privacy Policy](https://www.nvidia.com/en-us/about-nvidia/privacy-policy/) |
12
+ | During AI model development, strict adherence to copyright policy ensured compliance through risk mitigation and legal reviews. Post-data collection, reserved rights content is identified and removed, with verified opt-out processes for rightsholders. Detailed records document due diligence and transparency. | True |
13
+ | We employ automated tools and data processing techniques during pre-training to identify and filter certain categories of personal information. Scans of training datasets detected no PII. | True. We employ automated tools and data processing techniques to scan for Personally Identifiable Information (PII) during pre-training to identify and filter certain categories of personal information, including public-facing contact details such as email addresses and phone numbers. Scans of Common Crawl, CC-News, and Wikimedia datasets did not detect PII in the majority of samples. However, Microsoft Presidio indicated potential findings including business contact information embedded in natural language, such as email addresses and phone numbers. These were removed using verified instances of PII through a combination of automated filtering and human-in-the-loop validation. This evaluation used a 3,000-sample subset per dataset, identified as the optimal threshold for maximizing embedder accuracy. |
safety.md ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ | Field | Response |
2
+ | :---- | :---- |
3
+ | Model Application Field(s): | Chat, Instruction Following, Chatbot Development, Code Generation, Reasoning, Customer Service |
4
+ | Describe the life critical impact (if present). | Not Applicable |
5
+ | Description of methods implemented in data acquisition or processing, if any, to address other types of potentially harmful data in the training, testing, and validation data: | We used a guard model for content safety to exclude potentially harmful data from training. |
6
+ | Description of any methods implemented in data acquisition or processing, if any, to address illegal or harmful content in the training data, including, but not limited to, child sexual abuse material (CSAM) and non-consensual intimate imagery (NCII) | We used a Gemma-3 4B-based guard model trained on [Nemotron Content Safety Dataset v2](https://huggingface.co/datasets/nvidia/Aegis-AI-Content-Safety-Dataset-2.0) for content safety to exclude potentially illegal or harmful content from the training. |
7
+ | Use Case Restrictions: | This trial service is governed by the [NVIDIA API Trial Terms of Service](https://assets.ngc.nvidia.com/products/api-catalog/legal/NVIDIA%20API%20Trial%20Terms%20of%20Service.pdf). Use of this model is governed by the [NVIDIA Open Model License Agreement](https://www.nvidia.com/en-us/agreements/enterprise-software/nvidia-open-model-license/). |
8
+ | Model and dataset restrictions: | The Principle of least privilege (PoLP) is applied limiting access for dataset generation and model development. Restrictions enforce dataset access during training, and dataset license constraints adhered to. |
9
+ | This AI model was developed based on our policies to ensure responsible data handling and risk mitigation. The datasets used for training have been scanned for harmful content and illegal content, consistent with our policies including scanning for Child Sexual Abuse Material (CSAM). Ongoing review and monitoring mechanisms are in place based on our policies and to maintain data integrity. | True. We use [Nemotron Content Safety Dataset V2](https://huggingface.co/datasets/nvidia/Aegis-AI-Content-Safety-Dataset-2.0) and an internal safety dataset specialized for minority sexuality for content safety evaluation to ensure the safety of this model. |
special_tokens_map.json ADDED
@@ -0,0 +1,23 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "bos_token": {
3
+ "content": "<s>",
4
+ "lstrip": false,
5
+ "normalized": false,
6
+ "rstrip": false,
7
+ "single_word": false
8
+ },
9
+ "eos_token": {
10
+ "content": "<SPECIAL_12>",
11
+ "lstrip": false,
12
+ "normalized": false,
13
+ "rstrip": false,
14
+ "single_word": false
15
+ },
16
+ "unk_token": {
17
+ "content": "<unk>",
18
+ "lstrip": false,
19
+ "normalized": false,
20
+ "rstrip": false,
21
+ "single_word": false
22
+ }
23
+ }
tokenizer.json ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:3277c00fe5fb3963b3cb7c07b7f183722d2af4d775a4aea7cfb3684d7cccbc2f
3
+ size 17078330
tokenizer_config.json ADDED
The diff for this file is too large to render. See raw diff