cvoegele-nv commited on
Commit
035d93e
·
verified ·
1 Parent(s): 9aa9157

Upload checkpoint

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
audio_model.py ADDED
@@ -0,0 +1,174 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ """Sound/Audio model components for multimodal integration.
16
+
17
+ This module provides the SoundEncoder (wrapping Parakeet from HuggingFace transformers)
18
+ and SoundProjection (MLP to project audio embeddings to LLM hidden size).
19
+
20
+ The Parakeet model in HuggingFace transformers is documented at:
21
+ https://huggingface.co/docs/transformers/en/model_doc/parakeet
22
+ """
23
+
24
+ from typing import Optional
25
+
26
+ import torch
27
+ import torch.nn as nn
28
+
29
+ from transformers import ParakeetEncoder, ParakeetEncoderConfig
30
+ from transformers.utils import logging
31
+
32
+ logger = logging.get_logger(__name__)
33
+
34
+
35
+ class SquaredReLU(nn.Module):
36
+ """Squared ReLU activation function."""
37
+ def forward(self, x):
38
+ return torch.pow(torch.nn.functional.relu(x), 2)
39
+
40
+
41
+ class RMSNorm(nn.Module):
42
+ def __init__(self, hidden_size, eps=1e-5):
43
+ super().__init__()
44
+ self.weight = nn.Parameter(torch.ones(hidden_size))
45
+ self.eps = eps
46
+
47
+ def forward(self, hidden_states):
48
+ input_dtype = hidden_states.dtype
49
+ hidden_states = hidden_states.to(torch.float32)
50
+ variance = hidden_states.pow(2).mean(-1, keepdim=True)
51
+ hidden_states = hidden_states * torch.rsqrt(variance + self.eps)
52
+ return (self.weight.to(torch.float32) * hidden_states).to(input_dtype)
53
+
54
+
55
+ class SoundProjection(nn.Module):
56
+ """MLP projection from sound encoder hidden size to LLM hidden size.
57
+
58
+ Architecture: RMSNorm -> linear1 -> SquaredReLU -> linear2
59
+
60
+ This matches the Megatron checkpoint conversion structure:
61
+ - sound_projection.norm.weight
62
+ - sound_projection.linear1.weight
63
+ - sound_projection.linear2.weight
64
+ - sound_projection.linear1.bias (optional)
65
+ - sound_projection.linear2.bias (optional)
66
+ """
67
+
68
+ def __init__(
69
+ self,
70
+ sound_hidden_size: int,
71
+ projection_hidden_size: int,
72
+ llm_hidden_size: int,
73
+ bias: bool = True,
74
+ eps: float = 1e-5,
75
+ ):
76
+ super().__init__()
77
+ self.norm = RMSNorm(sound_hidden_size, eps=eps)
78
+ self.linear1 = nn.Linear(sound_hidden_size, projection_hidden_size, bias=bias)
79
+ self.activation = SquaredReLU()
80
+ self.linear2 = nn.Linear(projection_hidden_size, llm_hidden_size, bias=bias)
81
+
82
+ def forward(self, hidden_states: torch.Tensor) -> torch.Tensor:
83
+ """Project sound embeddings to LLM embedding space.
84
+
85
+ Args:
86
+ hidden_states: Sound encoder output [batch, seq_len, sound_hidden_size]
87
+
88
+ Returns:
89
+ Projected embeddings [batch, seq_len, llm_hidden_size]
90
+ """
91
+ hidden_states = self.norm(hidden_states)
92
+ hidden_states = self.linear1(hidden_states)
93
+ hidden_states = self.activation(hidden_states)
94
+ hidden_states = self.linear2(hidden_states)
95
+ return hidden_states
96
+
97
+
98
+ class SoundEncoder(nn.Module):
99
+ """Wrapper around the Parakeet encoder from HuggingFace transformers.
100
+
101
+ The Parakeet model is an ASR model with a Fast Conformer encoder.
102
+ We use only the encoder portion to extract audio embeddings.
103
+
104
+ Checkpoint structure:
105
+ - sound_encoder.encoder.feature_extractor.* -> Feature extraction (mel spectrogram)
106
+ - sound_encoder.encoder.pre_encode.* -> Pre-encoding convolutions
107
+ - sound_encoder.encoder.layers.* -> Conformer layers
108
+
109
+ Reference: https://huggingface.co/docs/transformers/en/model_doc/parakeet
110
+ """
111
+
112
+ def __init__(self, config=None):
113
+ super().__init__()
114
+
115
+ if config is not None:
116
+ # Build from config - handle both dict and config object
117
+ if hasattr(config, '__dict__'):
118
+ # It's a config object, extract relevant params for ParakeetConfig
119
+ config_dict = {
120
+ 'attention_bias': getattr(config, 'attention_bias', False),
121
+ 'hidden_size': getattr(config, 'hidden_size', 1024),
122
+ 'num_attention_heads': getattr(config, 'num_attention_heads', 8),
123
+ 'num_hidden_layers': getattr(config, 'num_hidden_layers', 24),
124
+ 'intermediate_size': getattr(config, 'intermediate_size', 4096),
125
+ 'conv_kernel_size': getattr(config, 'conv_kernel_size', 31),
126
+ 'convolution_bias': getattr(config, 'convolution_bias', False),
127
+ 'feat_in': getattr(config, 'feat_in', 80),
128
+ 'subsampling_factor': getattr(config, 'subsampling_factor', 8),
129
+ 'subsampling_conv_channels': getattr(config, 'subsampling_conv_channels', 256),
130
+ 'subsampling_conv_kernel_size': getattr(config, 'subsampling_conv_kernel_size', 3),
131
+ 'subsampling_conv_stride': getattr(config, 'subsampling_conv_stride', 2),
132
+ 'num_mel_bins': getattr(config, 'num_mel_bins', 128),
133
+ 'scale_input': getattr(config, 'scale_input', False),
134
+ }
135
+ elif isinstance(config, dict):
136
+ config_dict = config
137
+ else:
138
+ config_dict = {}
139
+
140
+ # Create ParakeetConfig with the extracted parameters
141
+ parakeet_config = ParakeetEncoderConfig(**config_dict)
142
+ self.config = parakeet_config
143
+ self.encoder = ParakeetEncoder(parakeet_config)
144
+ else:
145
+ raise ValueError(
146
+ "config must be provided, "
147
+ "and ParakeetEncoder must be available in transformers."
148
+ )
149
+
150
+ def forward(
151
+ self,
152
+ input_features: torch.Tensor,
153
+ attention_mask: Optional[torch.Tensor] = None,
154
+ ) -> torch.Tensor:
155
+ """Encode audio features.
156
+
157
+ Args:
158
+ input_features: Mel spectrogram features [batch, seq_len, feature_dim]
159
+ attention_mask: Optional attention mask [batch, seq_len]
160
+
161
+ Returns:
162
+ Audio embeddings [batch, encoded_seq_len, hidden_size]
163
+ """
164
+ outputs = self.encoder(
165
+ input_features=input_features,
166
+ attention_mask=attention_mask,
167
+ )
168
+ # Return the last hidden state
169
+ return outputs.last_hidden_state
170
+
171
+ @property
172
+ def hidden_size(self) -> int:
173
+ """Return the hidden size of the encoder."""
174
+ return self.config.hidden_size
chat_template.jinja ADDED
@@ -0,0 +1,273 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {% macro render_extra_keys(json_dict, handled_keys) %}
2
+ {%- if json_dict is mapping %}
3
+ {%- for json_key in json_dict if json_key not in handled_keys %}
4
+ {%- if json_dict[json_key] is mapping or (json_dict[json_key] is sequence and json_dict[json_key] is not string) %}
5
+ {{- '\n<' ~ json_key ~ '>' ~ (json_dict[json_key] | tojson | safe) ~ '</' ~ json_key ~ '>' }}
6
+ {%- else %}
7
+ {{- '\n<' ~ json_key ~ '>' ~ (json_dict[json_key] | string) ~ '</' ~ json_key ~ '>' }}
8
+ {%- endif %}
9
+ {%- endfor %}
10
+ {%- endif %}
11
+ {%- endmacro -%}
12
+ {%- set enable_thinking = enable_thinking if enable_thinking is defined else True %}
13
+ {%- set reasoning_budget = reasoning_budget if reasoning_budget is defined else None %}
14
+ {%- set truncate_history_thinking = truncate_history_thinking if truncate_history_thinking is defined else True %}
15
+
16
+ {#- Scan messages for VLM thinking toggles to override enable_thinking -#}
17
+ {%- set toggle = namespace(enable=enable_thinking) %}
18
+ {%- for m in messages %}
19
+ {%- if m['role'] == 'user' or m['role'] == 'system' -%}
20
+ {%- if m['content'] is string -%}
21
+ {%- set c = m['content'] %}
22
+ {%- if '/think' in c.replace('</think>', '') -%}
23
+ {%- set toggle.enable = true -%}
24
+ {%- elif '/no_think' in c -%}
25
+ {%- set toggle.enable = false -%}
26
+ {%- endif -%}
27
+ {%- else -%}
28
+ {%- for part in m['content'] -%}
29
+ {%- if part['type'] == 'text' -%}
30
+ {%- set c = part['text'] %}
31
+ {%- if '/think' in c.replace('</think>', '') -%}
32
+ {%- set toggle.enable = true -%}
33
+ {%- elif '/no_think' in c -%}
34
+ {%- set toggle.enable = false -%}
35
+ {%- endif -%}
36
+ {%- endif -%}
37
+ {%- endfor -%}
38
+ {%- endif -%}
39
+ {%- endif -%}
40
+ {%- endfor -%}
41
+ {#- Prepare message iteration similar to LM template -#}
42
+ {%- set ns = namespace(last_user_idx = -1) %}
43
+ {%- set loop_messages = messages %}
44
+ {%- for m in loop_messages %}
45
+ {%- if m["role"] == "user" %}
46
+ {%- set ns.last_user_idx = loop.index0 %}
47
+ {%- endif %}
48
+ {%- endfor -%}
49
+
50
+ {%- if messages[0]["role"] == "system" %}
51
+ {%- set system_message = messages[0]["content"] %}
52
+ {%- set loop_messages = messages[1:] %}
53
+ {%- else %}
54
+ {%- set system_message = "" %}
55
+ {%- set loop_messages = messages %}
56
+ {%- endif %}
57
+ {%- if not tools is defined %}
58
+ {%- set tools = [] %}
59
+ {%- endif %}
60
+ {#- Recompute last_user_idx relative to loop_messages after handling system -#}
61
+ {%- set ns = namespace(last_user_idx = -1) %}
62
+ {%- for m in loop_messages %}
63
+ {%- if m["role"] == "user" %}
64
+ {%- set ns.last_user_idx = loop.index0 %}
65
+ {%- endif %}
66
+ {%- endfor -%}
67
+ {#- System preamble with LM formatting, sanitize thinking toggles -#}
68
+ {%- if system_message is defined %}
69
+ {%- set sys_content = system_message | string %}
70
+ {%- set sys_content = sys_content.replace('</think>', '<_end_think>').replace('/think', '').replace('/no_think', '').replace('<_end_think>', '</think>') %}
71
+ {{- "<|im_start|>system\n" + sys_content }}
72
+ {%- else %}
73
+ {%- if tools is iterable and tools | length > 0 %}
74
+ {{- "<|im_start|>system\n" }}
75
+ {%- endif %}
76
+ {%- endif %}
77
+ {%- if tools is iterable and tools | length > 0 %}
78
+ {%- if system_message is defined and system_message | length > 0 %}
79
+ {{- "\n\n" }}
80
+ {%- endif %}
81
+ {{- "# Tools\n\nYou have access to the following functions:\n\n" }}
82
+ {{- "<tools>" }}
83
+ {%- for tool in tools %}
84
+ {%- if tool.function is defined %}
85
+ {%- set tool = tool.function %}
86
+ {%- endif %}
87
+ {{- "\n<function>\n<name>" ~ tool.name ~ "</name>" }}
88
+ {%- if tool.description is defined %}
89
+ {{- '\n<description>' ~ (tool.description | trim) ~ '</description>' }}
90
+ {%- endif %}
91
+ {{- '\n<parameters>' }}
92
+ {%- if tool.parameters is defined and tool.parameters is mapping and tool.parameters.properties is defined and tool.parameters.properties is mapping %}
93
+ {%- for param_name, param_fields in tool.parameters.properties|items %}
94
+ {{- '\n<parameter>' }}
95
+ {{- '\n<name>' ~ param_name ~ '</name>' }}
96
+ {%- if param_fields.type is defined %}
97
+ {{- '\n<type>' ~ (param_fields.type | string) ~ '</type>' }}
98
+ {%- endif %}
99
+ {%- if param_fields.description is defined %}
100
+ {{- '\n<description>' ~ (param_fields.description | trim) ~ '</description>' }}
101
+ {%- endif %}
102
+ {%- if param_fields.enum is defined %}
103
+ {{- '\n<enum>' ~ (param_fields.enum | tojson | safe) ~ '</enum>' }}
104
+ {%- endif %}
105
+ {%- set handled_keys = ['name', 'type', 'description', 'enum'] %}
106
+ {{- render_extra_keys(param_fields, handled_keys) }}
107
+ {{- '\n</parameter>' }}
108
+ {%- endfor %}
109
+ {%- endif %}
110
+ {%- set handled_keys = ['type', 'properties', 'required'] %}
111
+ {{- render_extra_keys(tool.parameters, handled_keys) }}
112
+ {%- if tool.parameters is defined and tool.parameters.required is defined %}
113
+ {{- '\n<required>' ~ (tool.parameters.required | tojson | safe) ~ '</required>' }}
114
+ {%- endif %}
115
+ {{- '\n</parameters>' }}
116
+ {%- set handled_keys = ['type', 'name', 'description', 'parameters'] %}
117
+ {{- render_extra_keys(tool, handled_keys) }}
118
+ {{- '\n</function>' }}
119
+ {%- endfor %}
120
+ {{- "\n</tools>" }}
121
+
122
+ {{- '\n\nIf you choose to call a function ONLY reply in the following format with NO suffix:\n\n<tool_call>\n<function=example_function_name>\n<parameter=example_parameter_1>\nvalue_1\n</parameter>\n<parameter=example_parameter_2>\nThis is the value for the second parameter\nthat can span\nmultiple lines\n</parameter>\n</function>\n</tool_call>\n\n<IMPORTANT>\nReminder:\n- Function calls MUST follow the specified format: an inner <function=...></function> block must be nested within <tool_call></tool_call> XML tags\n- Required parameters MUST be specified\n- You may provide optional reasoning for your function call in natural language BEFORE the function call, but NOT after\n- If there is no function call available, answer the question like normal with your current knowledge and do not tell the user about function calls\n</IMPORTANT>' }}
123
+ {%- endif -%}
124
+ {%- if system_message is defined %}
125
+ {{- '<|im_end|>\n' }}
126
+ {%- else %}
127
+ {%- if tools is iterable and tools | length > 0 %}
128
+ {{- '<|im_end|>\n' }}
129
+ {%- endif %}
130
+ {%- endif -%}
131
+ {#- Iterate conversation -#}
132
+ {%- for message in loop_messages %}
133
+ {%- if message.role == "assistant" %}
134
+ {#- Use LM assistant handling -#}
135
+ {%- if message.reasoning_content is defined and message.reasoning_content is string and message.reasoning_content | trim | length > 0 %}
136
+ {%- set content = "<think>\n" ~ message.reasoning_content ~ "\n</think>\n" ~ (message.content | default('', true)) %}
137
+ {%- else %}
138
+ {%- set content = message.content | default('', true) %}
139
+ {%- if content is string -%}
140
+ {%- if '<think>' not in content and '</think>' not in content -%}
141
+ {%- set content = "<think></think>" ~ content -%}
142
+ {%- endif -%}
143
+ {%- else -%}
144
+ {%- set content = content -%}
145
+ {%- endif -%}
146
+ {%- endif %}
147
+ {%- if message.tool_calls is defined and message.tool_calls is iterable and message.tool_calls | length > 0 %}
148
+ {{- '<|im_start|>assistant\n' }}
149
+ {%- set include_content = not (truncate_history_thinking and loop.index0 < ns.last_user_idx) %}
150
+ {%- if content is string and content | trim | length > 0 %}
151
+ {%- if include_content %}
152
+ {{- (content | trim) ~ '\n' -}}
153
+ {%- else %}
154
+ {%- set c = (content | string) %}
155
+ {%- if '</think>' in c %}
156
+ {%- set c = c.split('</think>')[-1] %}
157
+ {%- elif '<think>' in c %}
158
+ {%- set c = c.split('<think>')[0] %}
159
+ {%- endif %}
160
+ {%- set c = "<think></think>" ~ c | trim %}
161
+ {%- if c | length > 0 %}
162
+ {{- c ~ '\n' -}}
163
+ {%- endif %}
164
+ {%- endif %}
165
+ {%- else %}
166
+ {{- "<think></think>" -}}
167
+ {%- endif %}
168
+ {%- for tool_call in message.tool_calls %}
169
+ {%- if tool_call.function is defined %}
170
+ {%- set tool_call = tool_call.function %}
171
+ {%- endif %}
172
+ {{- '<tool_call>\n<function=' ~ tool_call.name ~ '>\n' -}}
173
+ {%- if tool_call.arguments is defined %}
174
+ {%- for args_name, args_value in tool_call.arguments|items %}
175
+ {{- '<parameter=' ~ args_name ~ '>\n' -}}
176
+ {%- set args_value = args_value | tojson | safe if args_value is mapping or (args_value is sequence and args_value is not string) else args_value | string %}
177
+ {{- args_value ~ '\n</parameter>\n' -}}
178
+ {%- endfor %}
179
+ {%- endif %}
180
+ {{- '</function>\n</tool_call>\n' -}}
181
+ {%- endfor %}
182
+ {{- '<|im_end|>\n' }}
183
+ {%- else %}
184
+ {%- if not (truncate_history_thinking and loop.index0 < ns.last_user_idx) %}
185
+ {{- '<|im_start|>assistant\n' ~ (content | default('', true) | string | trim) ~ '<|im_end|>\n' }}
186
+ {%- else %}
187
+ {%- set c = (content | default('', true) | string) %}
188
+ {%- if '<think>' in c and '</think>' in c %}
189
+ {%- set c = "<think></think>" ~ c.split('</think>')[-1] %}
190
+ {%- endif %}
191
+ {%- set c = c | trim %}
192
+ {%- if c | length > 0 %}
193
+ {{- '<|im_start|>assistant\n' ~ c ~ '<|im_end|>\n' }}
194
+ {%- else %}
195
+ {{- '<|im_start|>assistant\n<|im_end|>\n' }}
196
+ {%- endif %}
197
+ {%- endif %}
198
+ {%- endif %}
199
+ {%- elif message.role == "user" or message.role == "system" %}
200
+ {{- '<|im_start|>' + message.role + '\n' }}
201
+ {#- Build VLM multimodal content when content is a sequence -#}
202
+ {%- if message.content is string -%}
203
+ {%- set content = (message.content | string) %}
204
+ {%- else -%}
205
+ {%- set text_ns = namespace(val='') -%}
206
+ {%- set mm_content = '' -%}
207
+ {%- set counters = namespace(images=0, videos=0, audios=0) -%}
208
+ {%- for part in message['content'] -%}
209
+ {%- if part['type'] == 'image' or part['type'] == 'image_url' -%}
210
+ {%- set counters.images = counters.images + 1 -%}
211
+ {%- elif part['type'] == 'video' or part['type'] == 'video_url' -%}
212
+ {%- set counters.videos = counters.videos + 1 -%}
213
+ {%- elif part['type'] == 'audio' or part['type'] == 'audio_url' -%}
214
+ {%- set counters.audios = counters.audios + 1 -%}
215
+ {%- elif part['type'] == 'text' -%}
216
+ {%- set text_ns.val = text_ns.val + part['text'] -%}
217
+ {%- endif -%}
218
+ {%- endfor -%}
219
+ {%- if '<image>' in text_ns.val -%}
220
+ {%- set counters.images = 0 -%}
221
+ {%- endif -%}
222
+ {%- if '<video>' in text_ns.val -%}
223
+ {%- set counters.videos = 0 -%}
224
+ {%- endif -%}
225
+ {%- if '<so_embedding>' in text_ns.val -%}
226
+ {%- set counters.audios = 0 -%}
227
+ {%- endif -%}
228
+ {%- if counters.images > 1 -%}
229
+ {%- set image_tags = namespace(tags=[]) -%}
230
+ {%- for i in range(counters.images) -%}
231
+ {%- set image_tags.tags = image_tags.tags + ['<image ' + (i + 1)|string + '><image>'] -%}
232
+ {%- endfor -%}
233
+ {%- set mm_content = ' '.join(image_tags.tags) + '\n' -%}
234
+ {%- elif counters.images == 1 -%}
235
+ {%- set mm_content = '<image>\n' -%}
236
+ {%- endif -%}
237
+ {%- set mm_content = mm_content + '<video>\n' * counters.videos -%}
238
+ {%- set mm_content = mm_content + '<so_embedding>\n' * counters.audios -%}
239
+ {%- set content = mm_content + text_ns.val.lstrip('\n') -%}
240
+ {%- endif -%}
241
+ {#- Sanitize thinking toggle directives from user/system content -#}
242
+ {%- set content = content.replace('</think>', '<_end_think>').replace('/think', '').replace('/no_think', '').replace('<_end_think>', '</think>') -%}
243
+ {%- set content = content | trim -%}
244
+ {%- if message.role == "user" and loop.index0 == ns.last_user_idx and reasoning_budget is not none -%}
245
+ {{- content + '\n\n{thinking token budget: ' + (reasoning_budget | string) + '}' -}}
246
+ {%- else -%}
247
+ {{- content -}}
248
+ {%- endif -%}
249
+ {{- '<|im_end|>\n' }}
250
+ {%- elif message.role == "tool" %}
251
+ {%- if loop.previtem and loop.previtem.role != "tool" %}
252
+ {{- '<|im_start|>user\n' }}
253
+ {%- endif %}
254
+ {{- '<tool_response>\n' }}
255
+ {{- message.content }}
256
+ {{- '\n</tool_response>\n' }}
257
+ {%- if not loop.last and loop.nextitem.role != "tool" %}
258
+ {{- '<|im_end|>\n' }}
259
+ {%- elif loop.last %}
260
+ {{- '<|im_end|>\n' }}
261
+ {%- endif %}
262
+ {%- else %}
263
+ {{- '<|im_start|>' + message.role + '\n' + message.content + '<|im_end|>\n' }}
264
+ {%- endif %}
265
+ {%- endfor -%}
266
+ {#- Generation prompt using computed thinking toggle -#}
267
+ {%- if add_generation_prompt %}
268
+ {%- if toggle.enable %}
269
+ {{- '<|im_start|>assistant\n<think>\n' }}
270
+ {%- else %}
271
+ {{- '<|im_start|>assistant\n<think></think>' }}
272
+ {%- endif %}
273
+ {%- endif %}
config.json ADDED
The diff for this file is too large to render. See raw diff
 
configuration.py ADDED
@@ -0,0 +1,114 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+ from transformers.configuration_utils import PretrainedConfig
15
+ from transformers.utils import logging
16
+ from .configuration_nemotron_h import NemotronHConfig
17
+ from .configuration_radio import RADIOConfig
18
+
19
+ logger = logging.get_logger(__name__)
20
+
21
+
22
+ class SoundConfig(PretrainedConfig):
23
+ """Configuration for the sound/audio model (Parakeet encoder + projection)."""
24
+ model_type = "parakeet"
25
+
26
+ def __init__(
27
+ self,
28
+ # Parakeet encoder config
29
+ hidden_size: int = 1024,
30
+ num_attention_heads: int = 8,
31
+ num_hidden_layers: int = 24,
32
+ intermediate_size: int = 4096,
33
+ conv_kernel_size: int = 31,
34
+ feat_in: int = 80, # Mel features
35
+ subsampling_factor: int = 8,
36
+ # Projection config
37
+ projection_hidden_size: int = 20480,
38
+ projection_bias: bool = True,
39
+ # Audio processing
40
+ sampling_rate: int = 16000,
41
+ **kwargs,
42
+ ):
43
+ super().__init__(**kwargs)
44
+ self.hidden_size = hidden_size
45
+ self.num_attention_heads = num_attention_heads
46
+ self.num_hidden_layers = num_hidden_layers
47
+ self.intermediate_size = intermediate_size
48
+ self.conv_kernel_size = conv_kernel_size
49
+ self.feat_in = feat_in
50
+ self.subsampling_factor = subsampling_factor
51
+ self.projection_hidden_size = projection_hidden_size
52
+ self.projection_bias = projection_bias
53
+ self.sampling_rate = sampling_rate
54
+
55
+
56
+ class NemotronH_Nano_Omni_Reasoning_V3_Config(PretrainedConfig):
57
+ model_type = 'NemotronH_Nano_Omni_Reasoning_V3'
58
+ is_composition = True
59
+
60
+ def __init__(
61
+ self,
62
+ vision_config=None,
63
+ llm_config=None,
64
+ sound_config=None,
65
+ force_image_size=None,
66
+ downsample_ratio=0.5,
67
+ template=None,
68
+ ps_version='v1',
69
+ image_tag_type="internvl",
70
+ projector_hidden_size=4096,
71
+ vit_hidden_size=1280,
72
+ attn_implementation="flash_attention_2",
73
+ video_pruning_rate: float = 0.0,
74
+ # Sound/audio settings
75
+ sound_context_token_id: int = None,
76
+ sound_context_token: str = "<audio>",
77
+ **kwargs
78
+ ):
79
+ super().__init__(**kwargs)
80
+
81
+ if vision_config is not None:
82
+ self.vision_config = RADIOConfig(**vision_config)
83
+ else:
84
+ self.vision_config = RADIOConfig()
85
+
86
+ # Handle both cases: when loading from JSON (llm_config is dict) and when called internally by transformers (llm_config is None)
87
+ if llm_config is not None:
88
+ self.llm_config = NemotronHConfig(**llm_config)
89
+ else:
90
+ self.llm_config = NemotronHConfig()
91
+
92
+ # Sound/audio model configuration
93
+ if sound_config is not None:
94
+ self.sound_config = SoundConfig(**sound_config)
95
+ else:
96
+ self.sound_config = None # Sound model is optional
97
+
98
+ # Assign configuration values
99
+ self.force_image_size = force_image_size
100
+ self.downsample_ratio = downsample_ratio
101
+ self.template = template # TODO move out of here and into the tokenizer
102
+ self.ps_version = ps_version # Pixel shuffle version
103
+ self.image_tag_type = image_tag_type # TODO: into the tokenizer too?
104
+ self.projector_hidden_size = projector_hidden_size
105
+ self.vit_hidden_size = vit_hidden_size
106
+ self.video_pruning_rate = video_pruning_rate
107
+
108
+ # Sound/audio token settings
109
+ self.sound_context_token_id = sound_context_token_id
110
+ self.sound_context_token = sound_context_token
111
+
112
+ self._attn_implementation = attn_implementation
113
+ self.vision_config.use_flash_attn = self._attn_implementation is not None and "flash_attention" in self._attn_implementation
114
+ self.llm_config._attn_implementation = self._attn_implementation
configuration_nemotron_h.py ADDED
@@ -0,0 +1,262 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ 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
+ head_dim=128,
144
+ num_key_value_heads=8, # nemo: num_query_groups
145
+ mlp_hidden_act="relu2",
146
+ attention_bias=False,
147
+ mlp_bias=False,
148
+ use_bias=False,
149
+ initializer_range=0.02, # nemo: init_method_std
150
+ layer_norm_epsilon=1e-5, # nemo: layernorm_epsilon
151
+ residual_in_fp32=False, # Megatron Core default value
152
+ use_cache=True,
153
+ num_logits_to_keep=1,
154
+ pad_token_id=0,
155
+ bos_token_id=1,
156
+ eos_token_id=2,
157
+ sliding_window=None,
158
+ max_position_embeddings=4096,
159
+ attention_dropout=0.0,
160
+ hidden_dropout=0.0, # * ADDED
161
+ use_mamba_kernels=True,
162
+ ssm_state_size=128, # mamba_state_size
163
+ mamba_num_heads=128,
164
+ mamba_n_groups=8, # nemo: mamba_ssm_ngroups = num_heads
165
+ mamba_head_dim=64,
166
+ mamba_d_conv=4,
167
+ mamba_expand=2,
168
+ mamba_hidden_act="silu",
169
+ mamba_dt_min=0.001,
170
+ mamba_dt_max=0.1,
171
+ mamba_dt_limit=(0.0, float("inf")),
172
+ mamba_dt_init_floor=1e-4,
173
+ mamba_conv_bias=True,
174
+ mamba_proj_bias=False,
175
+ mamba_chunk_size=128,
176
+ rescale_prenorm_residual=True,
177
+ n_routed_experts=8,
178
+ n_shared_experts=1,
179
+ moe_intermediate_size=7688,
180
+ moe_shared_expert_intermediate_size=7688,
181
+ num_experts_per_tok=2,
182
+ routed_scaling_factor=1.0,
183
+ n_group=1,
184
+ topk_group=1,
185
+ norm_topk_prob=True,
186
+ **kwargs,
187
+ ):
188
+ self.vocab_size = vocab_size
189
+ self.tie_word_embeddings = tie_word_embeddings
190
+ self.hidden_size = hidden_size
191
+ self.intermediate_size = intermediate_size
192
+ self.num_hidden_layers = num_hidden_layers
193
+ self.hybrid_override_pattern = hybrid_override_pattern
194
+ self.num_attention_heads = num_attention_heads
195
+ self.head_dim = head_dim
196
+ self.sliding_window = sliding_window
197
+ self.max_position_embeddings = max_position_embeddings
198
+ self.attention_dropout = attention_dropout
199
+ self.hidden_dropout = hidden_dropout
200
+
201
+ # Validate hybrid_override_pattern
202
+ # M: Mamba2, *: Attention, -: MLP, E: MoE
203
+ assert len(self.hybrid_override_pattern) == self.num_hidden_layers, "hybrid_override_pattern must have the same length as num_hidden_layers"
204
+ assert re.match(r"^[*\-ME]+$", self.hybrid_override_pattern), "hybrid_override_pattern must only contain characters 'M', '*', '-', or 'E'"
205
+
206
+ # for backward compatibility
207
+ if num_key_value_heads is None:
208
+ num_key_value_heads = num_attention_heads
209
+
210
+ self.num_key_value_heads = num_key_value_heads
211
+ self.mlp_hidden_act = mlp_hidden_act
212
+ self.attention_bias = attention_bias
213
+ self.mlp_bias = mlp_bias
214
+ self.use_bias = use_bias
215
+ self.initializer_range = initializer_range
216
+ self.layer_norm_epsilon = layer_norm_epsilon
217
+ self.residual_in_fp32 = residual_in_fp32
218
+
219
+ self.use_cache = use_cache
220
+ self.num_logits_to_keep = num_logits_to_keep
221
+
222
+ self.use_mamba_kernels = use_mamba_kernels
223
+ self.n_groups = mamba_n_groups
224
+ self.mamba_head_dim = mamba_head_dim
225
+ self.ssm_state_size = ssm_state_size
226
+ self.mamba_num_heads = mamba_num_heads
227
+ self.conv_kernel = mamba_d_conv
228
+ self.expand = mamba_expand
229
+ self.mamba_hidden_act = mamba_hidden_act
230
+ self.time_step_min = mamba_dt_min
231
+ self.time_step_max = mamba_dt_max
232
+ self.time_step_limit = mamba_dt_limit
233
+ self.time_step_floor = mamba_dt_init_floor
234
+ self.use_conv_bias = mamba_conv_bias
235
+ self.mamba_proj_bias = mamba_proj_bias
236
+ self.chunk_size = mamba_chunk_size
237
+ self.rescale_prenorm_residual = rescale_prenorm_residual
238
+ self.n_routed_experts = n_routed_experts
239
+ self.n_shared_experts = n_shared_experts
240
+ self.moe_intermediate_size = moe_intermediate_size
241
+ self.moe_shared_expert_intermediate_size = moe_shared_expert_intermediate_size
242
+ self.num_experts_per_tok = num_experts_per_tok
243
+ self.routed_scaling_factor = routed_scaling_factor
244
+ self.n_group = n_group
245
+ self.topk_group = topk_group
246
+ self.norm_topk_prob = norm_topk_prob
247
+
248
+ super().__init__(
249
+ pad_token_id=pad_token_id,
250
+ bos_token_id=bos_token_id,
251
+ eos_token_id=eos_token_id,
252
+ tie_word_embeddings=tie_word_embeddings,
253
+ **kwargs,
254
+ )
255
+
256
+ @property
257
+ def layers_block_type(self):
258
+ return [
259
+ "mamba" if self.hybrid_override_pattern[i] == "M" else
260
+ "attention" if self.hybrid_override_pattern[i] == "*" else
261
+ "mlp" if self.hybrid_override_pattern[i] == "-" else "moe"
262
+ for i in range(self.num_hidden_layers)]
configuration_radio.py ADDED
@@ -0,0 +1,152 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) 2024, NVIDIA CORPORATION. All rights reserved.
2
+ #
3
+ # NVIDIA CORPORATION and its licensors retain all intellectual property
4
+ # and proprietary rights in and to this software, related documentation
5
+ # and any modifications thereto. Any use, reproduction, disclosure or
6
+ # distribution of this software and related documentation without an express
7
+ # license agreement from NVIDIA CORPORATION is strictly prohibited.
8
+
9
+ from dataclasses import dataclass
10
+ from typing import Optional, NamedTuple, Union, List, Dict
11
+
12
+ from transformers import PretrainedConfig
13
+
14
+
15
+ class Resolution(NamedTuple):
16
+ height: int
17
+ width: int
18
+
19
+
20
+ @dataclass
21
+ class RadioResource:
22
+ url: str
23
+ patch_size: int
24
+ max_resolution: int
25
+ preferred_resolution: Resolution
26
+ vitdet_num_windowed: Optional[int] = None
27
+ vitdet_num_global: Optional[int] = None
28
+
29
+
30
+ RESOURCE_MAP = {
31
+ # RADIOv2.5
32
+ "radio_v2.5-b": RadioResource(
33
+ "https://huggingface.co/nvidia/RADIO/resolve/main/radio-v2.5-b_half.pth.tar?download=true",
34
+ patch_size=16,
35
+ max_resolution=2048,
36
+ preferred_resolution=(768, 768),
37
+ vitdet_num_global=4,
38
+ ),
39
+ "radio_v2.5-l": RadioResource(
40
+ "https://huggingface.co/nvidia/RADIO/resolve/main/radio-v2.5-l_half.pth.tar?download=true",
41
+ patch_size=16,
42
+ max_resolution=2048,
43
+ preferred_resolution=(768, 768),
44
+ vitdet_num_global=4,
45
+ ),
46
+ "radio_v2.5-h": RadioResource(
47
+ "https://huggingface.co/nvidia/RADIO/resolve/main/radio_v2.5-h.pth.tar?download=true",
48
+ patch_size=16,
49
+ max_resolution=2048,
50
+ preferred_resolution=(768, 768),
51
+ vitdet_num_global=4,
52
+ ),
53
+ "radio_v2.5-h-norm": RadioResource(
54
+ "https://huggingface.co/nvidia/RADIO/resolve/main/radio_v2.5-h-norm.pth.tar?download=true",
55
+ patch_size=16,
56
+ max_resolution=2048,
57
+ preferred_resolution=(768, 768),
58
+ vitdet_num_global=4,
59
+ ),
60
+ "radio_v2.5-g": RadioResource(
61
+ "https://huggingface.co/nvidia/RADIO/resolve/main/radio_v2.5-g.pth.tar?download=true",
62
+ patch_size=14,
63
+ max_resolution=1792,
64
+ preferred_resolution=(896, 896),
65
+ vitdet_num_global=8,
66
+ ),
67
+ # RADIO
68
+ "radio_v2.1": RadioResource(
69
+ "https://huggingface.co/nvidia/RADIO/resolve/main/radio_v2.1_bf16.pth.tar?download=true",
70
+ patch_size=16,
71
+ max_resolution=2048,
72
+ preferred_resolution=Resolution(432, 432),
73
+ vitdet_num_windowed=5,
74
+ ),
75
+ "radio_v2": RadioResource(
76
+ "https://huggingface.co/nvidia/RADIO/resolve/main/radio_v2.pth.tar?download=true",
77
+ patch_size=16,
78
+ max_resolution=2048,
79
+ preferred_resolution=Resolution(432, 432),
80
+ vitdet_num_windowed=5,
81
+ ),
82
+ "radio_v1": RadioResource(
83
+ "https://huggingface.co/nvidia/RADIO/resolve/main/radio_v1.pth.tar?download=true",
84
+ patch_size=14,
85
+ max_resolution=1050,
86
+ preferred_resolution=Resolution(378, 378),
87
+ ),
88
+ # E-RADIO
89
+ "e-radio_v2": RadioResource(
90
+ "https://huggingface.co/nvidia/RADIO/resolve/main/eradio_v2.pth.tar?download=true",
91
+ patch_size=16,
92
+ max_resolution=2048,
93
+ preferred_resolution=Resolution(512, 512),
94
+ ),
95
+ # C-RADIO
96
+ "c-radio_v2.5-g": RadioResource(
97
+ "https://huggingface.co/nvidia/C-RADIOv2-g/resolve/main/c-radio_v2-g_half.pth.tar",
98
+ patch_size=16,
99
+ max_resolution=2048,
100
+ preferred_resolution=(768, 768),
101
+ vitdet_num_global=8,
102
+ ),
103
+ "c-radio_v3-l": RadioResource(
104
+ # NOTE: Currently, this model cannot be loaded via TorchHub. Instead, use the transformers API at https://huggingface.co/nvidia/C-RADIOv3-L
105
+ # and accept the license terms.
106
+ "https://huggingface.co/nvidia/C-RADIOv3-L/resolve/main/c-radio-v3_l_half.pth.tar?download=true",
107
+ patch_size=16,
108
+ max_resolution=2048,
109
+ preferred_resolution=Resolution(512, 512),
110
+ ),
111
+ }
112
+
113
+ DEFAULT_VERSION = "radio_v2.5-h"
114
+
115
+
116
+ class RADIOConfig(PretrainedConfig):
117
+ """Pretrained Hugging Face configuration for RADIO models."""
118
+
119
+ def __init__(
120
+ self,
121
+ args: Optional[dict] = None,
122
+ version: Optional[str] = DEFAULT_VERSION,
123
+ patch_size: Optional[int] = None,
124
+ max_resolution: Optional[int] = None,
125
+ preferred_resolution: Optional[Resolution] = None,
126
+ adaptor_names: Union[str, List[str]] = None,
127
+ adaptor_configs: Dict[str, Dict[str, int]] = None,
128
+ vitdet_window_size: Optional[int] = None,
129
+ feature_normalizer_config: Optional[dict] = None,
130
+ inter_feature_normalizer_config: Optional[dict] = None,
131
+ **kwargs,
132
+ ):
133
+ self.args = args
134
+ for field in ["dtype", "amp_dtype"]:
135
+ if self.args is not None and field in self.args:
136
+ # Convert to a string in order to make it serializable.
137
+ # For example for torch.float32 we will store "float32",
138
+ # for "bfloat16" we will store "bfloat16".
139
+ self.args[field] = str(args[field]).split(".")[-1]
140
+ self.version = version
141
+ resource = RESOURCE_MAP[version]
142
+ self.patch_size = patch_size or resource.patch_size
143
+ self.max_resolution = max_resolution or resource.max_resolution
144
+ self.preferred_resolution = (
145
+ preferred_resolution or resource.preferred_resolution
146
+ )
147
+ self.adaptor_names = adaptor_names
148
+ self.adaptor_configs = adaptor_configs
149
+ self.vitdet_window_size = vitdet_window_size
150
+ self.feature_normalizer_config = feature_normalizer_config
151
+ self.inter_feature_normalizer_config = inter_feature_normalizer_config
152
+ super().__init__(**kwargs)
evs.py ADDED
@@ -0,0 +1,73 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ import torch
2
+ from typing import Tuple
3
+
4
+ class EfficientVideoSampling:
5
+ @staticmethod
6
+ def compute_retention_mask(
7
+ *,
8
+ video_embeds: torch.FloatTensor,
9
+ thw: torch.LongTensor,
10
+ spatial_merge_size: int,
11
+ q: float,
12
+ ):
13
+ """
14
+ Computes the retention mask for video embeddings based on the grid dimensions.
15
+
16
+ Args:
17
+ video_embeds (`torch.FloatTensor` of shape `(T * H * W, hidden_size)`):
18
+ The video embeddings to compute the retention mask for.
19
+ thw (`torch.LongTensor` of shape `(3)`):
20
+ The temporal, height and width of feature shape of each video in LLM.
21
+ spatial_merge_size (`int`): The spatial merge size of the video embeddings.
22
+ If embeddings will be downsampled *later*, this should be the downsampling factor.
23
+ q: (`float`): Pruning rate factor, indicating number of tokens to prune (remove)
24
+
25
+ Returns:
26
+ `torch.Tensor`: The retention mask for the video embeddings (T * H * W).
27
+ 1 for tokens to keep, 0 for tokens to prune.
28
+ """
29
+ T, H, W = thw
30
+
31
+ # video_embeds = einops.rearrange(
32
+ # video_embeds,
33
+ # "(T H W) C -> T H W C",
34
+ # T=T,
35
+ # H=H // spatial_merge_size,
36
+ # W=W // spatial_merge_size,
37
+ # )
38
+ # Use reshape instead of einops to avoid graph breaks
39
+ video_embeds = video_embeds.reshape(
40
+ T, H // spatial_merge_size, W // spatial_merge_size, video_embeds.size(-1)
41
+ )
42
+
43
+ # Core EVS
44
+ similarity = torch.nn.functional.cosine_similarity(
45
+ video_embeds[1:, ...], video_embeds[:-1, ...], dim=-1
46
+ )
47
+ dissimilarity = 1 - similarity
48
+
49
+ # Always ensure we include all tokens from the first frame
50
+ dissimilarity = torch.cat(
51
+ [255 * torch.ones_like(video_embeds[:1, :, :, 0]), dissimilarity], dim=0
52
+ )
53
+ dissimilarity_flat = dissimilarity.view(-1)
54
+
55
+ min_num_tokens = (H // spatial_merge_size) * (W // spatial_merge_size) # a single frame
56
+ evs_num_tokens = int(T * min_num_tokens * (1 - q))
57
+ num_tokens_to_keep = max(min_num_tokens, evs_num_tokens)
58
+
59
+ order = torch.argsort(dissimilarity_flat,
60
+ dim=-1,
61
+ descending=True,
62
+ stable=True)
63
+ topk_indices = order[:num_tokens_to_keep]
64
+
65
+ retention_mask = torch.zeros_like(dissimilarity_flat, dtype=torch.bool)
66
+ retention_mask[topk_indices] = True
67
+ retention_mask = retention_mask.reshape(dissimilarity.size())
68
+
69
+ # print(
70
+ # f"Computed retention mask of shape {retention_mask.shape=} with sparsity {retention_mask.float().mean().item():.4f} for {q=}",
71
+ # )
72
+ mask = retention_mask.view(-1) # "T H W -> (T H W)"
73
+ return mask
generation_config.json ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_from_model_config": true,
3
+ "bos_token_id": 1,
4
+ "eos_token_id": [2, 11],
5
+ "pad_token_id": 0,
6
+ "do_sample": true,
7
+ "temperature": 0.6,
8
+ "top_p": 0.95,
9
+ "max_new_tokens": 16384,
10
+ "reasoning_budget": 16384,
11
+ "reasoning_grace": 512,
12
+ "repetition_penalty": 1.0,
13
+ "transformers_version": "4.55.4"
14
+ }
hf_quant_config.json ADDED
The diff for this file is too large to render. See raw diff
 
image_processing.py ADDED
@@ -0,0 +1,148 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ from typing import List, Optional, Union, Any, Dict
2
+
3
+ from PIL import Image
4
+ import torch
5
+ from transformers.image_processing_base import BatchFeature
6
+ from transformers.image_processing_utils_fast import BaseImageProcessorFast, divide_to_patches
7
+ from transformers.image_utils import (make_list_of_images, get_image_size,
8
+ get_image_type, ImageInput, ImageType, ChannelDimension)
9
+ from transformers.utils import TensorType
10
+ import torchvision.transforms as T
11
+
12
+
13
+
14
+ class NemotronH_Nano_Omni_Reasoning_V3ImageProcessor(BaseImageProcessorFast):
15
+ model_input_names = ["pixel_values"]
16
+
17
+ def __init__(self, image_size=512, max_num_tiles=12, use_thumbnail=True, norm_mean=None, norm_std=None, do_rescale=True, patch_size=16, downsample_ratio=0.5, **kwargs):
18
+ super().__init__(**kwargs)
19
+ self.image_size = image_size
20
+ self.max_num_tiles = max_num_tiles
21
+ self.use_thumbnail = use_thumbnail
22
+ self.norm_mean = norm_mean
23
+ self.norm_std = norm_std
24
+ self.do_rescale = do_rescale
25
+ self.num_image_token = int((image_size // patch_size) ** 2 * (downsample_ratio ** 2))
26
+
27
+ def _process_image(
28
+ self,
29
+ image: ImageInput,
30
+ **kwargs,
31
+ ) -> torch.Tensor:
32
+ image_type = get_image_type(image)
33
+ if image_type == ImageType.PIL:
34
+ if image.mode != 'RGB':
35
+ image = image.convert('RGB')
36
+ image = T.ToTensor()(image)
37
+ return image
38
+
39
+ def _preprocess(
40
+ self,
41
+ images: List[torch.Tensor],
42
+ image_size: int = None,
43
+ max_num_tiles: int = None,
44
+ use_thumbnail: bool = None,
45
+ do_rescale: bool = None,
46
+ return_tensors: Optional[Union[str, TensorType]] = None,
47
+ **kwargs,
48
+ ) -> List[torch.Tensor]:
49
+ image_size = image_size if image_size is not None else self.image_size
50
+ max_num_tiles = max_num_tiles if max_num_tiles is not None else self.max_num_tiles
51
+ use_thumbnail = use_thumbnail if use_thumbnail is not None else self.use_thumbnail
52
+ do_rescale = do_rescale if do_rescale is not None else self.do_rescale
53
+
54
+ images = make_list_of_images(images)
55
+
56
+ all_patches = []
57
+ num_patches = []
58
+ for image in images:
59
+ patches = dynamic_preprocess(image, image_size, max_num_tiles, use_thumbnail)
60
+ all_patches.extend(patches)
61
+ num_patches.append(len(patches))
62
+
63
+ pixel_values = torch.stack(all_patches, dim=0)
64
+ norm_mean = torch.Tensor(self.norm_mean).view(1, 3, 1, 1)
65
+ norm_std = torch.Tensor(self.norm_std).view(1, 3, 1, 1)
66
+ pixel_values = (pixel_values - norm_mean) / norm_std
67
+ return BatchFeature(data={"pixel_values": pixel_values, "num_patches": num_patches}, tensor_type=return_tensors)
68
+
69
+
70
+ def get_internvl_target_ratios(
71
+ min_num: int,
72
+ max_num: int,
73
+ ) -> list[tuple[int, int]]:
74
+ target_ratios = {(i, j)
75
+ for n in range(min_num, max_num + 1)
76
+ for i in range(1, n + 1)
77
+ for j in range(1, n + 1) if min_num <= i * j <= max_num}
78
+ return sorted(target_ratios, key=lambda x: x[0] * x[1])
79
+
80
+
81
+ # From https://github.com/OpenGVLab/InternVL/blob/c62fa4f7c850165d7386bdc48ac6bc5a6fab0864/internvl_chat/internvl/train/dataset.py#L685
82
+ # Copyright (c) 2023 OpenGVLab.
83
+ def find_closest_aspect_ratio(
84
+ aspect_ratio: float,
85
+ target_ratios: list[tuple[int, int]],
86
+ width: int,
87
+ height: int,
88
+ image_size: int,
89
+ ) -> tuple[int, int]:
90
+ best_ratio_diff = float("inf")
91
+ best_ratio = (1, 1)
92
+ area = width * height
93
+ for ratio in target_ratios:
94
+ target_aspect_ratio = ratio[0] / ratio[1]
95
+ ratio_diff = abs(aspect_ratio - target_aspect_ratio)
96
+ if ratio_diff < best_ratio_diff:
97
+ best_ratio_diff = ratio_diff
98
+ best_ratio = ratio
99
+ elif ratio_diff == best_ratio_diff:
100
+ if area > 0.5 * image_size * image_size * ratio[0] * ratio[1]:
101
+ best_ratio = ratio
102
+ return best_ratio
103
+
104
+
105
+ def calculate_targets(
106
+ orig_width: int,
107
+ orig_height: int,
108
+ target_ratios: list[tuple[int, int]],
109
+ image_size: int,
110
+ ) -> tuple[int, int, int]:
111
+ aspect_ratio = orig_width / orig_height
112
+
113
+ # find the closest aspect ratio to the target
114
+ target_aspect_ratio = find_closest_aspect_ratio(
115
+ aspect_ratio,
116
+ target_ratios,
117
+ width=orig_width,
118
+ height=orig_height,
119
+ image_size=image_size,
120
+ )
121
+
122
+ # calculate the target width and height
123
+ target_width = image_size * target_aspect_ratio[0]
124
+ target_height = image_size * target_aspect_ratio[1]
125
+ blocks = target_aspect_ratio[0] * target_aspect_ratio[1]
126
+
127
+ return blocks, target_width, target_height
128
+
129
+
130
+ def dynamic_preprocess(image, image_size=512, max_num_tiles=12, use_thumbnail=True):
131
+ orig_height, orig_width = get_image_size(image, channel_dim=ChannelDimension.FIRST)
132
+ target_ratios = get_internvl_target_ratios(1, max_num_tiles)
133
+
134
+ blocks, target_width, target_height = calculate_targets(
135
+ orig_width,
136
+ orig_height,
137
+ target_ratios,
138
+ image_size
139
+ )
140
+ # resize the image
141
+ resized_img = T.Resize((target_height, target_width), interpolation=T.InterpolationMode.BICUBIC)(image)
142
+ patches = divide_to_patches(resized_img, image_size)
143
+ assert len(patches) == blocks
144
+ if use_thumbnail and len(patches) != 1:
145
+ thumbnail_img = T.Resize((image_size, image_size), interpolation=T.InterpolationMode.BICUBIC)(image)
146
+ patches.append(thumbnail_img)
147
+
148
+ return patches
model-00001-of-00003.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:089da47c88226bf46d4edf2f77f0f16c8bfaa0b29bbf71a2fae7c4b76fe64a1b
3
+ size 9999356664
model-00002-of-00003.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:3004edb5d9b81fb2b9dbedbf02b3c41b93b87ca607d9a387ea6dede9fa1eb39a
3
+ size 9993385656
model-00003-of-00003.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:16c197ed062bcfa3fb3d721e3ed58bfcef487ba7d18a1ae9170357c38e973e94
3
+ size 2416291872
model.safetensors.index.json ADDED
The diff for this file is too large to render. See raw diff
 
modeling.py ADDED
@@ -0,0 +1,463 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+ import os
15
+ import warnings
16
+ from typing import List, Optional, Tuple, Union
17
+
18
+ import torch
19
+ import transformers
20
+ from torch import nn
21
+ from torch.nn import CrossEntropyLoss
22
+ from transformers import AutoModel, AutoModelForCausalLM, GenerationConfig
23
+ from transformers.modeling_outputs import CausalLMOutputWithPast
24
+ from transformers.modeling_utils import PreTrainedModel
25
+ from transformers.utils import logging
26
+
27
+ from .configuration import NemotronH_Nano_Omni_Reasoning_V3_Config
28
+ from .modeling_nemotron_h import NemotronHForCausalLM
29
+ from .evs import EfficientVideoSampling
30
+ from .audio_model import SoundEncoder, SoundProjection
31
+
32
+ logger = logging.get_logger(__name__)
33
+
34
+
35
+ """
36
+ The following code is adapted from the
37
+ https://huggingface.co/OpenGVLab/InternVL2-Llama3-76B/blob/main/modeling_internvl_chat.py repository
38
+
39
+ The chat function is adapted to handle NVLM 1-D tile-tagging design for dynamic high-resolution images.
40
+ """
41
+
42
+
43
+ class SquaredReLU(nn.Module):
44
+ def forward(self, x):
45
+ return torch.pow(torch.nn.functional.relu(x), 2)
46
+
47
+
48
+ class RMSNorm(nn.Module):
49
+ def __init__(self, hidden_size, eps=1e-5):
50
+ super().__init__()
51
+ self.weight = nn.Parameter(torch.ones(hidden_size))
52
+ self.eps = eps
53
+
54
+ def forward(self, hidden_states):
55
+ input_dtype = hidden_states.dtype
56
+ hidden_states = hidden_states.to(torch.float32)
57
+ variance = hidden_states.pow(2).mean(-1, keepdim=True)
58
+ hidden_states = hidden_states * torch.rsqrt(variance + self.eps)
59
+ return (self.weight.to(torch.float32) * hidden_states).to(input_dtype)
60
+
61
+
62
+ def version_cmp(v1, v2, op='eq'):
63
+ import operator
64
+
65
+ from packaging import version
66
+ op_func = getattr(operator, op)
67
+ return op_func(version.parse(v1), version.parse(v2))
68
+
69
+
70
+ class NemotronH_Nano_Omni_Reasoning_V3(PreTrainedModel):
71
+ config_class = NemotronH_Nano_Omni_Reasoning_V3_Config
72
+ main_input_name = 'pixel_values'
73
+ _supports_flash_attn_2 = True
74
+ _no_split_modules = ['NemotronHBlock']
75
+
76
+ def __init__(self, config: NemotronH_Nano_Omni_Reasoning_V3_Config):
77
+ super().__init__(config)
78
+
79
+ assert version_cmp(transformers.__version__, '4.36.2', 'ge')
80
+ image_size = config.force_image_size
81
+ patch_size = config.patch_size
82
+ self.patch_size = patch_size
83
+ self.template = config.template
84
+ self.num_image_token = int((image_size // patch_size) ** 2 * (config.downsample_ratio ** 2))
85
+ self.downsample_ratio = config.downsample_ratio
86
+ self.ps_version = config.ps_version
87
+ self.image_tag_type = config.image_tag_type
88
+ self.img_context_token_id = config.img_context_token_id
89
+ self.video_context_token_id = config.video_context_token_id
90
+
91
+ logger.info(f'num_image_token: {self.num_image_token}')
92
+ logger.info(f'ps_version: {self.ps_version}')
93
+
94
+ # Instantiate LM directly to avoid Hugging Face dynamic module lookup requiring a repo id.
95
+ self.language_model = NemotronHForCausalLM(config.llm_config)
96
+ self.vision_model = AutoModel.from_config(config.vision_config, trust_remote_code=True)
97
+ self.vision_model.model._initialize_weights = self.vision_model.model._init_weights # WAR for transformers issue 38358
98
+ self.vision_model.radio_model.make_preprocessor_external()
99
+ self.vision_model = self.vision_model.to(self.language_model.config.torch_dtype)
100
+
101
+ self.drop_vision_class_token = True
102
+
103
+ # Construct the vision projection.
104
+ # Default
105
+ vit_hidden_size = config.vit_hidden_size
106
+ vision_projection_hidden_size = config.projector_hidden_size
107
+ llm_hidden_size = config.llm_config.hidden_size
108
+
109
+ self.video_pruning_rate = config.video_pruning_rate
110
+
111
+ self.mlp1 = nn.Sequential(
112
+ RMSNorm(vit_hidden_size * int(1 / self.downsample_ratio) ** 2, eps=1e-5),
113
+ nn.Linear(vit_hidden_size * int(1 / self.downsample_ratio) ** 2, vision_projection_hidden_size, bias=False),
114
+ SquaredReLU(),
115
+ nn.Linear(vision_projection_hidden_size, llm_hidden_size, bias=False)
116
+ )
117
+ self.mlp1 = self.mlp1.to(self.language_model.config.torch_dtype)
118
+
119
+ # Sound/audio model components (optional - only if sound_config is provided)
120
+ self.sound_context_token_id = getattr(config, 'sound_context_token_id', None)
121
+ if config.sound_config is not None:
122
+ sound_config = config.sound_config
123
+ sound_hidden_size = sound_config.hidden_size
124
+ sound_projection_hidden_size = sound_config.projection_hidden_size
125
+
126
+ # Initialize sound feature extractor for converting raw audio to mel spectrograms
127
+ from transformers import ParakeetFeatureExtractor
128
+ sampling_rate = getattr(sound_config, 'sampling_rate', 16000)
129
+ feature_size = getattr(sound_config, 'num_mel_bins', 128)
130
+ self.sound_feature_extractor = ParakeetFeatureExtractor(
131
+ sampling_rate=sampling_rate,
132
+ feature_size=feature_size,
133
+ )
134
+ logger.info(f'Sound feature extractor initialized with sampling_rate={sampling_rate}, feature_size={feature_size}')
135
+
136
+ # Initialize sound encoder - wraps Parakeet from transformers
137
+ self.sound_encoder = SoundEncoder(config=sound_config)
138
+ self.sound_encoder = self.sound_encoder.to(self.language_model.config.torch_dtype)
139
+
140
+ # Initialize sound projection MLP
141
+ self.sound_projection = SoundProjection(
142
+ sound_hidden_size=sound_hidden_size,
143
+ projection_hidden_size=sound_projection_hidden_size,
144
+ llm_hidden_size=llm_hidden_size,
145
+ bias=sound_config.projection_bias,
146
+ )
147
+ self.sound_projection = self.sound_projection.to(self.language_model.config.torch_dtype)
148
+
149
+ logger.info(f'Sound model initialized with hidden_size={sound_hidden_size}')
150
+ else:
151
+ self.sound_encoder = None
152
+ self.sound_projection = None
153
+ self.sound_feature_extractor = None
154
+
155
+ def forward(
156
+ self,
157
+ pixel_values: torch.FloatTensor,
158
+ input_ids: torch.LongTensor = None,
159
+ attention_mask: Optional[torch.Tensor] = None,
160
+ position_ids: Optional[torch.LongTensor] = None,
161
+ image_flags: Optional[torch.LongTensor] = None,
162
+ past_key_values: Optional[List[torch.FloatTensor]] = None,
163
+ labels: Optional[torch.LongTensor] = None,
164
+ inputs_embeds = None,
165
+ use_cache: Optional[bool] = None,
166
+ output_attentions: Optional[bool] = None,
167
+ output_hidden_states: Optional[bool] = None,
168
+ return_dict: Optional[bool] = None,
169
+ ) -> Union[Tuple, CausalLMOutputWithPast]:
170
+ return_dict = return_dict if return_dict is not None else self.config.use_return_dict
171
+
172
+ if inputs_embeds is None:
173
+ inputs_embeds = self.language_model.get_input_embeddings()(input_ids)
174
+
175
+ image_flags = image_flags.squeeze(-1)
176
+
177
+ B, N, C = inputs_embeds.shape
178
+ inputs_embeds = inputs_embeds.reshape(B * N, C)
179
+
180
+ input_ids = input_ids.reshape(B * N)
181
+ selected = (input_ids == self.img_context_token_id)
182
+
183
+ vit_batch_size = pixel_values.shape[0]
184
+ vit_embeds = self.extract_feature(pixel_values)
185
+
186
+ del pixel_values
187
+
188
+ if torch.distributed.get_rank() == 0:
189
+ print(f'dynamic ViT batch size: {vit_batch_size}, images per sample: {vit_batch_size / B}, dynamic token length: {N}')
190
+
191
+ vit_embeds = vit_embeds[image_flags == 1]
192
+ try:
193
+ inputs_embeds[selected] = inputs_embeds[selected] * 0.0 + vit_embeds.reshape(-1, C)
194
+ except Exception as e:
195
+ vit_embeds = vit_embeds.reshape(-1, C)
196
+ print(f'warning: {e}, inputs_embeds[selected].shape={inputs_embeds[selected].shape}, '
197
+ f'vit_embeds.shape={vit_embeds.shape}')
198
+ n_token = selected.sum()
199
+ inputs_embeds[selected] = inputs_embeds[selected] * 0.0 + vit_embeds[:n_token]
200
+
201
+ del vit_embeds
202
+
203
+ inputs_embeds = inputs_embeds.reshape(B, N, C)
204
+
205
+ outputs = self.language_model(
206
+ inputs_embeds=inputs_embeds,
207
+ attention_mask=attention_mask,
208
+ position_ids=position_ids,
209
+ past_key_values=past_key_values,
210
+ use_cache=use_cache,
211
+ output_attentions=output_attentions,
212
+ output_hidden_states=output_hidden_states,
213
+ return_dict=return_dict,
214
+ )
215
+ logits = outputs.logits
216
+
217
+ loss = None
218
+ if labels is not None:
219
+ # Shift so that tokens < n predict n
220
+ shift_logits = logits[..., :-1, :].contiguous()
221
+ shift_labels = labels[..., 1:].contiguous()
222
+ # Flatten the tokens
223
+ loss_fct = CrossEntropyLoss()
224
+ shift_logits = shift_logits.view(-1, self.language_model.config.vocab_size)
225
+ shift_labels = shift_labels.view(-1)
226
+ # Enable model parallelism
227
+ shift_labels = shift_labels.to(shift_logits.device)
228
+ loss = loss_fct(shift_logits, shift_labels)
229
+
230
+ if not return_dict:
231
+ output = (logits,) + outputs[1:]
232
+ return (loss,) + output if loss is not None else output
233
+
234
+ return CausalLMOutputWithPast(
235
+ loss=loss,
236
+ logits=logits,
237
+ past_key_values=outputs.past_key_values,
238
+ hidden_states=outputs.hidden_states,
239
+ attentions=outputs.attentions,
240
+ )
241
+
242
+ def pixel_shuffle(self, x, scale_factor=0.5):
243
+ n, w, h, c = x.size()
244
+ # N, W, H, C --> N, W, H * scale, C // scale
245
+ x = x.view(n, w, int(h * scale_factor), int(c / scale_factor))
246
+ # N, W, H * scale, C // scale --> N, H * scale, W, C // scale
247
+ x = x.permute(0, 2, 1, 3).contiguous()
248
+ # N, H * scale, W, C // scale --> N, H * scale, W * scale, C // (scale ** 2)
249
+ x = x.view(n, int(h * scale_factor), int(w * scale_factor),
250
+ int(c / (scale_factor * scale_factor)))
251
+ if self.ps_version == 'v1':
252
+ warnings.warn("In ps_version 'v1', the height and width have not been swapped back, "
253
+ 'which results in a transposed image.')
254
+ else:
255
+ x = x.permute(0, 2, 1, 3).contiguous()
256
+ return x
257
+
258
+ def extract_feature(self, pixel_values):
259
+ vit_embeds = self.vision_model(pixel_values).features
260
+ vit_embeds = vit_embeds.to(dtype=torch.bfloat16)
261
+ h = w = int(vit_embeds.shape[1] ** 0.5)
262
+ vit_embeds = vit_embeds.reshape(vit_embeds.shape[0], h, w, -1)
263
+ vit_embeds = self.pixel_shuffle(vit_embeds, scale_factor=self.downsample_ratio)
264
+ vit_embeds = vit_embeds.reshape(vit_embeds.shape[0], -1, vit_embeds.shape[-1])
265
+ vit_embeds = self.mlp1(vit_embeds)
266
+ return vit_embeds
267
+
268
+ def extract_sound_feature(
269
+ self,
270
+ input_features: torch.Tensor,
271
+ attention_mask: Optional[torch.Tensor] = None,
272
+ ) -> torch.Tensor:
273
+ """Extract and project sound features from audio input.
274
+
275
+ Args:
276
+ input_features: Mel spectrogram features [batch, seq_len, feature_dim]
277
+ attention_mask: Optional attention mask [batch, seq_len]
278
+
279
+ Returns:
280
+ Sound embeddings projected to LLM hidden size [batch, encoded_seq_len, llm_hidden_size]
281
+ """
282
+ if self.sound_encoder is None:
283
+ raise RuntimeError("Sound encoder not initialized. Check if sound_config is provided.")
284
+
285
+ # Encode audio features
286
+ sound_embeds = self.sound_encoder(input_features, attention_mask)
287
+ sound_embeds = sound_embeds.to(dtype=torch.bfloat16)
288
+
289
+ # Project to LLM hidden size
290
+ sound_embeds = self.sound_projection(sound_embeds)
291
+
292
+ return sound_embeds
293
+
294
+ @torch.no_grad()
295
+ def generate(
296
+ self,
297
+ pixel_values: Optional[torch.FloatTensor] = None,
298
+ pixel_values_videos: Optional[torch.FloatTensor] = None,
299
+ sound_clips: Optional[torch.FloatTensor] = None,
300
+ sound_length: Optional[torch.Tensor] = None,
301
+ input_ids: Optional[torch.FloatTensor] = None,
302
+ attention_mask: Optional[torch.LongTensor] = None,
303
+ generation_config: Optional[GenerationConfig] = None,
304
+ output_hidden_states: Optional[bool] = None,
305
+ return_dict: Optional[bool] = None,
306
+ **generate_kwargs,
307
+ ) -> torch.LongTensor:
308
+ """Generate text given images, videos, and/or audio.
309
+
310
+ Args:
311
+ pixel_values: Image pixel values [num_tiles, C, H, W]
312
+ pixel_values_videos: Video pixel values [num_frames, C, H, W]
313
+ sound_clips: Raw audio waveforms. Can be:
314
+ - A list of numpy arrays or torch tensors (one per audio clip)
315
+ - A single numpy array or torch tensor for a single audio clip
316
+ - Pre-extracted mel spectrogram features [batch, seq_len, num_mel_bins]
317
+ sound_length: Length of each audio clip in samples (optional, used for batched audio)
318
+ input_ids: Input token IDs [batch, seq_len]
319
+ attention_mask: Attention mask [batch, seq_len]
320
+ generation_config: Generation configuration
321
+ output_hidden_states: Whether to output hidden states
322
+ return_dict: Whether to return a dict
323
+ **generate_kwargs: Additional generation arguments
324
+
325
+ Returns:
326
+ Generated token IDs
327
+ """
328
+ assert self.img_context_token_id is not None
329
+
330
+ has_images = pixel_values is not None
331
+ has_videos = pixel_values_videos is not None
332
+ has_sound = sound_clips is not None and self.sound_encoder is not None
333
+
334
+ if has_images or has_videos or has_sound:
335
+ image_vit_embeds, video_vit_embeds, sound_embeds = None, None, None
336
+
337
+ # Process images
338
+ if has_images:
339
+ pixel_values = pixel_values.to(dtype=self.vision_model.config.torch_dtype)
340
+ image_vit_embeds = self.extract_feature(pixel_values)
341
+
342
+ # Process videos
343
+ if has_videos:
344
+ pixel_values_videos = pixel_values_videos.to(dtype=self.vision_model.config.torch_dtype)
345
+ video_vit_embeds = self.extract_feature(pixel_values_videos)
346
+
347
+ # Process sound/audio
348
+ if has_sound:
349
+ # Extract features from raw audio using the feature extractor
350
+ # Handle different input types:
351
+ # - list/tuple of waveforms
352
+ # - 1D tensor/array (single waveform)
353
+ # - 2D tensor [batch, samples] (batched raw waveforms)
354
+ # - 3D tensor [batch, seq_len, num_mel_bins] (pre-extracted features)
355
+ import numpy as np
356
+
357
+ is_raw_waveform = False
358
+ if isinstance(sound_clips, (list, tuple)):
359
+ # List of audio clips (waveforms)
360
+ is_raw_waveform = True
361
+ waveforms = sound_clips
362
+ elif isinstance(sound_clips, np.ndarray):
363
+ # Numpy array - raw waveform
364
+ is_raw_waveform = True
365
+ waveforms = [sound_clips.squeeze()] if sound_clips.ndim > 1 else [sound_clips]
366
+ elif isinstance(sound_clips, torch.Tensor):
367
+ if sound_clips.dim() == 1:
368
+ # 1D tensor - single raw waveform
369
+ is_raw_waveform = True
370
+ waveforms = [sound_clips.cpu().numpy()]
371
+ elif sound_clips.dim() == 2:
372
+ # 2D tensor [batch, samples] - batched raw waveforms
373
+ is_raw_waveform = True
374
+ waveforms = [clip.cpu().numpy() for clip in sound_clips]
375
+ else:
376
+ # 3D tensor [batch, seq_len, num_mel_bins] - pre-extracted features
377
+ is_raw_waveform = False
378
+ else:
379
+ is_raw_waveform = False
380
+
381
+ if is_raw_waveform:
382
+ # Convert raw waveforms to mel spectrogram features
383
+ audio_inputs = self.sound_feature_extractor(
384
+ waveforms,
385
+ sampling_rate=self.sound_feature_extractor.sampling_rate,
386
+ return_tensors="pt",
387
+ )
388
+ sound_input_features = audio_inputs.input_features
389
+ sound_attention_mask = audio_inputs.get("attention_mask", None)
390
+ else:
391
+ # Already extracted features
392
+ sound_input_features = sound_clips
393
+ sound_attention_mask = None
394
+
395
+ # Move to correct device and dtype
396
+ target_device = self.sound_encoder.encoder.subsampling.linear.weight.device
397
+ target_dtype = self.language_model.config.torch_dtype
398
+
399
+ sound_input_features = sound_input_features.to(dtype=target_dtype, device=target_device)
400
+ if sound_attention_mask is not None:
401
+ sound_attention_mask = sound_attention_mask.to(device=target_device)
402
+
403
+ sound_embeds = self.extract_sound_feature(sound_input_features, sound_attention_mask)
404
+
405
+ inputs_embeds = self.language_model.get_input_embeddings()(input_ids)
406
+ B, N, C = inputs_embeds.shape
407
+ inputs_embeds = inputs_embeds.reshape(B * N, C)
408
+ input_ids_copy = input_ids.reshape(B * N)
409
+
410
+ # Replace image tokens with image embeddings
411
+ if image_vit_embeds is not None:
412
+ image_mask = (input_ids_copy == self.img_context_token_id)
413
+ assert image_mask.sum() != 0, "No image tokens found in input_ids"
414
+ inputs_embeds[image_mask] = image_vit_embeds.reshape(-1, C).to(inputs_embeds.device, inputs_embeds.dtype)
415
+
416
+ # Replace video tokens with video embeddings
417
+ if video_vit_embeds is not None:
418
+ if B > 1:
419
+ raise NotImplementedError("Video is not supported for batch size > 1")
420
+ video_mask = (input_ids_copy == self.video_context_token_id)
421
+ assert video_mask.sum() != 0, "No video tokens found in input_ids"
422
+ inputs_embeds[video_mask] = video_vit_embeds.reshape(-1, C).to(inputs_embeds.device, inputs_embeds.dtype)
423
+
424
+ # Replace sound tokens with sound embeddings
425
+ if sound_embeds is not None and self.sound_context_token_id is not None:
426
+ sound_mask = (input_ids_copy == self.sound_context_token_id)
427
+ assert sound_mask.sum() != 0, "No sound tokens found in input_ids"
428
+ inputs_embeds[sound_mask] = sound_embeds.reshape(-1, C).to(inputs_embeds.device, inputs_embeds.dtype)
429
+
430
+ # Apply video pruning (EVS) if enabled
431
+ if video_vit_embeds is not None and self.video_pruning_rate > 0: # EVS
432
+ h = w = int(video_vit_embeds.shape[1] ** 0.5) # assumption here (and everywhere else) is that shape is square
433
+ evs_mask = EfficientVideoSampling.compute_retention_mask(
434
+ video_embeds=video_vit_embeds,
435
+ thw=(video_vit_embeds.shape[0], h, w),
436
+ spatial_merge_size=1, # we already work on vision embeddings, so no downsampling to follow
437
+ q=self.video_pruning_rate,
438
+ )
439
+ print(f"pruning rate: {self.video_pruning_rate}, EVS mask: {evs_mask.sum().item()} tokens retained out of {evs_mask.numel()} total video tokens ({evs_mask.sum().item() / evs_mask.numel() * 100:.2f}%)")
440
+
441
+ retention_mask = torch.ones_like(input_ids_copy, dtype=torch.bool)
442
+ retention_mask[video_mask] = evs_mask.view(-1)
443
+ inputs_embeds = inputs_embeds[retention_mask].unsqueeze(0) # adding batch=1
444
+ if attention_mask is not None:
445
+ attention_mask = attention_mask[:, retention_mask].contiguous()
446
+ if input_ids is not None:
447
+ input_ids = input_ids[:, retention_mask].contiguous()
448
+ else:
449
+ inputs_embeds = inputs_embeds.reshape(B, N, C)
450
+ else:
451
+ inputs_embeds = self.language_model.get_input_embeddings()(input_ids)
452
+
453
+ outputs = self.language_model.generate(
454
+ input_ids=input_ids,
455
+ inputs_embeds=inputs_embeds,
456
+ attention_mask=attention_mask,
457
+ generation_config=generation_config,
458
+ output_hidden_states=output_hidden_states,
459
+ use_cache=True,
460
+ **generate_kwargs,
461
+ )
462
+
463
+ return outputs
modeling_nemotron_h.py ADDED
@@ -0,0 +1,1734 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ import torch.nn.functional as F
27
+
28
+ from transformers.activations import ACT2FN
29
+ from transformers.cache_utils import DynamicCache # we need __iter__ and __len__ of pkv
30
+ from transformers.generation import GenerationMixin
31
+ from transformers.modeling_attn_mask_utils import (
32
+ AttentionMaskConverter,
33
+ )
34
+ from transformers.modeling_utils import PreTrainedModel
35
+ from transformers.utils import (
36
+ ModelOutput,
37
+ add_code_sample_docstrings,
38
+ add_start_docstrings,
39
+ add_start_docstrings_to_model_forward,
40
+ logging,
41
+ )
42
+ from transformers.utils.import_utils import (
43
+ is_causal_conv1d_available,
44
+ is_flash_attn_2_available,
45
+ is_flash_attn_greater_or_equal_2_10,
46
+ is_mamba_2_ssm_available,
47
+ )
48
+ from .configuration_nemotron_h import NemotronHConfig
49
+
50
+
51
+ logger = logging.get_logger(__name__)
52
+
53
+
54
+ # Copied from transformers.models.mamba.modeling_mamba2.modeling_mamba2.py with MAMBA2->NEMOTRONH,Mamba2->NemotronH
55
+ # For Mamba2 components Mamba2->NemotronHMamba2
56
+ if is_mamba_2_ssm_available():
57
+ from mamba_ssm.ops.triton.selective_state_update import selective_state_update
58
+ from mamba_ssm.ops.triton.ssd_combined import mamba_chunk_scan_combined, mamba_split_conv1d_scan_combined
59
+ else:
60
+ mamba_chunk_scan_combined, mamba_split_conv1d_scan_combined, selective_state_update = None, None, None
61
+
62
+ try:
63
+ #from mamba_ssm.ops.triton.layernorm_gated import RMSNorm as RMSNormGated
64
+ from mamba_ssm.ops.triton.layernorm_gated import rmsnorm_fn
65
+ except ImportError:
66
+ raise ImportError("mamba-ssm is required by the Mamba model but cannot be imported")
67
+
68
+ if is_causal_conv1d_available():
69
+ from causal_conv1d import causal_conv1d_fn, causal_conv1d_update
70
+ else:
71
+ causal_conv1d_update, causal_conv1d_fn = None, None
72
+
73
+ if is_flash_attn_2_available():
74
+ from transformers.modeling_flash_attention_utils import _flash_attention_forward
75
+
76
+ is_fast_path_available = all(
77
+ (
78
+ selective_state_update,
79
+ mamba_chunk_scan_combined,
80
+ mamba_split_conv1d_scan_combined,
81
+ causal_conv1d_fn,
82
+ causal_conv1d_update,
83
+ )
84
+ )
85
+
86
+
87
+ _CHECKPOINT_FOR_DOC = "nvidia/Nemotron-H-56B-Base-8K"
88
+ _CONFIG_FOR_DOC = "NemotronHConfig"
89
+
90
+
91
+ # Helper methods for segment sum computation
92
+
93
+
94
+ def pad_tensor_by_size(input_tensor: torch.Tensor, pad_size: int):
95
+ """
96
+ Padding x tensor with `pad_size` on the seq_len dim (dim=1)
97
+
98
+ Assumes that we only have tensors of either size 4 or 3
99
+ """
100
+ 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)
101
+
102
+ return torch.nn.functional.pad(input_tensor, pad_shape, mode="constant", value=0)
103
+
104
+
105
+ def reshape_into_chunks(input_tensor, pad_size, chunk_size):
106
+ """
107
+ Padding input_tensor with `pad_size` on the seq_len dim (dim=1) and
108
+ simultaneously splitting it into chunk sequences.
109
+
110
+ Assumes that we only have tensors of either size 4 or 3
111
+ """
112
+ # [bsz, seq_len, ...] -> [bsz, seq_len multiple of chunk_size, ...]
113
+ input_tensor = pad_tensor_by_size(input_tensor, pad_size)
114
+
115
+ if len(input_tensor.shape) == 3:
116
+ # [bsz, seq_len multiple of chunk_size, num_heads] -> [bsz, -1, chunk_size, num_heads]
117
+ return input_tensor.reshape(input_tensor.shape[0], -1, chunk_size, input_tensor.shape[2])
118
+ else:
119
+ # [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]
120
+ return input_tensor.reshape(
121
+ input_tensor.shape[0], -1, chunk_size, input_tensor.shape[2], input_tensor.shape[3]
122
+ )
123
+
124
+
125
+ def segment_sum(input_tensor):
126
+ """
127
+ More stable segment sum calculation. Uses cumulative sums and masking instead of direct subtractions.
128
+ """
129
+ chunk_size = input_tensor.size(-1)
130
+ # 1. expand input tensor to have an additional dimension and repeat along that dimension
131
+ # [..., chunk_size] -> [..., chunk_size, chunk_size]
132
+ input_tensor = input_tensor[..., None].expand(*input_tensor.size(), chunk_size)
133
+ # 2. create a lower triangular mask with the diagonal set to 0 to 0 out elements above diag
134
+ mask = torch.tril(torch.ones(chunk_size, chunk_size, device=input_tensor.device, dtype=torch.bool), diagonal=-1)
135
+ input_tensor = input_tensor.masked_fill(~mask, 0)
136
+ # 3. compute actual cumsum
137
+ tensor_segsum = torch.cumsum(input_tensor, dim=-2)
138
+
139
+ # 4. apply mask to keep only the lower triangular part of the cumulative sum result (incl diagonal this time)
140
+ mask = torch.tril(torch.ones(chunk_size, chunk_size, device=input_tensor.device, dtype=torch.bool), diagonal=0)
141
+ tensor_segsum = tensor_segsum.masked_fill(~mask, -torch.inf)
142
+ return tensor_segsum
143
+
144
+
145
+ def apply_mask_to_padding_states(hidden_states, attention_mask):
146
+ """
147
+ Tunes out the hidden states for padding tokens, see https://github.com/state-spaces/mamba/issues/66
148
+ """
149
+ if attention_mask is not None and attention_mask.shape[1] > 1 and attention_mask.shape[0] > 1:
150
+ dtype = hidden_states.dtype
151
+ hidden_states = (hidden_states * attention_mask[:, :, None]).to(dtype)
152
+
153
+ return hidden_states
154
+
155
+ # Copied from https://github.com/huggingface/transformers/blob/main/src/transformers/models/jamba/modeling_jamba.py
156
+ class HybridMambaAttentionDynamicCache(DynamicCache):
157
+ """
158
+ A dynamic cache that can handle both the attention cache (which has a seq_len dimension) and the mamba cache
159
+ (which has a constant shape regardless of seq_len).
160
+
161
+ This cache has two sets of lists of tensors: `key_cache` and `value_cache` for attention cache and `conv_states`
162
+ and `ssm_states` for mamba cache. Each of these lists has `num_layers` tensors. The expected shape for each tensor
163
+ For attention layers, `key_cache` and `value_cache` have a shape of `(batch_size, num_heads, seq_len, head_dim)`,
164
+ while `conv_states` and `ssm_states` have a shape of `(batch_size, 0)` (empty tensors).
165
+ For mamba layers, `key_cache` and `value_cache` have a shape of `(batch_size, 0)` (empty tensors),
166
+ while `conv_states` represents the convolution state and has a shape of `(batch_size, d_inner, d_conv)`,
167
+ and `ssm_states` represents the ssm state and has a shape of `(batch_size, d_inner, d_state)`.
168
+ """
169
+
170
+ def __init__(self, config, batch_size, dtype=torch.float16, device=None):
171
+ super().__init__()
172
+ self.dtype = dtype
173
+ self.hybrid_override_pattern = config.hybrid_override_pattern
174
+ self.has_previous_state = False # only used by mamba
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
+ elif self.block_type == "moe":
758
+ self.mixer = NemotronHMOE(config, layer_idx=layer_idx)
759
+ else:
760
+ raise ValueError(f"Invalid layer pattern {config.hybrid_override_pattern[layer_idx]}")
761
+
762
+ def forward(
763
+ self,
764
+ hidden_states,
765
+ cache_params: Optional[HybridMambaAttentionDynamicCache] = None,
766
+ cache_position: Optional[torch.LongTensor] = None,
767
+ attention_mask: Optional[torch.Tensor] = None,
768
+ ):
769
+ with torch.cuda.stream(torch.cuda.default_stream(hidden_states.device)):
770
+ # * Use torch.cuda.stream() to avoid NaN issues when using multiple GPUs
771
+ residual = hidden_states
772
+ hidden_states = self.norm(hidden_states.to(dtype=self.norm.weight.dtype))
773
+ if self.residual_in_fp32:
774
+ residual = residual.to(torch.float32)
775
+
776
+ if self.block_type == "mamba":
777
+ hidden_states = self.mixer(
778
+ hidden_states, cache_params=cache_params, cache_position=cache_position
779
+ )
780
+ elif self.block_type == "attention":
781
+ hidden_states = self.mixer(
782
+ hidden_states, cache_position=cache_position
783
+ )
784
+ hidden_states = hidden_states[0]
785
+ elif self.block_type in ["mlp", "moe"]:
786
+ hidden_states = self.mixer(
787
+ hidden_states
788
+ )
789
+ else:
790
+ raise ValueError(f"Invalid block_type: {self.block_type}")
791
+
792
+ hidden_states = residual + hidden_states
793
+ return hidden_states
794
+
795
+
796
+ # Copied from transformers.models.nemotron.modeling_nemotron Nemotron->NemotronH
797
+ class NemotronHMLP(nn.Module):
798
+ def __init__(self, config, intermediate_size=None, layer_idx: Optional[int] = None):
799
+ super().__init__()
800
+ self.config = config
801
+ self.layer_idx = layer_idx
802
+ if layer_idx is None:
803
+ logger.warning_once(
804
+ f"Instantiating {self.__class__.__name__} without passing a `layer_idx` is not recommended and will "
805
+ "lead to errors during the forward call if caching is used. Please make sure to provide a `layer_idx` "
806
+ "when creating this class."
807
+ )
808
+ self.hidden_size = config.hidden_size
809
+ self.intermediate_size = intermediate_size or config.intermediate_size
810
+ self.up_proj = nn.Linear(self.hidden_size, self.intermediate_size, bias=config.mlp_bias)
811
+ self.down_proj = nn.Linear(self.intermediate_size, self.hidden_size, bias=config.mlp_bias)
812
+ self.act_fn = ACT2FN[config.mlp_hidden_act]
813
+
814
+ def forward(self, x):
815
+ return self.down_proj(self.act_fn(self.up_proj(x)))
816
+
817
+
818
+ class NemotronHMOE(nn.Module):
819
+ def __init__(self, config, layer_idx: Optional[int] = None):
820
+ super().__init__()
821
+ self.config = config
822
+ self.experts = nn.ModuleList(
823
+ [
824
+ NemotronHMLP(config, intermediate_size=config.moe_intermediate_size, layer_idx=layer_idx)
825
+ for _ in range(config.n_routed_experts)
826
+ ]
827
+ )
828
+ self.gate = NemotronHTopkRouter(config)
829
+ self.shared_experts = NemotronHMLP(
830
+ config=config, intermediate_size=config.moe_shared_expert_intermediate_size, layer_idx=layer_idx
831
+ )
832
+
833
+ def moe(self, hidden_states: torch.Tensor, topk_indices: torch.Tensor, topk_weights: torch.Tensor):
834
+ r"""
835
+ CALL FOR CONTRIBUTION! I don't have time to optimise this right now, but expert weights need to be fused
836
+ to not have to do a loop here (deepseek has 256 experts soooo yeah).
837
+ """
838
+ final_hidden_states = torch.zeros_like(hidden_states, dtype=topk_weights.dtype)
839
+ expert_mask = torch.nn.functional.one_hot(topk_indices, num_classes=len(self.experts))
840
+ expert_mask = expert_mask.permute(2, 0, 1)
841
+
842
+ for expert_idx in range(len(self.experts)):
843
+ expert = self.experts[expert_idx]
844
+ mask = expert_mask[expert_idx]
845
+ token_indices, weight_indices = torch.where(mask)
846
+
847
+ if token_indices.numel() > 0:
848
+ expert_weights = topk_weights[token_indices, weight_indices]
849
+ expert_input = hidden_states[token_indices]
850
+ expert_output = expert(expert_input)
851
+ weighted_output = expert_output * expert_weights.unsqueeze(-1)
852
+ final_hidden_states.index_add_(0, token_indices, weighted_output)
853
+
854
+ # in original deepseek, the output of the experts are gathered once we leave this module
855
+ # thus the moe module is itelsf an IsolatedParallel module
856
+ # and all expert are "local" meaning we shard but we don't gather
857
+ return final_hidden_states.type(hidden_states.dtype)
858
+
859
+ def forward(self, hidden_states):
860
+ residuals = hidden_states
861
+ orig_shape = hidden_states.shape
862
+ topk_indices, topk_weights = self.gate(hidden_states)
863
+ hidden_states = hidden_states.view(-1, hidden_states.shape[-1])
864
+ hidden_states = self.moe(hidden_states, topk_indices, topk_weights).view(*orig_shape)
865
+ hidden_states = hidden_states + self.shared_experts(residuals)
866
+ return hidden_states
867
+
868
+
869
+ class NemotronHTopkRouter(nn.Module):
870
+ def __init__(self, config):
871
+ super().__init__()
872
+ self.config = config
873
+ self.top_k = config.num_experts_per_tok
874
+ self.n_routed_experts = config.n_routed_experts
875
+ self.routed_scaling_factor = config.routed_scaling_factor
876
+ self.n_group = config.n_group
877
+ self.topk_group = config.topk_group
878
+ self.norm_topk_prob = config.norm_topk_prob
879
+
880
+ self.weight = nn.Parameter(torch.empty((self.n_routed_experts, config.hidden_size), dtype=torch.float32))
881
+ self.register_buffer("e_score_correction_bias", torch.zeros(self.n_routed_experts, dtype=torch.float32))
882
+
883
+ @torch.no_grad()
884
+ def get_topk_indices(self, scores):
885
+ scores_for_choice = scores.view(-1, self.n_routed_experts) + self.e_score_correction_bias.unsqueeze(0)
886
+ group_scores = (
887
+ scores_for_choice.view(-1, self.n_group, self.n_routed_experts // self.n_group)
888
+ .topk(2, dim=-1)[0]
889
+ .sum(dim=-1)
890
+ )
891
+ group_idx = torch.topk(group_scores, k=self.topk_group, dim=-1, sorted=False)[1]
892
+ group_mask = torch.zeros_like(group_scores)
893
+ group_mask.scatter_(1, group_idx, 1)
894
+ score_mask = (
895
+ group_mask.unsqueeze(-1)
896
+ .expand(-1, self.n_group, self.n_routed_experts // self.n_group)
897
+ .reshape(-1, self.n_routed_experts)
898
+ )
899
+ scores_for_choice = scores_for_choice.masked_fill(~score_mask.bool(), 0.0)
900
+ topk_indices = torch.topk(scores_for_choice, k=self.top_k, dim=-1, sorted=False)[1]
901
+ return topk_indices
902
+
903
+ def forward(self, hidden_states):
904
+ hidden_states = hidden_states.view(-1, self.config.hidden_size)
905
+ router_logits = F.linear(hidden_states.type(torch.float32), self.weight.type(torch.float32))
906
+ scores = router_logits.sigmoid()
907
+ topk_indices = self.get_topk_indices(scores)
908
+ topk_weights = scores.gather(1, topk_indices)
909
+ if self.norm_topk_prob:
910
+ denominator = topk_weights.sum(dim=-1, keepdim=True) + 1e-20
911
+ topk_weights /= denominator
912
+ topk_weights = topk_weights * self.routed_scaling_factor
913
+ return topk_indices, topk_weights
914
+
915
+ # Copied from transformers.models.llama.modeling_llama.repeat_kv
916
+ def repeat_kv(hidden_states: torch.Tensor, n_rep: int) -> torch.Tensor:
917
+ """
918
+ This is the equivalent of torch.repeat_interleave(x, dim=1, repeats=n_rep). The hidden states go from (batch,
919
+ num_key_value_heads, seqlen, head_dim) to (batch, num_attention_heads, seqlen, head_dim)
920
+ """
921
+ batch, num_key_value_heads, slen, head_dim = hidden_states.shape
922
+ if n_rep == 1:
923
+ return hidden_states
924
+ hidden_states = hidden_states[:, :, None, :, :].expand(batch, num_key_value_heads, n_rep, slen, head_dim)
925
+ return hidden_states.reshape(batch, num_key_value_heads * n_rep, slen, head_dim)
926
+
927
+
928
+ class NemotronHAttention(nn.Module):
929
+ """Multi-headed attention from 'Attention Is All You Need' paper"""
930
+
931
+ def __init__(self, config: NemotronHConfig, layer_idx: Optional[int] = None):
932
+ super().__init__()
933
+ self.config = config
934
+ self.layer_idx = layer_idx
935
+ if layer_idx is None:
936
+ logger.warning_once(
937
+ f"Instantiating {self.__class__.__name__} without passing a `layer_idx` is not recommended and will "
938
+ "lead to errors during the forward call if caching is used. Please make sure to provide a `layer_idx` "
939
+ "when creating this class."
940
+ )
941
+
942
+ self.attention_dropout = config.attention_dropout
943
+ self.hidden_size = config.hidden_size
944
+ self.num_heads = config.num_attention_heads
945
+ if hasattr(config, "head_dim") and config.head_dim is not None:
946
+ self.head_dim = config.head_dim
947
+ else:
948
+ self.head_dim = config.hidden_size // self.num_attention_heads
949
+ self.num_key_value_heads = config.num_key_value_heads
950
+ self.num_key_value_groups = self.num_heads // self.num_key_value_heads
951
+ self.max_position_embeddings = config.max_position_embeddings
952
+ self.is_causal = True
953
+
954
+ self.q_proj = nn.Linear(self.hidden_size, self.num_heads * self.head_dim, bias=config.attention_bias)
955
+ self.k_proj = nn.Linear(self.hidden_size, self.num_key_value_heads * self.head_dim, bias=config.attention_bias)
956
+ self.v_proj = nn.Linear(self.hidden_size, self.num_key_value_heads * self.head_dim, bias=config.attention_bias)
957
+ self.o_proj = nn.Linear(self.head_dim * self.num_heads, self.hidden_size, bias=config.attention_bias)
958
+
959
+ def forward(
960
+ self,
961
+ hidden_states: torch.Tensor,
962
+ # position_embeddings: Tuple[torch.Tensor, torch.Tensor], #TODO
963
+ attention_mask: Optional[torch.Tensor] = None,
964
+ position_ids: Optional[torch.LongTensor] = None,
965
+ past_key_value: Optional[HybridMambaAttentionDynamicCache] = None,
966
+ output_attentions: bool = False,
967
+ use_cache: bool = False,
968
+ cache_position: Optional[torch.LongTensor] = None,
969
+ ) -> Tuple[torch.Tensor, Optional[torch.Tensor], Optional[Tuple[torch.Tensor]]]:
970
+ bsz, q_len, _ = hidden_states.size()
971
+
972
+ query_states = self.q_proj(hidden_states)
973
+ key_states = self.k_proj(hidden_states)
974
+ value_states = self.v_proj(hidden_states)
975
+
976
+ query_states = query_states.view(bsz, q_len, self.num_heads, self.head_dim).transpose(1, 2)
977
+ key_states = key_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
978
+ value_states = value_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
979
+
980
+ if past_key_value is not None:
981
+ key_states, value_states = past_key_value.update(key_states, value_states, self.layer_idx)
982
+
983
+ key_states = repeat_kv(key_states, self.num_key_value_groups)
984
+ value_states = repeat_kv(value_states, self.num_key_value_groups)
985
+
986
+ causal_mask = attention_mask
987
+ if attention_mask is not None: # no matter the length, we just slice it
988
+ causal_mask = attention_mask[:, :, :, : key_states.shape[-2]]
989
+
990
+ if query_states.device.type == "cuda" and attention_mask is not None:
991
+ query_states = query_states.contiguous()
992
+ key_states = key_states.contiguous()
993
+ value_states = value_states.contiguous()
994
+
995
+ is_causal = True if causal_mask is None and q_len > 1 else False
996
+
997
+ attn_output = torch.nn.functional.scaled_dot_product_attention(
998
+ query_states,
999
+ key_states,
1000
+ value_states,
1001
+ attn_mask=causal_mask,
1002
+ dropout_p=self.attention_dropout if self.training else 0.0,
1003
+ is_causal=is_causal,
1004
+ )
1005
+ attn_output = attn_output.transpose(1, 2).contiguous()
1006
+ #attn_output = attn_output.view(bsz, q_len, self.hidden_size)
1007
+ attn_output = attn_output.view(bsz, q_len, self.num_heads * self.head_dim)
1008
+
1009
+ attn_output = self.o_proj(attn_output)
1010
+
1011
+ return attn_output, None, past_key_value
1012
+
1013
+
1014
+ # Adapted from transformers.models.mistral.modeling_mistral.MistralFlashAttention2 with Mistral->Jamba
1015
+ #class JambaFlashAttention2(JambaAttention):
1016
+ class NemotronHFlashAttention2(NemotronHAttention):
1017
+ """
1018
+ Jamba flash attention module. This module inherits from `JambaAttention` as the weights of the module stays
1019
+ untouched. The only required change would be on the forward pass where it needs to correctly call the public API of
1020
+ flash attention and deal with padding tokens in case the input contains any of them.
1021
+ """
1022
+ def __init__(self, *args, **kwargs):
1023
+ super().__init__(*args, **kwargs)
1024
+
1025
+ # TODO: Should be removed once Flash Attention for RoCm is bumped to 2.1.
1026
+ # 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.
1027
+ # 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).
1028
+ self._flash_attn_uses_top_left_mask = not is_flash_attn_greater_or_equal_2_10()
1029
+
1030
+ def forward(
1031
+ self,
1032
+ hidden_states: torch.Tensor,
1033
+ attention_mask: Optional[torch.Tensor] = None,
1034
+ position_ids: Optional[torch.LongTensor] = None,
1035
+ past_key_value: Optional[HybridMambaAttentionDynamicCache] = None,
1036
+ output_attentions: bool = False,
1037
+ use_cache: bool = False,
1038
+ cache_position: Optional[torch.LongTensor] = None,
1039
+ **kwargs,
1040
+ ):
1041
+ bsz, q_len, _ = hidden_states.size()
1042
+
1043
+ query_states = self.q_proj(hidden_states)
1044
+ key_states = self.k_proj(hidden_states)
1045
+ value_states = self.v_proj(hidden_states)
1046
+
1047
+ # Flash attention requires the input to have the shape
1048
+ # batch_size x seq_length x head_dim x hidden_dim
1049
+ # therefore we just need to keep the original shape
1050
+ query_states = query_states.view(bsz, q_len, self.num_heads, self.head_dim)
1051
+ key_states = key_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
1052
+ value_states = value_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
1053
+
1054
+ if past_key_value is not None:
1055
+ key_states, value_states = past_key_value.update(key_states, value_states, self.layer_idx)
1056
+
1057
+ # repeat k/v heads if n_kv_heads < n_heads
1058
+ key_states = repeat_kv(key_states, self.num_key_value_groups)
1059
+ value_states = repeat_kv(value_states, self.num_key_value_groups)
1060
+ dropout_rate = 0.0 if not self.training else self.attention_dropout
1061
+
1062
+ # In PEFT, usually we cast the layer norms in float32 for training stability reasons
1063
+ # therefore the input hidden states gets silently casted in float32. Hence, we need
1064
+ # cast them back in float16 just to be sure everything works as expected.
1065
+ input_dtype = query_states.dtype
1066
+ if input_dtype == torch.float32:
1067
+ if torch.is_autocast_enabled():
1068
+ target_dtype = torch.get_autocast_gpu_dtype()
1069
+ # Handle the case where the model is quantized
1070
+ elif hasattr(self.config, "_pre_quantization_dtype"):
1071
+ target_dtype = self.config._pre_quantization_dtype
1072
+ else:
1073
+ target_dtype = self.q_proj.weight.dtype
1074
+
1075
+ logger.warning_once(
1076
+ f"The input hidden states seems to be silently casted in float32, this might be related to"
1077
+ f" the fact you have upcasted embedding or layer norm layers in float32. We will cast back the input in"
1078
+ f" {target_dtype}."
1079
+ )
1080
+
1081
+ query_states = query_states.to(target_dtype)
1082
+ key_states = key_states.to(target_dtype)
1083
+ value_states = value_states.to(target_dtype)
1084
+
1085
+ # Reashape to the expected shape for Flash Attention
1086
+ key_states = key_states.transpose(1, 2)
1087
+ value_states = value_states.transpose(1, 2)
1088
+
1089
+ attn_output = _flash_attention_forward(
1090
+ query_states,
1091
+ key_states,
1092
+ value_states,
1093
+ attention_mask,
1094
+ q_len,
1095
+ dropout=dropout_rate,
1096
+ sliding_window=getattr(self.config, "sliding_window", None),
1097
+ is_causal=self.is_causal,
1098
+ use_top_left_mask=self._flash_attn_uses_top_left_mask,
1099
+ )
1100
+
1101
+ #attn_output = attn_output.reshape(bsz, q_len, self.hidden_size).contiguous()
1102
+ attn_output = attn_output.reshape(bsz, q_len, self.num_heads * self.head_dim).contiguous()
1103
+ attn_output = self.o_proj(attn_output)
1104
+
1105
+ if not output_attentions:
1106
+ attn_weights = None
1107
+
1108
+ return attn_output, attn_weights, past_key_value
1109
+
1110
+
1111
+ # Adapted from transformers.models.mistral.modeling_mistral.MistralSdpaAttention with Mistral->Jamba
1112
+ #class JambaSdpaAttention(JambaAttention):
1113
+ class NemotronHSdpaAttention(NemotronHAttention):
1114
+ """
1115
+ Jamba attention module using torch.nn.functional.scaled_dot_product_attention. This module inherits from
1116
+ `JambaAttention` as the weights of the module stays untouched. The only changes are on the forward pass to adapt to
1117
+ SDPA API.
1118
+ """
1119
+
1120
+ # Adapted from NemotronHAttention.forward
1121
+ def forward(
1122
+ self,
1123
+ hidden_states: torch.Tensor,
1124
+ attention_mask: Optional[torch.Tensor] = None,
1125
+ position_ids: Optional[torch.LongTensor] = None,
1126
+ past_key_value: Optional[HybridMambaAttentionDynamicCache] = None,
1127
+ output_attentions: bool = False,
1128
+ use_cache: bool = False,
1129
+ cache_position: Optional[torch.LongTensor] = None,
1130
+ ) -> Tuple[torch.Tensor, Optional[torch.Tensor], Optional[Tuple[torch.Tensor]]]:
1131
+ if output_attentions:
1132
+ # TODO: Improve this warning with e.g. `model.config.attn_implementation = "manual"` once this is implemented.
1133
+ logger.warning_once(
1134
+ "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, "
1135
+ '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.'
1136
+ )
1137
+ return super().forward(
1138
+ hidden_states=hidden_states,
1139
+ attention_mask=attention_mask,
1140
+ position_ids=position_ids,
1141
+ past_key_value=past_key_value,
1142
+ output_attentions=output_attentions,
1143
+ use_cache=use_cache,
1144
+ )
1145
+
1146
+ bsz, q_len, _ = hidden_states.size()
1147
+
1148
+ query_states = self.q_proj(hidden_states)
1149
+ key_states = self.k_proj(hidden_states)
1150
+ value_states = self.v_proj(hidden_states)
1151
+
1152
+ query_states = query_states.view(bsz, q_len, self.num_heads, self.head_dim).transpose(1, 2)
1153
+ key_states = key_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
1154
+ value_states = value_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
1155
+
1156
+ if past_key_value is not None:
1157
+ key_states, value_states = past_key_value.update(key_states, value_states, self.layer_idx)
1158
+
1159
+ key_states = repeat_kv(key_states, self.num_key_value_groups)
1160
+ value_states = repeat_kv(value_states, self.num_key_value_groups)
1161
+
1162
+ causal_mask = attention_mask
1163
+ if attention_mask is not None:
1164
+ causal_mask = causal_mask[:, :, :, : key_states.shape[-2]]
1165
+
1166
+ # SDPA with memory-efficient backend is currently (torch==2.1.2) bugged with non-contiguous inputs with custom attn_mask,
1167
+ # Reference: https://github.com/pytorch/pytorch/issues/112577.
1168
+ if query_states.device.type == "cuda" and attention_mask is not None:
1169
+ query_states = query_states.contiguous()
1170
+ key_states = key_states.contiguous()
1171
+ value_states = value_states.contiguous()
1172
+
1173
+ # We dispatch to SDPA's Flash Attention or Efficient kernels via this `is_causal` if statement instead of an inline conditional assignment
1174
+ # in SDPA to support both torch.compile's dynamic shapes and full graph options. An inline conditional prevents dynamic shapes from compiling.
1175
+ # 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.
1176
+ is_causal = True if self.is_causal and causal_mask is None and q_len > 1 else False
1177
+
1178
+ attn_output = torch.nn.functional.scaled_dot_product_attention(
1179
+ query_states,
1180
+ key_states,
1181
+ value_states,
1182
+ attn_mask=causal_mask,
1183
+ dropout_p=self.attention_dropout if self.training else 0.0,
1184
+ is_causal=is_causal,
1185
+ )
1186
+
1187
+ attn_output = attn_output.transpose(1, 2).contiguous()
1188
+ attn_output = attn_output.view(bsz, q_len, self.hidden_size)
1189
+
1190
+ attn_output = self.o_proj(attn_output)
1191
+
1192
+ return attn_output, None, past_key_value
1193
+
1194
+
1195
+ NEMOTRONH_ATTENTION_CLASSES = {
1196
+ "eager": NemotronHAttention,
1197
+ "flash_attention_2": NemotronHFlashAttention2,
1198
+ "sdpa": NemotronHSdpaAttention,
1199
+ }
1200
+
1201
+ # Copied from transformers.models.mamba.modeling_mamba2.Mamba2PreTrainedModel
1202
+ class NemotronHPreTrainedModel(PreTrainedModel):
1203
+ """
1204
+ An abstract class to handle weights initialization and a simple interface for downloading and loading pretrained
1205
+ models.
1206
+ """
1207
+
1208
+ config_class = NemotronHConfig
1209
+ base_model_prefix = "backbone"
1210
+ _no_split_modules = ["NemotronHBlock"]
1211
+ supports_gradient_checkpointing = True
1212
+ _is_stateful = True
1213
+
1214
+ def _init_weights(self, module):
1215
+ """Initialize the weights."""
1216
+ if isinstance(module, NemotronHMamba2Mixer):
1217
+ module.A_log._no_weight_decay = True
1218
+ module.D._no_weight_decay = True
1219
+
1220
+ dt = torch.exp(
1221
+ torch.rand(self.config.mamba_num_heads)
1222
+ * (math.log(self.config.time_step_max) - math.log(self.config.time_step_min))
1223
+ + math.log(self.config.time_step_min)
1224
+ ).clamp(min=self.config.time_step_floor)
1225
+
1226
+ # # Inverse of softplus: https://github.com/pytorch/pytorch/issues/72759
1227
+ inv_dt = dt + torch.log(-torch.expm1(-dt))
1228
+ with torch.no_grad():
1229
+ module.dt_bias.copy_(inv_dt)
1230
+ module.dt_bias._no_reinit = True
1231
+
1232
+ if isinstance(module, nn.Linear):
1233
+ if module.bias is not None:
1234
+ if not getattr(module.bias, "_no_reinit", False):
1235
+ nn.init.zeros_(module.bias)
1236
+ elif isinstance(module, nn.Embedding):
1237
+ nn.init.normal_(module.weight, std=self.config.initializer_range)
1238
+
1239
+ # TODO: Check
1240
+ if self.config.rescale_prenorm_residual:
1241
+ # Reinitialize selected weights subject to the OpenAI GPT-2 Paper Scheme:
1242
+ # > A modified initialization which accounts for the accumulation on the residual path with model depth. Scale
1243
+ # > the weights of residual layers at initialization by a factor of 1/√N where N is the # of residual layers.
1244
+ # > -- GPT-2 :: https://openai.com/blog/better-language-models/
1245
+ #
1246
+ # Reference (Megatron-LM): https://github.com/NVIDIA/Megatron-LM/blob/main/megatron/model/gpt_model.py
1247
+ for name, p in module.named_parameters():
1248
+ if name in ["out_proj.weight"]:
1249
+ # Special Scaled Initialization --> There are 2 Layer Norms per Transformer Block
1250
+ # Following Pytorch init, except scale by 1/sqrt(2 * n_layer)
1251
+ # We need to reinit p since this code could be called multiple times
1252
+ # Having just p *= scale would repeatedly scale it down
1253
+ nn.init.kaiming_uniform_(p, a=math.sqrt(5))
1254
+ with torch.no_grad():
1255
+ p /= math.sqrt(self.config.num_hidden_layers)
1256
+
1257
+
1258
+ @dataclass
1259
+ # Copied from transformers.models.mamba.modeling_mamba2.Mamba2Output with MAMBA2->NemotronH,Mamba2->NemotronH
1260
+ class NemotronHOutput(ModelOutput):
1261
+ """
1262
+ Class for the NemotronH model outputs.
1263
+
1264
+ Args:
1265
+ last_hidden_state (`torch.FloatTensor` of shape `(batch_size, sequence_length, hidden_size)`):
1266
+ Sequence of hidden-states at the output of the last layer of the model.
1267
+ cache_params (`HybridMambaAttentionDynamicCache`):
1268
+ The state of the model at the last time step. Can be used in a forward method with the next `input_ids` to
1269
+ avoid providing the old `input_ids`.
1270
+
1271
+ Includes both the State space model state matrices after the selective scan, and the Convolutional states
1272
+ hidden_states (`tuple(torch.FloatTensor)`, *optional*, returned when `output_hidden_states=True` is passed or when `config.output_hidden_states=True`):
1273
+ Tuple of `torch.FloatTensor` (one for the output of the embeddings, if the model has an embedding layer, +
1274
+ one for the output of each layer) of shape `(batch_size, sequence_length, hidden_size)`.
1275
+
1276
+ Hidden-states of the model at the output of each layer plus the optional initial embedding outputs.
1277
+ """
1278
+
1279
+ last_hidden_state: Optional[torch.FloatTensor] = None
1280
+ cache_params: Optional[HybridMambaAttentionDynamicCache] = None
1281
+ hidden_states: Optional[Tuple[torch.FloatTensor]] = None
1282
+ attentions: Optional[Tuple[torch.FloatTensor]] = None
1283
+
1284
+
1285
+ @dataclass
1286
+ # Copied from transformers.models.mamba2.modeling_mamba2.MambaCausalLMOutput with Mamba2->NemotronH
1287
+ class NemotronHCausalLMOutput(ModelOutput):
1288
+ """
1289
+ Base class for causal language model (or autoregressive) outputs.
1290
+
1291
+ Args:
1292
+ loss (`torch.FloatTensor` of shape `(1,)`, *optional*, returned when `labels` is provided):
1293
+ Language modeling loss (for next-token prediction).
1294
+ logits (`torch.FloatTensor` of shape `(batch_size, sequence_length, config.vocab_size)`):
1295
+ Prediction scores of the language modeling head (scores for each vocabulary token before SoftMax).
1296
+ cache_params (`HybridMambaAttentionDynamicCache`):
1297
+ The state of the model at the last time step. Can be used in a forward method with the next `input_ids` to
1298
+ avoid providing the old `input_ids`.
1299
+
1300
+ Includes both the State space model state matrices after the selective scan, and the Convolutional states
1301
+ hidden_states (`tuple(torch.FloatTensor)`, *optional*, returned when `output_hidden_states=True` is passed or when `config.output_hidden_states=True`):
1302
+ Tuple of `torch.FloatTensor` (one for the output of the embeddings, if the model has an embedding layer, +
1303
+ one for the output of each layer) of shape `(batch_size, sequence_length, hidden_size)`.
1304
+
1305
+ Hidden-states of the model at the output of each layer plus the optional initial embedding outputs.
1306
+ """
1307
+
1308
+ loss: Optional[torch.FloatTensor] = None
1309
+ logits: Optional[torch.FloatTensor] = None
1310
+ cache_params: Optional[HybridMambaAttentionDynamicCache] = None
1311
+ hidden_states: Optional[Tuple[torch.FloatTensor]] = None
1312
+ attentions: Optional[Tuple[torch.FloatTensor]] = None
1313
+
1314
+
1315
+ NEMOTRONH_START_DOCSTRING = r"""
1316
+
1317
+ This model inherits from [`PreTrainedModel`]. Check the superclass documentation for the generic methods the
1318
+ library implements for all its model (such as downloading or saving, resizing the input embeddings, pruning heads
1319
+ etc.)
1320
+
1321
+ This model is also a PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) subclass.
1322
+ Use it as a regular PyTorch Module and refer to the PyTorch documentation for all matter related to general usage
1323
+ and behavior.
1324
+
1325
+ Parameters:
1326
+ config ([`NemotronHConfig`]): Model configuration class with all the parameters of the model.
1327
+ Initializing with a config file does not load the weights associated with the model, only the
1328
+ configuration. Check out the [`~PreTrainedModel.from_pretrained`] method to load the model weights.
1329
+ """
1330
+
1331
+ NEMOTRONH_INPUTS_DOCSTRING = r"""
1332
+ Args:
1333
+ input_ids (`torch.LongTensor` of shape `(batch_size, input_ids_length)`, *optional*):
1334
+ Indices of input sequence tokens in the vocabulary.
1335
+
1336
+ If `cache_params.seqlen_offset>0`, only `input_ids` that do not have their past calculated should be passed as
1337
+ `input_ids`.
1338
+
1339
+ Indices can be obtained using [`AutoTokenizer`]. See [`PreTrainedTokenizer.encode`] and
1340
+ [`PreTrainedTokenizer.__call__`] for details.
1341
+
1342
+ [What are input IDs?](../glossary#input-ids)
1343
+ inputs_embeds (`torch.FloatTensor` of shape `(batch_size, sequence_length, hidden_size)`, *optional*):
1344
+ Optionally, instead of passing `input_ids` you can choose to directly pass an embedded representation. This
1345
+ is useful if you want more control over how to convert `input_ids` indices into associated vectors than the
1346
+ model's internal embedding lookup matrix.
1347
+ position_ids (`torch.LongTensor` of shape `(batch_size,)`, *optional*):
1348
+ Indices of positions of each input sequence tokens in the position embeddings.
1349
+ cache_params (`HybridMambaAttentionDynamicCache`, *optional*):
1350
+ If passed along, the model uses the previous state in all the blocks (which will give the output for the
1351
+ `input_ids` provided as if the model add `state_input_ids + input_ids` as context).
1352
+ use_cache (`bool`, *optional*):
1353
+ If set to `True`, the `cache_params` is returned and can be used to quickly generate the next logits.
1354
+ output_attentions (`bool`, *optional*):
1355
+ Whether or not to return the attentions tensors of all attention layers.
1356
+ output_hidden_states (`bool`, *optional*):
1357
+ Whether or not to return the hidden states of all layers. See `hidden_states` under returned tensors for
1358
+ more detail.
1359
+ return_dict (`bool`, *optional*):
1360
+ Whether or not to return a [`~utils.ModelOutput`] instead of a plain tuple.
1361
+ cache_position (`torch.LongTensor` of shape `(batch_size,)`, *optional*):
1362
+ The position of the current input in the cache. This is used to ensure that the cache is correctly updated.
1363
+ If `cache_params` is passed, `cache_position` should also be passed.
1364
+ attention_mask (`torch.FloatTensor` of shape `(batch_size, sequence_length)`, *optional*):
1365
+ Mask to avoid performing attention on padding token indices. Mask values selected in `[0, 1]`:
1366
+
1367
+ - 1 for tokens that are **not masked**,
1368
+ - 0 for tokens that are **masked**.
1369
+
1370
+ [What are attention masks?](../glossary#attention-mask)
1371
+ """
1372
+
1373
+
1374
+ @add_start_docstrings(
1375
+ "The bare NemotronH Model transformer outputting raw hidden-states without any specific head on top.",
1376
+ NEMOTRONH_START_DOCSTRING,
1377
+ )
1378
+ class NemotronHModel(NemotronHPreTrainedModel):
1379
+ def __init__(self, config):
1380
+ super().__init__(config)
1381
+
1382
+ self.embeddings = nn.Embedding(config.vocab_size, config.hidden_size)
1383
+ self.layers = nn.ModuleList([NemotronHBlock(config, layer_idx=idx) for idx in range(config.num_hidden_layers)])
1384
+
1385
+ self.gradient_checkpointing = False
1386
+ self.norm_f = NemotronHRMSNorm(config.hidden_size, eps=config.layer_norm_epsilon)
1387
+ # Initialize weights and apply final processing
1388
+ self._register_load_state_dict_pre_hook(self.load_hook)
1389
+ self.post_init()
1390
+
1391
+ def load_hook(self, state_dict, prefix, *args):
1392
+ for k in state_dict:
1393
+ if "embedding." in k:
1394
+ state_dict[k.replace("embedding.", "embeddings.")] = state_dict.pop(k)
1395
+ break
1396
+
1397
+ def get_input_embeddings(self):
1398
+ return self.embeddings
1399
+
1400
+ def set_input_embeddings(self, new_embeddings):
1401
+ self.embeddings = new_embeddings
1402
+
1403
+ @add_start_docstrings_to_model_forward(NEMOTRONH_INPUTS_DOCSTRING)
1404
+ @add_code_sample_docstrings(
1405
+ checkpoint=_CHECKPOINT_FOR_DOC,
1406
+ output_type=NemotronHOutput,
1407
+ config_class=_CONFIG_FOR_DOC,
1408
+ )
1409
+ def forward(
1410
+ self,
1411
+ input_ids: Optional[torch.LongTensor] = None,
1412
+ inputs_embeds: Optional[torch.LongTensor] = None,
1413
+ position_ids: Optional[torch.LongTensor] = None,
1414
+ cache_params: Optional[HybridMambaAttentionDynamicCache] = None,
1415
+ use_cache: Optional[bool] = None,
1416
+ output_attentions: Optional[bool] = None,
1417
+ output_hidden_states: Optional[bool] = None,
1418
+ return_dict: Optional[bool] = None,
1419
+ cache_position: Optional[torch.LongTensor] = None,
1420
+ attention_mask: Optional[torch.Tensor] = None,
1421
+ **kwargs,
1422
+ ) -> Union[Tuple, NemotronHOutput]:
1423
+ output_attentions = output_attentions if output_attentions is not None else self.config.output_attentions
1424
+ output_hidden_states = (
1425
+ output_hidden_states if output_hidden_states is not None else self.config.output_hidden_states
1426
+ )
1427
+ # use_cache = use_cache if use_cache is not None else self.config.use_cache
1428
+ use_cache = use_cache if use_cache is not None else (self.config.use_cache if not self.training else False)
1429
+
1430
+ return_dict = return_dict if return_dict is not None else self.config.use_return_dict
1431
+
1432
+ if (input_ids is None) ^ (inputs_embeds is not None): # ^ is python for xor
1433
+ raise ValueError("You must specify exactly one of input_ids or inputs_embeds")
1434
+
1435
+ if inputs_embeds is None:
1436
+ inputs_embeds = self.embeddings(input_ids)
1437
+
1438
+ if self.gradient_checkpointing and self.training and use_cache:
1439
+ logger.warning_once(
1440
+ "`use_cache=True` is incompatible with gradient checkpointing. Setting `use_cache=False`."
1441
+ )
1442
+ use_cache = False
1443
+
1444
+ # From zamba_modeling.py
1445
+ if use_cache and cache_params is None:
1446
+ logger.warning_once(
1447
+ "NemotronH requires an initialized `NemotronHHybridDynamicCache` to return a cache. None was "
1448
+ "provided, so no cache will be returned."
1449
+ )
1450
+
1451
+ hidden_states = inputs_embeds
1452
+
1453
+ if cache_position is None:
1454
+ cache_position = torch.arange(hidden_states.shape[1], device=hidden_states.device)
1455
+ if position_ids is None:
1456
+ position_ids = cache_position.unsqueeze(0)
1457
+
1458
+ causal_mask = self._update_causal_mask(attention_mask, inputs_embeds, cache_position)
1459
+ mamba_mask = self._update_mamba_mask(attention_mask, cache_position)
1460
+
1461
+ all_hidden_states = () if output_hidden_states else None
1462
+ all_self_attns = () if output_attentions else None
1463
+ # Until HERE
1464
+
1465
+ for layer_idx, mixer_block in enumerate(self.layers):
1466
+ # Depending on the layer type we opt for 2D base attention mask (Mamba) or 4D causal mask (Attention)
1467
+ if mixer_block.block_type == "mamba":
1468
+ layer_mask = mamba_mask
1469
+ elif mixer_block.block_type == "attention":
1470
+ layer_mask = causal_mask
1471
+ elif mixer_block.block_type in ["mlp", "moe"]:
1472
+ layer_mask = None
1473
+ else:
1474
+ raise ValueError(f"Invalid block_type: {self.block_type}")
1475
+
1476
+ if output_hidden_states:
1477
+ all_hidden_states += (hidden_states,)
1478
+
1479
+ if self.gradient_checkpointing and self.training:
1480
+ hidden_states = self._gradient_checkpointing_func(
1481
+ mixer_block.__call__, hidden_states, cache_params, cache_position, layer_mask
1482
+ )
1483
+ else:
1484
+ hidden_states = mixer_block(
1485
+ hidden_states,
1486
+ cache_params=cache_params,
1487
+ cache_position=cache_position,
1488
+ attention_mask=layer_mask,
1489
+ )
1490
+
1491
+ # TODO: Store attentions
1492
+ # if output_attentions:
1493
+ # if layer_outputs[1] is not None:
1494
+ # # append attentions only of attention layers. Mamba layers return `None` as the attention weights
1495
+ # all_self_attns += (layer_outputs[1],)
1496
+
1497
+ # TODO (Check): should it happen before the forward pass?
1498
+ # if output_hidden_states:
1499
+ # all_hidden_states = all_hidden_states + (hidden_states,)
1500
+
1501
+ hidden_states = self.norm_f(hidden_states)
1502
+
1503
+ if output_hidden_states:
1504
+ all_hidden_states = all_hidden_states + (hidden_states,)
1505
+
1506
+ if not return_dict:
1507
+ return tuple(v for v in [hidden_states, cache_params, all_hidden_states] if v is not None)
1508
+
1509
+ return NemotronHOutput(
1510
+ last_hidden_state=hidden_states,
1511
+ cache_params=cache_params if use_cache else None,
1512
+ hidden_states=all_hidden_states,
1513
+ attentions=all_self_attns,
1514
+ )
1515
+
1516
+ # Copied from transformers.models.jamba.modeling_jamba.JambaModel._update_causal_mask
1517
+ def _update_causal_mask(self, attention_mask, input_tensor, cache_position):
1518
+ if self.config._attn_implementation == "flash_attention_2":
1519
+ if attention_mask is not None and 0.0 in attention_mask:
1520
+ return attention_mask
1521
+ return None
1522
+
1523
+ dtype, device = input_tensor.dtype, input_tensor.device
1524
+ min_dtype = torch.finfo(dtype).min
1525
+ sequence_length = input_tensor.shape[1]
1526
+ target_length = cache_position[-1] + 1
1527
+
1528
+ causal_mask = torch.full((sequence_length, target_length), fill_value=min_dtype, dtype=dtype, device=device)
1529
+ if sequence_length != 1:
1530
+ causal_mask = torch.triu(causal_mask, diagonal=1)
1531
+ causal_mask *= torch.arange(target_length, device=device) > cache_position.reshape(-1, 1)
1532
+ causal_mask = causal_mask[None, None, :, :].expand(input_tensor.shape[0], 1, -1, -1)
1533
+ if attention_mask is not None:
1534
+ causal_mask = causal_mask.clone() # copy to contiguous memory for in-place edit
1535
+ if attention_mask.dim() == 2:
1536
+ mask_length = attention_mask.shape[-1]
1537
+ padding_mask = causal_mask[..., :mask_length].eq(0.0) * attention_mask[:, None, None, :].eq(0.0)
1538
+ causal_mask[..., :mask_length] = causal_mask[..., :mask_length].masked_fill(padding_mask, min_dtype)
1539
+
1540
+ if (
1541
+ self.config._attn_implementation == "sdpa"
1542
+ and attention_mask is not None
1543
+ and attention_mask.device.type == "cuda"
1544
+ ):
1545
+ # Attend to all tokens in fully masked rows in the causal_mask, for example the relevant first rows when
1546
+ # using left padding. This is required by F.scaled_dot_product_attention memory-efficient attention path.
1547
+ # Details: https://github.com/pytorch/pytorch/issues/110213
1548
+ causal_mask = AttentionMaskConverter._unmask_unattended(causal_mask, min_dtype)
1549
+
1550
+ return causal_mask
1551
+
1552
+ def _update_mamba_mask(self, attention_mask, cache_position):
1553
+ """
1554
+ No need for zeroing states when
1555
+ 1. Cached forward
1556
+ 2. Attending to all inputs
1557
+ """
1558
+ mamba_mask = attention_mask
1559
+ if cache_position[0] > 0 or (attention_mask is not None and torch.all(attention_mask == 1)):
1560
+ mamba_mask = None
1561
+ return mamba_mask
1562
+
1563
+
1564
+ @add_start_docstrings(
1565
+ """
1566
+ The NEMOTRONH Model transformer with a language modeling head on top (linear layer with weights not tied to the input
1567
+ embeddings).
1568
+ """,
1569
+ NEMOTRONH_START_DOCSTRING,
1570
+ )
1571
+ class NemotronHForCausalLM(NemotronHPreTrainedModel, GenerationMixin):
1572
+ _tied_weights_keys = ["lm_head.weight"]
1573
+
1574
+ def __init__(self, config):
1575
+ super().__init__(config)
1576
+ self.backbone = NemotronHModel(config)
1577
+ self.vocab_size = config.vocab_size
1578
+ self.lm_head = nn.Linear(config.hidden_size, config.vocab_size, bias=False)
1579
+
1580
+ # Initialize weights and apply final processing
1581
+ self.post_init()
1582
+
1583
+ def get_input_embeddings(self):
1584
+ return self.backbone.get_input_embeddings()
1585
+
1586
+ def set_input_embeddings(self, new_embeddings):
1587
+ return self.backbone.set_input_embeddings(new_embeddings)
1588
+
1589
+ def get_output_embeddings(self):
1590
+ return self.lm_head
1591
+
1592
+ def set_output_embeddings(self, new_embeddings):
1593
+ self.lm_head = new_embeddings
1594
+
1595
+ def get_decoder(self):
1596
+ return self.model
1597
+
1598
+ def set_decoder(self, decoder):
1599
+ self.model = decoder
1600
+
1601
+ def prepare_inputs_for_generation(
1602
+ self,
1603
+ input_ids,
1604
+ past_key_values=None,
1605
+ attention_mask=None,
1606
+ inputs_embeds=None,
1607
+ cache_position=None,
1608
+ position_ids=None,
1609
+ use_cache=True,
1610
+ **kwargs,
1611
+ ):
1612
+ # Copy from https://github.com/huggingface/transformers/blob/main/src/transformers/models/jamba/modeling_jamba.py
1613
+ # Overwitten -- uses `cache_params` as opposed to `past_key_values`
1614
+ empty_past_kv = past_key_values is None
1615
+
1616
+ # If we have cache: let's slice `input_ids` through `cache_position`, to keep only the unprocessed tokens
1617
+ # Exception 1: when passing input_embeds, input_ids may be missing entries
1618
+ # Exception 2: some generation methods do special slicing of input_ids, so we don't need to do it here
1619
+ # Exception 3: with synced GPUs cache_position may go out of bounds, but we only want dummy token in that case.
1620
+ # (we can't check exception 3 while compiling)
1621
+ if not empty_past_kv:
1622
+ if (
1623
+ inputs_embeds is not None # Exception 1
1624
+ or cache_position[-1] >= input_ids.shape[1] # Exception 3
1625
+ ):
1626
+ input_ids = input_ids[:, -cache_position.shape[0] :]
1627
+ elif input_ids.shape[1] != cache_position.shape[0]: # Default case (the "else", a no op, is Exception 2)
1628
+ input_ids = input_ids[:, cache_position]
1629
+ else:
1630
+ past_key_values = HybridMambaAttentionDynamicCache(
1631
+ self.config, input_ids.shape[0], self.dtype, device=self.device
1632
+ )
1633
+
1634
+ if attention_mask is not None and position_ids is None:
1635
+ # create position_ids on the fly for batch generation
1636
+ position_ids = attention_mask.long().cumsum(-1) - 1
1637
+ position_ids.masked_fill_(attention_mask == 0, 1)
1638
+ if not empty_past_kv:
1639
+ position_ids = position_ids[:, -input_ids.shape[1] :]
1640
+
1641
+ # if `inputs_embeds` are passed, we only want to use them in the 1st generation step
1642
+ if inputs_embeds is not None and empty_past_kv:
1643
+ if input_ids is not None and inputs_embeds.shape[1] < input_ids.shape[1]:
1644
+ new_token_embeds = self.get_input_embeddings()(input_ids[:,inputs_embeds.shape[1]:])
1645
+ inputs_embeds = torch.cat([inputs_embeds, new_token_embeds], dim=1)
1646
+ model_inputs = {"inputs_embeds": inputs_embeds}
1647
+ else:
1648
+ model_inputs = {"input_ids": input_ids.contiguous()} # `contiguous()` needed for compilation use cases
1649
+
1650
+ model_inputs.update(
1651
+ {
1652
+ "position_ids": position_ids,
1653
+ "past_key_values": past_key_values,
1654
+ "use_cache": use_cache,
1655
+ "attention_mask": attention_mask,
1656
+ "logits_to_keep": self.config.num_logits_to_keep,
1657
+ "cache_position": cache_position,
1658
+ }
1659
+ )
1660
+ return model_inputs
1661
+
1662
+ @add_start_docstrings_to_model_forward(NEMOTRONH_INPUTS_DOCSTRING)
1663
+ @add_code_sample_docstrings(
1664
+ checkpoint=_CHECKPOINT_FOR_DOC,
1665
+ output_type=NemotronHCausalLMOutput,
1666
+ config_class=_CONFIG_FOR_DOC,
1667
+ )
1668
+ def forward(
1669
+ self,
1670
+ input_ids: Optional[torch.LongTensor] = None,
1671
+ inputs_embeds: Optional[torch.FloatTensor] = None,
1672
+ position_ids: Optional[torch.LongTensor] = None,
1673
+ cache_params: Optional[HybridMambaAttentionDynamicCache] = None,
1674
+ labels: Optional[torch.LongTensor] = None,
1675
+ output_attentions: Optional[bool] = None,
1676
+ output_hidden_states: Optional[bool] = None,
1677
+ return_dict: Optional[bool] = None,
1678
+ use_cache: Optional[bool] = None,
1679
+ cache_position: Optional[torch.Tensor] = None,
1680
+ attention_mask: Optional[torch.Tensor] = None,
1681
+ **kwargs, # for now we need this for generation
1682
+ ) -> Union[Tuple, NemotronHCausalLMOutput]:
1683
+ r"""
1684
+ labels (`torch.LongTensor` of shape `(batch_size, sequence_length)`, *optional*):
1685
+ Labels for language modeling. Note that the labels **are shifted** inside the model, i.e. you can set
1686
+ `labels = input_ids` Indices are selected in `[-100, 0, ..., config.vocab_size]` All labels set to `-100`
1687
+ are ignored (masked), the loss is only computed for labels in `[0, ..., config.vocab_size]`
1688
+ """
1689
+ output_attentions = output_attentions if output_attentions is not None else self.config.output_attentions
1690
+
1691
+ output_hidden_states = (
1692
+ output_hidden_states if output_hidden_states is not None else self.config.output_hidden_states
1693
+ )
1694
+ return_dict = return_dict if return_dict is not None else self.config.use_return_dict
1695
+
1696
+ nemotron_h_outputs = self.backbone(
1697
+ input_ids,
1698
+ cache_params=cache_params,
1699
+ inputs_embeds=inputs_embeds,
1700
+ output_attentions=output_attentions,
1701
+ output_hidden_states=output_hidden_states,
1702
+ return_dict=return_dict,
1703
+ use_cache=use_cache,
1704
+ cache_position=cache_position,
1705
+ attention_mask=attention_mask,
1706
+ )
1707
+ hidden_states = nemotron_h_outputs[0]
1708
+
1709
+ # TODO: Check zamba_modeling.py: https://github.com/huggingface/transformers/blob/d7188ba600e36d3fd191b12e19f1b3bb81a8404f/src/transformers/models/zamba/modeling_zamba.py#L1284C1-L1286C2
1710
+ #logits = self.lm_head(hidden_states.to(self.lm_head.weight.dtype)).float()
1711
+ logits = self.lm_head(hidden_states.to(self.lm_head.weight.dtype)).float()
1712
+
1713
+ loss = None
1714
+ if labels is not None:
1715
+ # move labels to correct device to enable model parallelism
1716
+ labels = labels.to(logits.device)
1717
+ # Shift so that tokens < n predict n
1718
+ shift_logits = logits[..., :-1, :].contiguous()
1719
+ shift_labels = labels[..., 1:].contiguous()
1720
+ # Flatten the tokens
1721
+ loss_fct = CrossEntropyLoss()
1722
+ loss = loss_fct(shift_logits.view(-1, shift_logits.size(-1)), shift_labels.view(-1))
1723
+
1724
+ if not return_dict:
1725
+ output = (logits,) + nemotron_h_outputs[1:]
1726
+ return ((loss,) + output) if loss is not None else output
1727
+
1728
+ return NemotronHCausalLMOutput(
1729
+ loss=loss,
1730
+ logits=logits,
1731
+ cache_params=nemotron_h_outputs.cache_params,
1732
+ hidden_states=nemotron_h_outputs.hidden_states,
1733
+ attentions=nemotron_h_outputs.attentions,
1734
+ )
preprocessor_config.json ADDED
@@ -0,0 +1,15 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "image_processor_type": "NemotronH_Nano_Omni_Reasoning_V3ImageProcessor",
3
+ "auto_map": {
4
+ "AutoImageProcessor": "image_processing.NemotronH_Nano_Omni_Reasoning_V3ImageProcessor",
5
+ "AutoVideoProcessor": "video_processing.NemotronH_Nano_Omni_Reasoning_V3VideoProcessor",
6
+ "AutoProcessor": "processing.NemotronH_Nano_Omni_Reasoning_V3Processor"
7
+ },
8
+ "image_size": 512,
9
+ "patch_size": 16,
10
+ "downsample_ratio": 0.5,
11
+ "max_num_tiles": 12,
12
+ "use_thumbnail": true,
13
+ "norm_mean": [0.48145466, 0.4578275, 0.40821073],
14
+ "norm_std": [0.26862954, 0.26130258, 0.27577711]
15
+ }
processing.py ADDED
@@ -0,0 +1,433 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+ from typing import Optional, Union, List
15
+ import math
16
+ import numpy as np
17
+ import torch
18
+
19
+ from transformers.feature_extraction_utils import BatchFeature
20
+ from transformers.image_utils import ImageInput
21
+ from transformers.processing_utils import ImagesKwargs, MultiModalData, ProcessingKwargs, ProcessorMixin, Unpack, VideosKwargs
22
+ from transformers.tokenization_utils_base import PreTokenizedInput, TextInput
23
+ from transformers.video_utils import VideoInput
24
+
25
+ # Audio input type - can be file paths, numpy arrays, or torch tensors
26
+ AudioInput = Union[str, np.ndarray, torch.Tensor, List[str], List[np.ndarray], List[torch.Tensor]]
27
+
28
+
29
+ class NemotronH_Nano_Omni_Reasoning_V3ImagesKwargs(ImagesKwargs):
30
+ min_pixels: Optional[int]
31
+ max_pixels: Optional[int]
32
+ patch_size: Optional[int]
33
+ temporal_patch_size: Optional[int]
34
+ merge_size: Optional[int]
35
+
36
+
37
+ class NemotronH_Nano_Omni_Reasoning_V3AudioKwargs(ProcessingKwargs, total=False):
38
+ sampling_rate: Optional[int]
39
+
40
+
41
+ class NemotronH_Nano_Omni_Reasoning_V3ProcessorKwargs(ProcessingKwargs, total=False):
42
+ images_kwargs: NemotronH_Nano_Omni_Reasoning_V3ImagesKwargs
43
+ videos_kwargs: VideosKwargs
44
+ audio_kwargs: NemotronH_Nano_Omni_Reasoning_V3AudioKwargs
45
+ _defaults = {
46
+ "text_kwargs": {
47
+ "padding": False,
48
+ },
49
+ }
50
+
51
+
52
+ class NemotronH_Nano_Omni_Reasoning_V3Processor(ProcessorMixin):
53
+ r"""
54
+ Constructs a Nemotron-3-Nano-Omni-30B-A3B-Reasoning processor which wraps an image processor, audio feature extractor,
55
+ and a tokenizer into a single processor.
56
+ [`NemotronH_Nano_Omni_Reasoning_V3Processor`] offers all the functionalities of the image processor, audio processor,
57
+ and tokenizer. See the [`~NemotronH_Nano_Omni_Reasoning_V3Processor.__call__`] and [`~NemotronH_Nano_Omni_Reasoning_V3Processor.decode`]
58
+ for more information.
59
+ Args:
60
+ image_processor ([`AutoImageProcessor`], *optional*):
61
+ The image processor is a required input.
62
+ tokenizer ([`AutoTokenizer`], *optional*):
63
+ The tokenizer is a required input.
64
+ chat_template (`str`, *optional*): A Jinja template which will be used to convert lists of messages
65
+ in a chat into a tokenizable string.
66
+ audio_sampling_rate (`int`, *optional*): Sampling rate for audio processing (default: 16000).
67
+ audio_subsampling_factor (`int`, *optional*): Subsampling factor for audio encoder (default: 8).
68
+ audio_hop_length (`int`, *optional*): Hop length in samples for feature extraction (default: 160).
69
+ """
70
+
71
+ attributes = ["image_processor", "tokenizer"]
72
+
73
+ image_processor_class = "AutoImageProcessor"
74
+ video_processor_class = "AutoVideoProcessor"
75
+ tokenizer_class = ("AutoTokenizer")
76
+
77
+ def __init__(
78
+ self,
79
+ image_processor=None,
80
+ tokenizer=None,
81
+ chat_template=None,
82
+ audio_sampling_rate: int = 16000,
83
+ audio_subsampling_factor: int = 8,
84
+ audio_hop_length: int = 160,
85
+ **kwargs
86
+ ):
87
+ self.image_token = "<image>" if not hasattr(tokenizer, "image_token") else tokenizer.image_token
88
+ self.video_token = "<video>" if not hasattr(tokenizer, "video_token") else tokenizer.video_token
89
+ self.audio_token = "<so_embedding>" if not hasattr(tokenizer, "audio_token") else tokenizer.audio_token
90
+ self.image_start_token = "<img>" if not hasattr(tokenizer, "image_start_token") else tokenizer.image_start_token
91
+ self.image_end_token = "</img>" if not hasattr(tokenizer, "image_end_token") else tokenizer.image_end_token
92
+ self.image_token_id = (
93
+ tokenizer.image_token_id
94
+ if getattr(tokenizer, "image_token_id", None)
95
+ else tokenizer.convert_tokens_to_ids(self.image_token)
96
+ )
97
+ self.video_token_id = (
98
+ tokenizer.video_token_id
99
+ if getattr(tokenizer, "video_token_id", None)
100
+ else tokenizer.convert_tokens_to_ids(self.video_token)
101
+ )
102
+ self.audio_token_id = (
103
+ tokenizer.audio_token_id
104
+ if getattr(tokenizer, "audio_token_id", None)
105
+ else tokenizer.convert_tokens_to_ids(self.audio_token)
106
+ )
107
+
108
+ # Audio processing parameters
109
+ self.audio_sampling_rate = audio_sampling_rate
110
+ self.audio_subsampling_factor = audio_subsampling_factor
111
+ self.audio_hop_length = audio_hop_length
112
+
113
+ super().__init__(image_processor, tokenizer, chat_template=chat_template)
114
+
115
+ def __call__(
116
+ self,
117
+ images: ImageInput = None,
118
+ text: Union[TextInput, PreTokenizedInput, List[TextInput], List[PreTokenizedInput]] = None,
119
+ videos: VideoInput = None,
120
+ audio: AudioInput = None,
121
+ **kwargs: Unpack[NemotronH_Nano_Omni_Reasoning_V3ProcessorKwargs],
122
+ ) -> BatchFeature:
123
+ """
124
+ Main method to prepare multimodal inputs (text, images, videos, audio) for the model. This method processes
125
+ text by replacing image/video/audio tokens with appropriate placeholder sequences, processes images and videos
126
+ through the image processor, and tokenizes the final text.
127
+
128
+ The method performs the following key operations:
129
+ 1. Processes images using the image processor to get pixel values and patch counts
130
+ 2. Processes videos using the image processor with max_num_tiles=1 to get video pixel values
131
+ 3. Processes audio to compute the number of audio tokens based on duration
132
+ 4. Replaces `<image>` tokens in text with `<img>` + image tokens + `</img>` sequences
133
+ 5. Replaces `<video>` tokens in text with frame-by-frame descriptions including timestamps (if metadata provided)
134
+ 6. Replaces `<audio>` tokens in text with repeated audio tokens based on duration
135
+ 7. Tokenizes the processed text and combines all outputs
136
+
137
+ Args:
138
+ images (`PIL.Image.Image`, `np.ndarray`, `torch.Tensor`, `List[PIL.Image.Image]`, `List[np.ndarray]`, `List[torch.Tensor]`, *optional*):
139
+ The image or batch of images to be prepared. Each image can be a PIL image, NumPy array or PyTorch
140
+ tensor. Both channels-first and channels-last formats are supported.
141
+ text (`str`, `List[str]`, *optional*):
142
+ The sequence or batch of sequences to be encoded. Each sequence should be a string. The text can contain
143
+ special tokens `<image>`, `<video>`, and `<audio>` that will be replaced with appropriate token sequences.
144
+ videos (`np.ndarray`, `torch.Tensor`, `List[np.ndarray]`, `List[torch.Tensor]`, *optional*):
145
+ The video or batch of videos to be prepared. Each video should be a 4D NumPy array or PyTorch
146
+ tensor with shape (num_frames, channels, height, width). Both channels-first and channels-last formats
147
+ are supported. Note: Currently only supports batch size of 1 for videos.
148
+ audio (`str`, `np.ndarray`, `torch.Tensor`, `List[str]`, `List[np.ndarray]`, `List[torch.Tensor]`, *optional*):
149
+ The audio or batch of audio clips to be prepared. Can be file paths, numpy arrays (waveforms),
150
+ or torch tensors. Waveforms should be 1D arrays at the expected sampling rate.
151
+ images_kwargs (`Dict`, *optional*):
152
+ Additional keyword arguments for image processing, including:
153
+ - `min_pixels` (`int`, *optional*): Minimum number of pixels for image processing
154
+ - `max_pixels` (`int`, *optional*): Maximum number of pixels for image processing
155
+ - `patch_size` (`int`, *optional*): Size of patches for image processing
156
+ - `temporal_patch_size` (`int`, *optional*): Size of temporal patches
157
+ - `merge_size` (`int`, *optional*): Size for merging patches
158
+ videos_kwargs (`Dict`, *optional*):
159
+ Additional keyword arguments for video processing, including:
160
+ - `video_metadata` (`VideoMetadata`, *optional*): Metadata containing fps information for timestamp calculation
161
+ audio_kwargs (`Dict`, *optional*):
162
+ Additional keyword arguments for audio processing, including:
163
+ - `sampling_rate` (`int`, *optional*): Target sampling rate for audio
164
+ text_kwargs (`Dict`, *optional*):
165
+ Additional keyword arguments for text tokenization, including:
166
+ - `return_tensors` (`str` or [`~utils.TensorType`], *optional*): Framework for returned tensors ('tf', 'pt', 'np', 'jax')
167
+ - `padding` (`bool`, *optional*): Whether to pad sequences (defaults to False)
168
+
169
+ Returns:
170
+ [`BatchFeature`]: A [`BatchFeature`] with the following fields:
171
+
172
+ - **input_ids** -- List of token ids to be fed to a model. Returned when `text` is not `None`.
173
+ - **attention_mask** -- List of indices specifying which tokens should be attended to by the model (when
174
+ `return_attention_mask=True` or if *"attention_mask"* is in `self.model_input_names` and if `text` is not
175
+ `None`).
176
+ - **pixel_values** -- Pixel values to be fed to a model. Returned when `images` is not `None`.
177
+ - **num_patches** -- Number of patches per image. Returned when `images` is not `None`.
178
+ - **pixel_values_videos** -- Pixel values of videos to be fed to a model. Returned when `videos` is not `None`.
179
+ - **sound_clips** -- Raw audio waveforms to be fed to a model. Returned when `audio` is not `None`.
180
+
181
+ Raises:
182
+ AssertionError: If videos are provided with batch size > 1 (not currently supported).
183
+
184
+ Note:
185
+ - Image tokens `<image>` in text are replaced with `<img>` + repeated image tokens + `</img>`
186
+ - Video tokens `<video>` in text are replaced with frame-by-frame descriptions
187
+ - Audio tokens `<audio>` in text are replaced with repeated audio placeholder tokens
188
+ - When video metadata with fps is provided, frame descriptions include timestamps
189
+ - Videos are processed with max_num_tiles=1 regardless of the images setting
190
+ """
191
+ output_kwargs = self._merge_kwargs(
192
+ NemotronH_Nano_Omni_Reasoning_V3ProcessorKwargs,
193
+ tokenizer_init_kwargs=self.tokenizer.init_kwargs,
194
+ **kwargs,
195
+ )
196
+ image_inputs = videos_inputs = audio_inputs = {}
197
+
198
+ if images is not None:
199
+ image_inputs = self.image_processor(images=images, **output_kwargs["images_kwargs"])
200
+ image_num_patches = image_inputs["num_patches"]
201
+
202
+ if videos is not None:
203
+ orig_tiles = self.image_processor.max_num_tiles
204
+ self.image_processor.max_num_tiles = 1
205
+ videos_inputs = self.image_processor(images=videos, **output_kwargs["images_kwargs"])
206
+ self.image_processor.max_num_tiles = orig_tiles
207
+ video_num_patches = [sum(videos_inputs["num_patches"])]
208
+ videos_inputs["pixel_values_videos"] = videos_inputs["pixel_values"]
209
+ del videos_inputs["pixel_values"]
210
+
211
+ # Process audio inputs
212
+ audio_num_tokens = []
213
+ if audio is not None:
214
+ audio_clips, audio_num_tokens = self._process_audio(audio, output_kwargs.get("audio_kwargs", {}))
215
+ # Keep as list of numpy arrays - don't let BatchFeature convert to tensor
216
+ # The model's generate function will handle conversion
217
+ audio_inputs["sound_clips"] = audio_clips
218
+
219
+ if not isinstance(text, list):
220
+ text = [text]
221
+
222
+ text = text.copy() # below lines change text in-place
223
+ if images is not None:
224
+ index = 0
225
+ for i in range(len(text)):
226
+ while self.image_token in text[i]:
227
+ text[i] = text[i].replace(self.image_token, self.image_start_token + "<|placeholder|>" * image_num_patches[index] * self.image_processor.num_image_token + self.image_end_token, 1)
228
+ index += 1
229
+ text[i] = text[i].replace("<|placeholder|>", self.image_token)
230
+
231
+ if videos is not None:
232
+ assert len(text) == 1, "Video is not supported for batch size > 1"
233
+ video_metadata = output_kwargs.get("videos_kwargs", {}).get("video_metadata", None)
234
+ i = 0
235
+ index = 0
236
+ if self.video_token in text[i]:
237
+ each_frame = self.image_start_token + "<|placeholder|>" * self.image_processor.num_image_token + self.image_end_token
238
+ video_prompt = "This is a video:\n"
239
+ for j in range(video_num_patches[index]):
240
+ if video_metadata is not None and video_metadata.fps is not None:
241
+ timestamp = j / video_metadata.fps
242
+ video_prompt += f"Frame {j+1} sampled at {timestamp:.2f} seconds: {each_frame}\n"
243
+ else:
244
+ # Fallback to original format without timestamps
245
+ video_prompt += f"Frame {j+1}: {each_frame}\n"
246
+
247
+ text[i] = text[i].replace(self.video_token, video_prompt, 1)
248
+ text[i] = text[i].replace("<|placeholder|>", self.video_token)
249
+
250
+ # Replace audio tokens with the correct number of placeholder tokens
251
+ if audio is not None:
252
+ assert len(text) == 1, "Audio is not supported for batch size > 1"
253
+ index = 0
254
+ for i in range(len(text)):
255
+ while self.audio_token in text[i]:
256
+ num_tokens = audio_num_tokens[index] if index < len(audio_num_tokens) else 1
257
+ # Replace <audio> with repeated audio tokens
258
+ text[i] = text[i].replace(self.audio_token, "<|audio_placeholder|>" * num_tokens, 1)
259
+ index += 1
260
+ text[i] = text[i].replace("<|audio_placeholder|>", self.audio_token)
261
+
262
+ return_tensors = output_kwargs["text_kwargs"].pop("return_tensors", None)
263
+ text_inputs = self.tokenizer(text, **output_kwargs["text_kwargs"])
264
+
265
+ # Build output - exclude audio from tensor conversion since it's raw waveforms
266
+ output_data = {**text_inputs, **image_inputs, **videos_inputs}
267
+ result = BatchFeature(data=output_data, tensor_type=return_tensors)
268
+
269
+ # Add audio clips separately (as list of numpy arrays, not tensors)
270
+ if audio_inputs:
271
+ result["sound_clips"] = audio_inputs["sound_clips"]
272
+
273
+ return result
274
+
275
+ def _process_audio(
276
+ self,
277
+ audio: AudioInput,
278
+ audio_kwargs: dict
279
+ ) -> tuple:
280
+ """Process audio inputs and compute the number of audio tokens.
281
+
282
+ Args:
283
+ audio: Audio input (file path, waveform array, or list thereof)
284
+ audio_kwargs: Additional audio processing arguments
285
+
286
+ Returns:
287
+ Tuple of (audio_clips, num_tokens_per_clip)
288
+ """
289
+ # Get sampling rate from kwargs or use default
290
+ sampling_rate = audio_kwargs.get("sampling_rate", self.audio_sampling_rate)
291
+
292
+ # Normalize audio to list
293
+ if not isinstance(audio, list):
294
+ audio = [audio]
295
+
296
+ audio_clips = []
297
+ num_tokens = []
298
+
299
+ for audio_item in audio:
300
+ # Load audio if it's a file path
301
+ if isinstance(audio_item, str):
302
+ waveform = self._load_audio(audio_item, sampling_rate)
303
+ elif isinstance(audio_item, torch.Tensor):
304
+ waveform = audio_item.numpy() if audio_item.dim() == 1 else audio_item.squeeze().numpy()
305
+ elif isinstance(audio_item, np.ndarray):
306
+ waveform = audio_item.squeeze() if audio_item.ndim > 1 else audio_item
307
+ else:
308
+ raise ValueError(f"Unsupported audio type: {type(audio_item)}")
309
+
310
+ audio_clips.append(waveform)
311
+
312
+ # Estimate number of audio tokens based on waveform length
313
+ # num_frames ≈ audio_samples / hop_length
314
+ # num_tokens = num_frames / subsampling_factor
315
+ num_frames = len(waveform) // self.audio_hop_length
316
+ n_tokens = math.ceil(num_frames / self.audio_subsampling_factor)
317
+ num_tokens.append(max(1, n_tokens)) # At least 1 token
318
+
319
+ return audio_clips, num_tokens
320
+
321
+ def _load_audio(self, audio_path: str, target_sr: int) -> np.ndarray:
322
+ """Load audio from file and resample if necessary.
323
+
324
+ Args:
325
+ audio_path: Path to audio file
326
+ target_sr: Target sampling rate
327
+
328
+ Returns:
329
+ Audio waveform as numpy array
330
+ """
331
+ try:
332
+ import librosa
333
+ waveform, sr = librosa.load(audio_path, sr=target_sr, mono=True)
334
+ return waveform
335
+ except ImportError:
336
+ pass
337
+
338
+ try:
339
+ import soundfile as sf
340
+ waveform, sr = sf.read(audio_path)
341
+ if waveform.ndim > 1:
342
+ waveform = waveform.mean(axis=1) # Convert to mono
343
+ if sr != target_sr:
344
+ # Simple resampling using numpy
345
+ import scipy.signal
346
+ num_samples = int(len(waveform) * target_sr / sr)
347
+ waveform = scipy.signal.resample(waveform, num_samples)
348
+ return waveform.astype(np.float32)
349
+ except ImportError:
350
+ pass
351
+
352
+ raise ImportError(
353
+ "Audio loading requires either librosa or soundfile. "
354
+ "Install with: pip install librosa soundfile"
355
+ )
356
+
357
+ def _get_num_multimodal_tokens(self, image_sizes=None, video_sizes=None, **kwargs):
358
+ """
359
+ Computes the number of placeholder tokens needed for multimodal inputs with the given sizes.
360
+ Args:
361
+ image_sizes (`list[list[int]]`, *optional*):
362
+ The input sizes formatted as (height, width) per each image.
363
+ video_sizes (`list[list[int]]`, *optional*):
364
+ The input sizes formatted as (num_frames, height, width) per each video.
365
+ Returns:
366
+ `MultiModalData`: A `MultiModalData` object holding number of tokens per each of the provided
367
+ input modalities, along with other useful data.
368
+ """
369
+
370
+ vision_data = {}
371
+ if image_sizes is not None:
372
+ images_kwargs = NemotronH_Nano_Omni_Reasoning_V3ProcessorKwargs._defaults.get("images_kwargs", {})
373
+ images_kwargs.update(kwargs)
374
+ merge_size = images_kwargs.get("merge_size", None) or self.image_processor.merge_size
375
+
376
+ num_image_patches = [
377
+ self.image_processor.get_number_of_image_patches(*image_size, images_kwargs)
378
+ for image_size in image_sizes
379
+ ]
380
+ num_image_tokens = [(num_patches // merge_size**2) for num_patches in num_image_patches]
381
+ vision_data.update({"num_image_tokens": num_image_tokens, "num_image_patches": num_image_patches})
382
+ return MultiModalData(**vision_data)
383
+
384
+ def batch_decode(self, *args, **kwargs):
385
+ """
386
+ This method forwards all its arguments to the tokenizer's [`~PreTrainedTokenizer.batch_decode`]. Please
387
+ refer to the docstring of this method for more information.
388
+ """
389
+ return self.tokenizer.batch_decode(*args, **kwargs)
390
+
391
+ def decode(self, *args, **kwargs):
392
+ """
393
+ This method forwards all its arguments to the tokenizer's [`~PreTrainedTokenizer.decode`]. Please refer to
394
+ the docstring of this method for more information.
395
+ """
396
+ return self.tokenizer.decode(*args, **kwargs)
397
+
398
+ def post_process_image_text_to_text(
399
+ self, generated_outputs, skip_special_tokens=True, clean_up_tokenization_spaces=False, **kwargs
400
+ ):
401
+ """
402
+ Post-process the output of the model to decode the text.
403
+
404
+ Args:
405
+ generated_outputs (`torch.Tensor` or `np.ndarray`):
406
+ The output of the model `generate` function. The output is expected to be a tensor of shape `(batch_size, sequence_length)`
407
+ or `(sequence_length,)`.
408
+ skip_special_tokens (`bool`, *optional*, defaults to `True`):
409
+ Whether or not to remove special tokens in the output. Argument passed to the tokenizer's `batch_decode` method.
410
+ clean_up_tokenization_spaces (`bool`, *optional*, defaults to `False`):
411
+ Whether or not to clean up the tokenization spaces. Argument passed to the tokenizer's `batch_decode` method.
412
+ **kwargs:
413
+ Additional arguments to be passed to the tokenizer's `batch_decode method`.
414
+
415
+ Returns:
416
+ `list[str]`: The decoded text.
417
+ """
418
+ return self.tokenizer.batch_decode(
419
+ generated_outputs,
420
+ skip_special_tokens=skip_special_tokens,
421
+ clean_up_tokenization_spaces=clean_up_tokenization_spaces,
422
+ **kwargs,
423
+ )
424
+
425
+ @property
426
+ def model_input_names(self):
427
+ tokenizer_input_names = self.tokenizer.model_input_names
428
+ image_processor_input_names = self.image_processor.model_input_names
429
+ names_from_processor = list(dict.fromkeys(tokenizer_input_names + image_processor_input_names))
430
+ return names_from_processor + ["second_per_grid_ts"]
431
+
432
+
433
+ __all__ = ["NemotronH_Nano_Omni_Reasoning_V3Processor"]
processing_utils.py ADDED
@@ -0,0 +1,83 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ from typing import List, Optional, Union, Any, Dict
2
+
3
+ from PIL import Image
4
+ import torch
5
+ from transformers.image_processing_base import BatchFeature
6
+ from transformers.image_processing_utils_fast import BaseImageProcessorFast, divide_to_patches
7
+ from transformers.image_utils import (make_list_of_images, get_image_size,
8
+ get_image_type, ImageInput, ImageType, ChannelDimension)
9
+ from transformers.utils import TensorType
10
+ import torchvision.transforms as T
11
+
12
+
13
+ def get_internvl_target_ratios(
14
+ min_num: int,
15
+ max_num: int,
16
+ ) -> list[tuple[int, int]]:
17
+ target_ratios = {(i, j)
18
+ for n in range(min_num, max_num + 1)
19
+ for i in range(1, n + 1)
20
+ for j in range(1, n + 1) if min_num <= i * j <= max_num}
21
+ return sorted(target_ratios, key=lambda x: x[0] * x[1])
22
+
23
+
24
+ def find_closest_aspect_ratio(aspect_ratio, target_ratios, width, height, image_size):
25
+ best_factor = float('-inf')
26
+ best_ratio = (1, 1)
27
+ area = width * height
28
+ for ratio in target_ratios:
29
+ target_aspect_ratio = ratio[0] / ratio[1]
30
+ factor_based_on_area_n_ratio = min(
31
+ (ratio[0]*ratio[1]*image_size*image_size)/ area, 0.6
32
+ )* min(
33
+ target_aspect_ratio/aspect_ratio, aspect_ratio/target_aspect_ratio)
34
+ if factor_based_on_area_n_ratio > best_factor:
35
+ best_factor = factor_based_on_area_n_ratio
36
+ best_ratio = ratio
37
+ return best_ratio
38
+
39
+
40
+ def calculate_targets(
41
+ orig_width: int,
42
+ orig_height: int,
43
+ target_ratios: list[tuple[int, int]],
44
+ image_size: int,
45
+ ) -> tuple[int, int, int]:
46
+ aspect_ratio = orig_width / orig_height
47
+
48
+ # find the closest aspect ratio to the target
49
+ target_aspect_ratio = find_closest_aspect_ratio(
50
+ aspect_ratio,
51
+ target_ratios,
52
+ width=orig_width,
53
+ height=orig_height,
54
+ image_size=image_size,
55
+ )
56
+
57
+ # calculate the target width and height
58
+ target_width = image_size * target_aspect_ratio[0]
59
+ target_height = image_size * target_aspect_ratio[1]
60
+ blocks = target_aspect_ratio[0] * target_aspect_ratio[1]
61
+
62
+ return blocks, target_width, target_height
63
+
64
+
65
+ def dynamic_preprocess(image, image_size=512, max_num_tiles=12, use_thumbnail=True):
66
+ orig_height, orig_width = get_image_size(image, channel_dim=ChannelDimension.FIRST)
67
+ target_ratios = get_internvl_target_ratios(1, max_num_tiles)
68
+
69
+ blocks, target_width, target_height = calculate_targets(
70
+ orig_width,
71
+ orig_height,
72
+ target_ratios,
73
+ image_size
74
+ )
75
+ # resize the image
76
+ resized_img = T.Resize((target_width, target_height), interpolation=T.InterpolationMode.BICUBIC)(image)
77
+ patches = divide_to_patches(resized_img, image_size)
78
+ assert len(patches) == blocks
79
+ if use_thumbnail and len(patches) != 1:
80
+ thumbnail_img = T.Resize((image_size, image_size), interpolation=T.InterpolationMode.BICUBIC)(image)
81
+ patches.append(thumbnail_img)
82
+
83
+ return patches
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": "<|im_end|>",
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:e5e7dc84d72e8f248321611c3d6dce23407b135f55f8caf5b26119798d12f85f
3
+ size 17077367
tokenizer_config.json ADDED
The diff for this file is too large to render. See raw diff
 
video_io.py ADDED
@@ -0,0 +1,176 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ import os
2
+ import base64
3
+ import mimetypes
4
+ from PIL import Image
5
+ import io
6
+ from transformers.video_utils import VideoMetadata
7
+
8
+
9
+ def encode_pil_to_jpeg_data_url(pil_image):
10
+ from io import BytesIO
11
+ buf = BytesIO()
12
+ pil_image.save(buf, format="JPEG")
13
+ b64 = base64.b64encode(buf.getvalue()).decode("utf-8")
14
+ return f"data:image/jpeg;base64,{b64}"
15
+
16
+
17
+ def sample_video_frames_to_data_urls(video_path_local, fps=1, nframe=0, nframe_max=-1):
18
+ """
19
+ Sample frames from a video and return base64-encoded data URLs along with metadata.
20
+
21
+ Args:
22
+ video_path_local: Path to the video file
23
+ fps: Target frames per second for sampling (if > 0, uses fps-based sampling)
24
+ nframe: Number of frames to sample (used if fps <= 0)
25
+ nframe_max: Maximum number of frames to sample
26
+
27
+ Returns:
28
+ tuple: (frame_data_urls, metadata)
29
+ - frame_data_urls: List of base64-encoded frame images
30
+ - metadata: VideoMetadata dataclass containing info about the sampled frames:
31
+ - total_num_frames: Number of sampled frames
32
+ - fps: Effective frame rate of the sampled frames
33
+ - duration: Duration covered by the sampled frames (in seconds)
34
+ - video_backend: Backend used for video processing ('decord')
35
+ """
36
+ import numpy as np
37
+ from PIL import Image
38
+ import decord
39
+
40
+ vid = decord.VideoReader(video_path_local)
41
+ total_frames = len(vid)
42
+ video_fps = vid.get_avg_fps()
43
+ total_duration = total_frames / max(1e-6, video_fps)
44
+
45
+ if fps > 0:
46
+ required_frames = int(total_duration * fps)
47
+ desired_frames = max(1, required_frames)
48
+ if nframe_max > 0 and desired_frames > nframe_max:
49
+ desired_frames = nframe_max
50
+ if desired_frames >= total_frames:
51
+ indices = list(range(total_frames))
52
+ elif desired_frames == 1:
53
+ indices = [0] # Always use first frame for single frame sampling
54
+ else:
55
+ # Generate evenly spaced indices and ensure uniqueness
56
+ raw_indices = np.linspace(0, total_frames - 1, desired_frames)
57
+ indices = list(np.unique(np.round(raw_indices).astype(int)))
58
+ else:
59
+ desired_frames = max(1, int(nframe) if nframe and nframe > 0 else 8)
60
+ if nframe_max > 0 and desired_frames > nframe_max:
61
+ desired_frames = nframe_max
62
+ if desired_frames >= total_frames:
63
+ indices = list(range(total_frames))
64
+ elif desired_frames == 1:
65
+ indices = [0] # Always use first frame for single frame sampling
66
+ else:
67
+ # Generate evenly spaced indices and ensure uniqueness
68
+ raw_indices = np.linspace(0, total_frames - 1, desired_frames)
69
+ indices = list(np.unique(np.round(raw_indices).astype(int)))
70
+
71
+ images = [Image.fromarray(vid[i].asnumpy()) for i in indices]
72
+ frame_urls = [encode_pil_to_jpeg_data_url(im) for im in images]
73
+
74
+ # Calculate timestamps for each sampled frame
75
+ timestamps = [float(idx) / video_fps for idx in indices]
76
+
77
+ # Calculate metadata for the sampled frames
78
+ sampled_num_frames = len(indices)
79
+
80
+ # Duration is the time span from first to last frame
81
+ if len(timestamps) > 1:
82
+ sampled_duration = timestamps[-1] - timestamps[0]
83
+ sampled_fps = (sampled_num_frames - 1) / sampled_duration if sampled_duration > 0 else 1.0
84
+ else:
85
+ # Single frame case
86
+ sampled_duration = None
87
+ sampled_fps = None
88
+
89
+ metadata = VideoMetadata(
90
+ total_num_frames=sampled_num_frames,
91
+ fps=sampled_fps,
92
+ duration=sampled_duration,
93
+ video_backend=None,
94
+ )
95
+
96
+ return frame_urls, metadata
97
+
98
+
99
+ def maybe_path_or_url_to_data_urls(path_or_url, fps=1, nframe=0, nframe_max=-1):
100
+ """
101
+ Convert a path or URL to data URLs, handling videos, images, and remote files.
102
+
103
+ Args:
104
+ path_or_url: Path or URL to the media file
105
+ fps: Target frames per second for video sampling (if > 0, uses fps-based sampling)
106
+ nframe: Number of frames to sample from video (used if fps <= 0)
107
+ nframe_max: Maximum number of frames to sample
108
+
109
+ Returns:
110
+ tuple: (data_urls, metadata)
111
+ - data_urls: List of base64-encoded data URLs
112
+ - metadata: VideoMetadata dataclass with video metadata or None for images
113
+ """
114
+ val = str(path_or_url or "")
115
+ low = val.lower()
116
+
117
+ # Handle data URLs
118
+ if low.startswith("data:"):
119
+ if low.startswith("data:video/mp4"):
120
+ header, _, b64part = val.partition(",")
121
+ if not b64part:
122
+ return [val], None
123
+ import tempfile
124
+ tmp = tempfile.NamedTemporaryFile(suffix=".mp4", delete=False)
125
+ try:
126
+ tmp.write(base64.b64decode(b64part))
127
+ tmp.flush(); tmp.close()
128
+ return sample_video_frames_to_data_urls(tmp.name, fps=fps, nframe=nframe, nframe_max=nframe_max)
129
+ finally:
130
+ try:
131
+ os.unlink(tmp.name)
132
+ except Exception:
133
+ pass
134
+ return [val], None
135
+
136
+ # Remote URL
137
+ if low.startswith("http://") or low.startswith("https://"):
138
+ if low.endswith(".mp4"):
139
+ try:
140
+ import tempfile, urllib.request
141
+ with tempfile.NamedTemporaryFile(suffix=".mp4", delete=False) as tmpf:
142
+ urllib.request.urlretrieve(val, tmpf.name)
143
+ local_path = tmpf.name
144
+ result = sample_video_frames_to_data_urls(local_path, fps=fps, nframe=nframe, nframe_max=nframe_max)
145
+ try:
146
+ os.unlink(local_path)
147
+ except Exception:
148
+ pass
149
+ return result
150
+ except Exception:
151
+ return [val], None
152
+ return [val], None
153
+
154
+ # Local path
155
+ if os.path.exists(val):
156
+ mime, _ = mimetypes.guess_type(val)
157
+ if mime and mime.startswith("image/"):
158
+ with open(val, "rb") as f:
159
+ b64 = base64.b64encode(f.read()).decode("utf-8")
160
+ return [f"data:{mime};base64,{b64}"], None
161
+ if mime == "video/mp4" or (mime is None and val.endswith(".mp4")):
162
+ return sample_video_frames_to_data_urls(val, fps=fps, nframe=nframe, nframe_max=nframe_max)
163
+ # Fallback: treat as binary image
164
+ with open(val, "rb") as f:
165
+ b64 = base64.b64encode(f.read()).decode("utf-8")
166
+ return [f"data:image/jpeg;base64,{b64}"], None
167
+
168
+ return [val], None
169
+
170
+
171
+ def pil_image_from_base64(b64_str: str) -> Image.Image:
172
+ # Handle data URLs like "data:image/png;base64,...."
173
+ if b64_str.startswith('data:'):
174
+ b64_str = b64_str.split(',', 1)[1]
175
+ img_bytes = base64.b64decode(b64_str)
176
+ return Image.open(io.BytesIO(img_bytes))
video_processing.py ADDED
@@ -0,0 +1,166 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # coding=utf-8
2
+ # Copyright 2025 The Qwen team, Alibaba Group and the HuggingFace Inc. team. All rights reserved.
3
+ #
4
+ # This code is based on EleutherAI's GPT-NeoX library and the GPT-NeoX
5
+ # and OPT implementations in this library. It has been modified from its
6
+ # original forms to accommodate minor architectural differences compared
7
+ # to GPT-NeoX and OPT used by the Meta AI team that trained the model.
8
+ #
9
+ # Licensed under the Apache License, Version 2.0 (the "License");
10
+ # you may not use this file except in compliance with the License.
11
+ # You may obtain a copy of the License at
12
+ #
13
+ # http://www.apache.org/licenses/LICENSE-2.0
14
+ #
15
+ # Unless required by applicable law or agreed to in writing, software
16
+ # distributed under the License is distributed on an "AS IS" BASIS,
17
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18
+ # See the License for the specific language governing permissions and
19
+ # limitations under the License.
20
+ """video processor class for Qwen2-VL."""
21
+
22
+ import math
23
+ from typing import Optional, Union
24
+
25
+ from transformers.image_processing_utils import (
26
+ BatchFeature,
27
+ )
28
+ from transformers.image_utils import (
29
+ OPENAI_CLIP_MEAN,
30
+ OPENAI_CLIP_STD,
31
+ ChannelDimension,
32
+ SizeDict,
33
+ get_image_size,
34
+ )
35
+ from transformers.processing_utils import Unpack, VideosKwargs
36
+ from transformers.utils import (
37
+ TensorType,
38
+ add_start_docstrings,
39
+ is_torch_available,
40
+ is_torchvision_available,
41
+ is_torchvision_v2_available,
42
+ is_vision_available,
43
+ )
44
+ from transformers.utils.import_utils import requires
45
+ from transformers.video_processing_utils import (
46
+ BASE_VIDEO_PROCESSOR_DOCSTRING,
47
+ BaseVideoProcessor,
48
+ )
49
+ from transformers.video_utils import VideoMetadata, group_videos_by_shape, reorder_videos
50
+ import torchvision.transforms as T
51
+
52
+ from .processing_utils import get_internvl_target_ratios, calculate_targets
53
+
54
+
55
+ if is_torchvision_available():
56
+ if is_torchvision_v2_available():
57
+ from torchvision.transforms.v2 import functional as F
58
+ else:
59
+ from torchvision.transforms import functional as F
60
+
61
+
62
+ if is_torch_available():
63
+ import torch
64
+
65
+
66
+ @requires(backends=("torchvision",))
67
+ class NemotronH_Nano_Omni_Reasoning_V3VideoProcessor(BaseVideoProcessor):
68
+ model_input_names = ["pixel_values_videos", "video_grid_thw"]
69
+
70
+ def __init__(self, image_size=512, max_num_tiles=12, norm_mean=None, norm_std=None, **kwargs):
71
+ super().__init__(**kwargs)
72
+ self.image_size = image_size
73
+ self.max_num_tiles = max_num_tiles
74
+ self.norm_mean = norm_mean
75
+ self.norm_std = norm_std
76
+
77
+ def _preprocess(
78
+ self,
79
+ videos: list["torch.Tensor"],
80
+ video_metadata: Union[list[VideoMetadata], list[dict]],
81
+ do_sample_frames: bool,
82
+ fps: Optional[int] = None,
83
+ num_frames: Optional[int] = None,
84
+ return_tensors: Optional[Union[str, TensorType]] = None,
85
+ device: Optional["torch.Tensor"] = None,
86
+ **kwargs,
87
+ ):
88
+ if do_sample_frames:
89
+ # Sample video frames
90
+ videos = [
91
+ self.sample_frames(
92
+ video,
93
+ metadata=metadata,
94
+ num_frames=num_frames,
95
+ fps=fps,
96
+ )
97
+ for video, metadata in zip(videos, video_metadata)
98
+ ]
99
+
100
+ # We need to sample frames first before moving to device, if `do_sample_frames=True`. Otherwise
101
+ # moving the whole video incurs high GPU mem usage for long videos
102
+ if device is not None:
103
+ videos = [video.to(device) for video in videos]
104
+
105
+ # Group videos by size for batched resizing
106
+ grouped_videos, grouped_videos_index = group_videos_by_shape(videos)
107
+ resized_videos_grouped = {}
108
+ processed_grids = {}
109
+ for shape, stacked_videos in grouped_videos.items():
110
+ height, width = get_image_size(stacked_videos[0], channel_dim=ChannelDimension.FIRST)
111
+ batch_size, grid_t, channel = stacked_videos.shape[:3]
112
+
113
+ target_ratios = get_internvl_target_ratios(1, self.max_num_tiles)
114
+ blocks, resize_width, resize_height = calculate_targets(
115
+ width,
116
+ height,
117
+ target_ratios,
118
+ self.image_size
119
+ )
120
+ stacked_videos = self.resize(
121
+ image=stacked_videos,
122
+ size=SizeDict(height=resize_height, width=resize_width),
123
+ interpolation=T.InterpolationMode.BICUBIC,
124
+ )
125
+ # stacked_videos = T.Resize((resize_width, resize_height), interpolation=T.InterpolationMode.BICUBIC)(stacked_videos)
126
+ norm_mean = torch.as_tensor(self.norm_mean, dtype=stacked_videos.dtype, device=stacked_videos.device).view(1, 1, 3, 1, 1)
127
+ norm_std = torch.as_tensor(self.norm_std, dtype=stacked_videos.dtype, device=stacked_videos.device).view(1, 1, 3, 1, 1)
128
+ stacked_videos = (stacked_videos - norm_mean) / norm_std
129
+ resized_videos_grouped[shape] = stacked_videos
130
+ grid_h, grid_w = resize_height // self.image_size, resize_width // self.image_size
131
+ processed_grids[shape] = [[grid_t, grid_h, grid_w]] * batch_size
132
+ resized_videos = reorder_videos(resized_videos_grouped, grouped_videos_index)
133
+ processed_grids = reorder_videos(processed_grids, grouped_videos_index)
134
+ pixel_values_videos = torch.cat(resized_videos, dim=0)
135
+ video_grid_thw = torch.tensor(processed_grids)
136
+
137
+ return BatchFeature(
138
+ data={"pixel_values_videos": pixel_values_videos, "video_grid_thw": video_grid_thw},
139
+ tensor_type=return_tensors,
140
+ )
141
+
142
+ def get_num_of_video_patches(self, num_frames: int, height: int, width: int):
143
+ """
144
+ A utility that returns number of video patches a given video size.
145
+
146
+ Args:
147
+ num_frames (`int`):
148
+ Number of frames in the input video.
149
+ height (`int`):
150
+ Height of the input video.
151
+ width (`int`):
152
+ Width of the input video.
153
+ Returns:
154
+ `Tuple(int, int)`: Number of placeholder tokens required and number of patches per image.
155
+ """
156
+ target_ratios = get_internvl_target_ratios(1, self.max_num_tiles)
157
+ blocks, _, _ = calculate_targets(
158
+ width,
159
+ height,
160
+ target_ratios,
161
+ self.image_size
162
+ )
163
+ return num_frames * blocks
164
+
165
+
166
+ __all__ = ["NemotronH_Nano_Omni_Reasoning_V3VideoProcessor"]