File size: 85,516 Bytes
7f97874 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 | # coding=utf-8
#
# Copyright 2026 Xiaomi Corporation.
# Copyright 2026 The HuggingFace Inc. team.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import math
from copy import copy
from types import SimpleNamespace
from typing import Callable, Optional, Union
import torch
import torch.nn as nn
import torch.nn.functional as F
from transformers.activations import ACT2FN
from transformers.cache_utils import Cache, DynamicCache
from transformers.configuration_utils import PretrainedConfig
from transformers.generation import GenerationMixin
from transformers.integrations import use_kernel_forward_from_hub
from transformers.masking_utils import create_causal_mask, create_sliding_window_causal_mask
from transformers.modeling_outputs import BaseModelOutputWithPast, CausalLMOutputWithPast
from transformers.modeling_rope_utils import ROPE_INIT_FUNCTIONS, dynamic_rope_update
from transformers.modeling_utils import ALL_ATTENTION_FUNCTIONS, PreTrainedModel
from transformers.models.qwen2.configuration_qwen2 import Qwen2Config
from transformers.models.qwen2.modeling_qwen2 import Qwen2Model
from transformers.processing_utils import Unpack
from transformers.utils import TransformersKwargs, can_return_tuple, logging
from .configuration_mimo_v2 import MiMoV2Config
logger = logging.get_logger(__name__)
def rotate_half(x):
"""Rotates half the hidden dims of the input."""
x1 = x[..., : x.shape[-1] // 2]
x2 = x[..., x.shape[-1] // 2 :]
return torch.cat((-x2, x1), dim=-1)
def apply_rotary_pos_emb(q, k, cos, sin, position_ids=None, unsqueeze_dim=1):
"""Applies rotary position embedding to query and key tensors."""
cos = cos.unsqueeze(unsqueeze_dim)
sin = sin.unsqueeze(unsqueeze_dim)
q_embed = (q * cos) + (rotate_half(q) * sin)
k_embed = (k * cos) + (rotate_half(k) * sin)
return q_embed, k_embed
def repeat_kv(hidden_states: torch.Tensor, n_rep: int) -> torch.Tensor:
batch, num_key_value_heads, slen, head_dim = hidden_states.shape
if n_rep == 1:
return hidden_states
hidden_states = hidden_states[:, :, None, :, :].expand(batch, num_key_value_heads, n_rep, slen, head_dim)
return hidden_states.reshape(batch, num_key_value_heads * n_rep, slen, head_dim)
def eager_attention_forward(
module: nn.Module,
query: torch.Tensor,
key: torch.Tensor,
value: torch.Tensor,
attention_mask: Optional[torch.Tensor],
scaling: float,
dropout: float = 0.0,
sinks: Optional[torch.Tensor] = None,
**kwargs,
):
key_states = repeat_kv(key, module.num_key_value_groups)
value_states = repeat_kv(value, module.num_key_value_groups)
attn_weights = torch.matmul(query, key_states.transpose(2, 3)) * scaling
if attention_mask is not None:
causal_mask = attention_mask[:, :, :, : key_states.shape[-2]]
attn_weights = attn_weights + causal_mask
if sinks is not None:
sinks = module.attention_sink_bias.reshape(1, -1, 1, 1).expand(query.shape[0], -1, query.shape[-2], -1)
attn_weights = torch.cat([attn_weights, sinks], dim=-1)
attn_weights = attn_weights - attn_weights.max(dim=-1, keepdim=True).values
probs = F.softmax(attn_weights, dim=-1, dtype=torch.float32).to(query.dtype)
if sinks is not None:
probs = probs[..., :-1]
attn_weights = nn.functional.dropout(probs, p=dropout, training=module.training)
attn_output = torch.matmul(attn_weights, value_states)
attn_output = attn_output.transpose(1, 2).contiguous()
return attn_output, attn_weights
@use_kernel_forward_from_hub("RMSNorm")
class MiMoV2RMSNorm(nn.Module):
def __init__(self, hidden_size, eps=1e-6):
super().__init__()
self.weight = nn.Parameter(torch.ones(hidden_size))
self.variance_epsilon = eps
def forward(self, hidden_states):
input_dtype = hidden_states.dtype
hidden_states = hidden_states.to(torch.float32)
variance = hidden_states.pow(2).mean(-1, keepdim=True)
hidden_states = hidden_states * torch.rsqrt(variance + self.variance_epsilon)
return self.weight * hidden_states.to(input_dtype)
class MiMoV2MLP(nn.Module):
def __init__(self, config, intermediate_size=None):
super().__init__()
self.config = config
self.hidden_size = config.hidden_size
self.intermediate_size = config.intermediate_size if intermediate_size is None else intermediate_size
self.gate_proj = nn.Linear(self.hidden_size, self.intermediate_size, bias=False)
self.up_proj = nn.Linear(self.hidden_size, self.intermediate_size, bias=False)
self.down_proj = nn.Linear(self.intermediate_size, self.hidden_size, bias=False)
self.act_fn = ACT2FN[config.hidden_act]
def forward(self, hidden_states):
return self.down_proj(self.act_fn(self.gate_proj(hidden_states)) * self.up_proj(hidden_states))
class MiMoV2MoEGate(nn.Module):
def __init__(self, config):
super().__init__()
self.config = config
self.top_k = config.num_experts_per_tok
self.n_routed_experts = config.n_routed_experts
self.routed_scaling_factor = config.routed_scaling_factor if config.routed_scaling_factor is not None else 1.0
self.scoring_func = config.scoring_func
self.topk_method = config.topk_method
self.n_group = config.n_group
self.topk_group = config.topk_group
self.norm_topk_prob = config.norm_topk_prob
self.gating_dim = config.hidden_size
self.weight = nn.Parameter(torch.empty((self.n_routed_experts, self.gating_dim)))
if self.topk_method == "noaux_tc":
self.e_score_correction_bias = nn.Parameter(torch.empty((self.n_routed_experts)))
def forward(self, hidden_states):
bsz, seq_len, h = hidden_states.shape
hidden_states = hidden_states.view(-1, h)
logits = F.linear(hidden_states.type(torch.float32), self.weight.type(torch.float32), None)
if self.scoring_func == "sigmoid":
scores = logits.sigmoid()
else:
raise NotImplementedError(f"Unsupported scoring function for MoE gating: {self.scoring_func}")
if self.topk_method == "noaux_tc":
if self.training:
raise ValueError("MiMoV2 noaux_tc routing is only implemented for inference.")
scores_for_choice = scores.view(bsz * seq_len, -1) + self.e_score_correction_bias.unsqueeze(0)
group_scores = scores_for_choice.view(bsz * seq_len, self.n_group, -1).topk(2, dim=-1)[0].sum(dim=-1)
group_idx = torch.topk(group_scores, k=self.topk_group, dim=-1, sorted=False)[1]
group_mask = torch.zeros_like(group_scores)
group_mask.scatter_(1, group_idx, 1)
score_mask = (
group_mask.unsqueeze(-1)
.expand(bsz * seq_len, self.n_group, self.n_routed_experts // self.n_group)
.reshape(bsz * seq_len, -1)
)
tmp_scores = scores_for_choice.masked_fill(~score_mask.bool(), float("-inf"))
_, topk_idx = torch.topk(tmp_scores, k=self.top_k, dim=-1, sorted=False)
topk_weight = scores.gather(1, topk_idx)
else:
raise NotImplementedError(f"Unsupported TopK function for MoE gating: {self.topk_method}")
if self.top_k > 1 and self.norm_topk_prob:
denominator = topk_weight.sum(dim=-1, keepdim=True) + 1e-20
topk_weight = topk_weight / denominator
topk_weight = topk_weight * self.routed_scaling_factor
return topk_idx, topk_weight
class MiMoV2MoE(nn.Module):
def __init__(self, config):
super().__init__()
self.config = config
self.experts = nn.ModuleList(
[MiMoV2MLP(config, intermediate_size=config.moe_intermediate_size) for _ in range(config.n_routed_experts)]
)
self.gate = MiMoV2MoEGate(config)
def moe(self, hidden_states: torch.Tensor, topk_indices: torch.Tensor, topk_weights: torch.Tensor):
final_hidden_states = torch.zeros_like(hidden_states, dtype=topk_weights.dtype)
expert_mask = torch.nn.functional.one_hot(topk_indices, num_classes=len(self.experts))
expert_mask = expert_mask.permute(2, 0, 1)
for expert_idx, expert in enumerate(self.experts):
mask = expert_mask[expert_idx]
token_indices, weight_indices = torch.where(mask)
if token_indices.numel() > 0:
expert_weights = topk_weights[token_indices, weight_indices]
expert_input = hidden_states[token_indices]
expert_output = expert(expert_input)
final_hidden_states.index_add_(0, token_indices, expert_output * expert_weights.unsqueeze(-1))
return final_hidden_states.type(hidden_states.dtype)
def forward(self, hidden_states: torch.Tensor) -> torch.Tensor:
orig_shape = hidden_states.shape
topk_indices, topk_weights = self.gate(hidden_states)
hidden_states = hidden_states.view(-1, hidden_states.shape[-1])
hidden_states = self.moe(hidden_states, topk_indices, topk_weights).view(*orig_shape)
return hidden_states
class MiMoV2Attention(nn.Module):
"""MiMoV2 attention.
`projection_layout` only controls how checkpoint weights are named and
stored: Flash uses separate q/k/v projections, while Pro uses fused qkv.
The attention computation after projection is shared.
"""
def __init__(self, config, is_swa: bool, layer_idx: int, projection_layout: str = "split"):
super().__init__()
if projection_layout not in {"split", "fused_qkv"}:
raise ValueError(f"Unsupported MiMoV2 attention projection layout: {projection_layout}")
self.config = config
self.layer_idx = layer_idx
self.is_swa = is_swa
self.is_causal = True
self.projection_layout = projection_layout
default_head_dim = config.hidden_size // config.num_attention_heads
default_v_head_dim = getattr(config, "v_head_dim", default_head_dim)
if is_swa:
self.head_dim = getattr(config, "swa_head_dim", getattr(config, "head_dim", default_head_dim))
self.v_head_dim = getattr(config, "swa_v_head_dim", default_v_head_dim)
self.num_attention_heads = getattr(config, "swa_num_attention_heads", config.num_attention_heads)
self.num_key_value_heads = getattr(config, "swa_num_key_value_heads", config.num_key_value_heads)
else:
self.head_dim = getattr(config, "head_dim", default_head_dim)
self.v_head_dim = getattr(config, "v_head_dim", self.head_dim)
self.num_attention_heads = config.num_attention_heads
self.num_key_value_heads = config.num_key_value_heads
self.rope_dim = int(self.head_dim * getattr(config, "partial_rotary_factor", 1.0))
if self.rope_dim % 2 != 0:
raise ValueError(
f"MiMoV2 rotary dimension must be even, got {self.rope_dim} from "
f"head_dim={self.head_dim} and partial_rotary_factor={getattr(config, 'partial_rotary_factor', 1.0)}"
)
self.num_key_value_groups = self.num_attention_heads // self.num_key_value_heads
self.attention_dropout = getattr(config, "attention_dropout", 0.0)
self.scaling = self.head_dim**-0.5
self.sliding_window = getattr(config, "sliding_window", None) if is_swa else None
self.q_size = self.num_attention_heads * self.head_dim
self.k_size = self.num_key_value_heads * self.head_dim
self.v_size = self.num_key_value_heads * self.v_head_dim
self.o_hidden_size = self.num_attention_heads * self.v_head_dim
self.v_scale = getattr(config, "attention_value_scale", None)
self.attention_sink_bias = (
nn.Parameter(torch.empty(self.num_attention_heads), requires_grad=False)
if (
(getattr(config, "add_full_attention_sink_bias", False) and not is_swa)
or (getattr(config, "add_swa_attention_sink_bias", False) and is_swa)
)
else None
)
attention_bias = getattr(config, "attention_bias", False)
if self.projection_layout == "fused_qkv":
self.qkv_proj = nn.Linear(
config.hidden_size,
self.q_size + self.k_size + self.v_size,
bias=attention_bias,
)
else:
self.q_proj = nn.Linear(config.hidden_size, self.q_size, bias=attention_bias)
self.k_proj = nn.Linear(config.hidden_size, self.k_size, bias=attention_bias)
self.v_proj = nn.Linear(config.hidden_size, self.v_size, bias=attention_bias)
self.o_proj = nn.Linear(self.o_hidden_size, config.hidden_size, bias=False)
def _forward_attention(
self,
query_states: torch.Tensor,
key_states: torch.Tensor,
value_states: torch.Tensor,
input_shape: torch.Size,
position_embeddings: tuple[torch.Tensor, torch.Tensor],
attention_mask: Optional[torch.Tensor],
past_key_values: Optional[Cache] = None,
cache_position: Optional[torch.LongTensor] = None,
position_ids: Optional[torch.LongTensor] = None,
) -> tuple[torch.Tensor, torch.Tensor]:
if self.v_scale is not None:
value_states = value_states * self.v_scale
cos, sin = position_embeddings
query_rope, query_nope = query_states.split([self.rope_dim, self.head_dim - self.rope_dim], dim=-1)
key_rope, key_nope = key_states.split([self.rope_dim, self.head_dim - self.rope_dim], dim=-1)
query_rope, key_rope = apply_rotary_pos_emb(query_rope, key_rope, cos, sin)
query_states = torch.cat([query_rope, query_nope], dim=-1)
key_states = torch.cat([key_rope, key_nope], dim=-1)
if past_key_values is not None:
cache_kwargs = {"sin": sin, "cos": cos, "cache_position": cache_position}
key_states, value_states = past_key_values.update(key_states, value_states, self.layer_idx, cache_kwargs)
attn_implementation = self.config._attn_implementation
if attn_implementation is not None and attn_implementation.startswith("paged|"):
raise ValueError(
"MiMoV2 remote code does not support paged attention cache. "
"Please use eager, sdpa, flex_attention, or flash_attention_2."
)
attention_interface: Callable = ALL_ATTENTION_FUNCTIONS.get_interface(
attn_implementation, eager_attention_forward
)
if self.attention_sink_bias is not None and attn_implementation == "sdpa":
logger.warning_once(
"MiMoV2 attention sink bias is not supported by SDPA; falling back to eager attention for correctness."
)
attention_interface = eager_attention_forward
attention_kwargs = {
"dropout": 0.0 if not self.training else self.attention_dropout,
"scaling": self.scaling,
"position_ids": position_ids,
"is_causal": self.is_causal,
}
if attention_interface is eager_attention_forward:
attention_kwargs["sinks"] = self.attention_sink_bias
else:
if self.attention_sink_bias is not None:
attention_kwargs["s_aux"] = self.attention_sink_bias
if self.sliding_window is not None:
attention_kwargs["sliding_window"] = self.sliding_window
attn_output, attn_weights = attention_interface(
self,
query_states,
key_states,
value_states,
attention_mask,
**attention_kwargs,
)
attn_output = attn_output.reshape(*input_shape, -1).contiguous()
attn_output = self.o_proj(attn_output)
return attn_output, attn_weights
def forward(
self,
hidden_states: torch.Tensor,
position_embeddings: tuple[torch.Tensor, torch.Tensor],
attention_mask: Optional[torch.Tensor],
past_key_values: Optional[Cache] = None,
cache_position: Optional[torch.LongTensor] = None,
position_ids: Optional[torch.LongTensor] = None,
**kwargs: Unpack[TransformersKwargs],
) -> tuple[torch.Tensor, torch.Tensor]:
input_shape = hidden_states.shape[:-1]
if self.projection_layout == "fused_qkv":
qkv_states = self.qkv_proj(hidden_states)
query_states, key_states, value_states = qkv_states.split([self.q_size, self.k_size, self.v_size], dim=-1)
else:
query_states = self.q_proj(hidden_states)
key_states = self.k_proj(hidden_states)
value_states = self.v_proj(hidden_states)
query_states = query_states.view(*input_shape, self.num_attention_heads, self.head_dim).transpose(1, 2)
key_states = key_states.view(*input_shape, self.num_key_value_heads, self.head_dim).transpose(1, 2)
value_states = value_states.view(*input_shape, self.num_key_value_heads, self.v_head_dim).transpose(1, 2)
return self._forward_attention(
query_states,
key_states,
value_states,
input_shape,
position_embeddings,
attention_mask,
past_key_values=past_key_values,
cache_position=cache_position,
position_ids=position_ids,
)
class MiMoV2DecoderLayer(nn.Module):
attention_projection_layout = "split"
def __init__(self, config, layer_idx: int, attention_projection_layout: Optional[str] = None):
super().__init__()
attention_projection_layout = attention_projection_layout or self.attention_projection_layout
is_swa_layer = config.hybrid_layer_pattern[layer_idx] == 1
self.attention_type = "sliding_window_attention" if is_swa_layer else "full_attention"
self.self_attn = MiMoV2Attention(
config, is_swa_layer, layer_idx, projection_layout=attention_projection_layout
)
self.mlp = (
MiMoV2MoE(config)
if getattr(config, "n_routed_experts", None) is not None and config.moe_layer_freq[layer_idx]
else MiMoV2MLP(config)
)
self.input_layernorm = MiMoV2RMSNorm(config.hidden_size, eps=config.layernorm_epsilon)
self.post_attention_layernorm = MiMoV2RMSNorm(config.hidden_size, eps=config.layernorm_epsilon)
def forward(
self,
hidden_states: torch.Tensor,
attention_mask: Optional[torch.Tensor] = None,
position_ids: Optional[torch.LongTensor] = None,
past_key_values: Optional[Cache] = None,
use_cache: Optional[bool] = False,
cache_position: Optional[torch.LongTensor] = None,
position_embeddings: Optional[tuple[torch.Tensor, torch.Tensor]] = None,
**kwargs: Unpack[TransformersKwargs],
) -> torch.Tensor:
residual = hidden_states
hidden_states = self.input_layernorm(hidden_states)
hidden_states, _ = self.self_attn(
hidden_states=hidden_states,
attention_mask=attention_mask,
position_ids=position_ids,
past_key_values=past_key_values,
use_cache=use_cache,
cache_position=cache_position,
position_embeddings=position_embeddings,
**kwargs,
)
hidden_states = residual + hidden_states
residual = hidden_states
hidden_states = self.post_attention_layernorm(hidden_states)
hidden_states = self.mlp(hidden_states)
hidden_states = residual + hidden_states
return hidden_states
class MiMoV2RotaryEmbedding(nn.Module):
inv_freq: torch.Tensor
def __init__(self, config, is_swa: bool, device=None):
super().__init__()
if hasattr(config, "rope_scaling") and isinstance(config.rope_scaling, dict):
self.rope_type = config.rope_scaling.get("rope_type", config.rope_scaling.get("type", "default"))
else:
self.rope_type = "default"
self.max_seq_len_cached = config.max_position_embeddings
self.original_max_seq_len = config.max_position_embeddings
self.config = copy(config)
self.config.rope_parameters = copy(getattr(config, "rope_parameters", None) or {})
if is_swa:
self.config.rope_theta = getattr(config, "swa_rope_theta", config.rope_theta)
self.config.head_dim = getattr(config, "swa_head_dim", getattr(config, "head_dim", None))
if self.config.rope_parameters:
self.config.rope_parameters["rope_theta"] = self.config.rope_theta
self.rope_init_fn = (
self.compute_default_rope_parameters
if self.rope_type == "default"
else ROPE_INIT_FUNCTIONS[self.rope_type]
)
inv_freq, self.attention_scaling = self.rope_init_fn(self.config, device)
self.register_buffer("inv_freq", inv_freq, persistent=False)
self.original_inv_freq = self.inv_freq
@staticmethod
def compute_default_rope_parameters(config, device=None, seq_len=None, layer_type=None):
config.standardize_rope_params()
rope_parameters = config.rope_parameters[layer_type] if layer_type is not None else config.rope_parameters
base = rope_parameters["rope_theta"]
partial_rotary_factor = rope_parameters.get("partial_rotary_factor", 1.0)
head_dim = getattr(config, "head_dim", None) or config.hidden_size // config.num_attention_heads
dim = int(head_dim * partial_rotary_factor)
if dim % 2 != 0:
raise ValueError(
f"MiMoV2 rotary dimension must be even, got {dim} from "
f"head_dim={head_dim} and partial_rotary_factor={partial_rotary_factor}"
)
inv_freq = 1.0 / (
base ** (torch.arange(0, dim, 2, dtype=torch.int64).to(device=device, dtype=torch.float) / dim)
)
return inv_freq, 1.0
@torch.no_grad()
@dynamic_rope_update
def forward(self, x, position_ids):
inv_freq_expanded = self.inv_freq[None, :, None].float().expand(position_ids.shape[0], -1, 1).to(x.device)
position_ids_expanded = position_ids[:, None, :].float()
device_type = x.device.type if isinstance(x.device.type, str) and x.device.type != "mps" else "cpu"
with torch.autocast(device_type=device_type, enabled=False):
freqs = (inv_freq_expanded.float() @ position_ids_expanded.float()).transpose(1, 2)
emb = torch.cat((freqs, freqs), dim=-1)
cos = emb.cos() * self.attention_scaling
sin = emb.sin() * self.attention_scaling
return cos.to(dtype=x.dtype), sin.to(dtype=x.dtype)
# ---------------------------------------------------------------------------
# Multimodal helpers
# ---------------------------------------------------------------------------
def _as_namespace(config_like):
if config_like is None:
return SimpleNamespace()
if isinstance(config_like, dict):
return SimpleNamespace(**config_like)
return config_like
def _parse_maybe_list(value: str | int, length: int) -> list[int]:
if isinstance(value, str) and "-" in value:
return [int(x) for x in value.split("-")]
return [int(value)] * length
def _build_speech_embeddings(config) -> nn.ModuleList:
audio_channels = getattr(config, "audio_channels")
input_local_dim = getattr(config, "input_local_dim")
speech_empty_ids = _parse_maybe_list(getattr(config, "speech_zeroemb_idx"), audio_channels)
speech_vocab_sizes = _parse_maybe_list(getattr(config, "speech_vocab_size"), audio_channels)
return nn.ModuleList(
[
nn.Embedding(speech_vocab_sizes[i], input_local_dim, padding_idx=speech_empty_ids[i])
for i in range(audio_channels)
]
)
def _pad_and_group_audio_codes(
audio_codes: torch.Tensor, audio_channels: int, group_size: int
) -> torch.Tensor:
"""Slice to `audio_channels`, pad to `group_size` boundary, reshape to [G, group_size, C]."""
if audio_codes.dim() != 2:
raise ValueError(f"`audio_codes` must be 2D [T, C], got shape={tuple(audio_codes.shape)}")
audio_codes = audio_codes[:, :audio_channels]
T = audio_codes.shape[0]
padded_T = ((T + group_size - 1) // group_size) * group_size
if padded_T > T:
audio_codes = torch.cat([audio_codes, audio_codes[-1:].expand(padded_T - T, -1)], dim=0)
return audio_codes.reshape(padded_T // group_size, group_size, audio_channels)
def _replace_modal_embeddings_inplace(
input_ids: torch.Tensor,
inputs_embeds: torch.Tensor,
token_id: int | None,
modal_embeds: torch.Tensor | None,
) -> None:
if token_id is None or modal_embeds is None:
return
if modal_embeds.dim() != 2:
raise ValueError(f"`modal_embeds` must be 2D [N, H], got shape={tuple(modal_embeds.shape)}")
mask = input_ids.eq(token_id)
num_slots = int(mask.sum().item())
if num_slots == 0:
return
if modal_embeds.shape[0] != num_slots:
raise ValueError(
f"Modal embedding count mismatch for token_id={token_id}: "
f"found {num_slots} placeholders but got {modal_embeds.shape[0]} embeddings."
)
inputs_embeds[mask] = modal_embeds.to(device=inputs_embeds.device, dtype=inputs_embeds.dtype)
# ---------------------------------------------------------------------------
# Vision encoder
# ---------------------------------------------------------------------------
def _rotate_half_vision(x: torch.Tensor) -> torch.Tensor:
x1 = x[..., : x.shape[-1] // 2]
x2 = x[..., x.shape[-1] // 2 :]
return torch.cat((-x2, x1), dim=-1)
def _apply_rotary_pos_emb_vision(
q: torch.Tensor, k: torch.Tensor, cos: torch.Tensor, sin: torch.Tensor
) -> tuple[torch.Tensor, torch.Tensor]:
orig_q_dtype, orig_k_dtype = q.dtype, k.dtype
q, k = q.float(), k.float()
cos, sin = cos.unsqueeze(-2).float(), sin.unsqueeze(-2).float()
q_embed = (q * cos) + (_rotate_half_vision(q) * sin)
k_embed = (k * cos) + (_rotate_half_vision(k) * sin)
return q_embed.to(orig_q_dtype), k_embed.to(orig_k_dtype)
class MiMoVisionRotaryEmbedding(nn.Module):
def __init__(self, dim: int, theta: float = 10000.0) -> None:
super().__init__()
inv_freq = 1.0 / (theta ** (torch.arange(0, dim, 2, dtype=torch.float) / dim))
self.register_buffer("inv_freq", inv_freq, persistent=False)
def forward(self, seqlen: int) -> torch.Tensor:
seq = torch.arange(seqlen, device=self.inv_freq.device, dtype=self.inv_freq.dtype)
return torch.outer(seq, self.inv_freq)
class MiMoVisionPatchEmbed(nn.Module):
def __init__(
self, patch_size: int = 16, temporal_patch_size: int = 2, in_channels: int = 3, embed_dim: int = 1280
):
super().__init__()
self.patch_size = patch_size
self.temporal_patch_size = temporal_patch_size
self.in_channels = in_channels
self.embed_dim = embed_dim
kernel_size = [temporal_patch_size, patch_size, patch_size]
self.proj = nn.Conv3d(in_channels, embed_dim, kernel_size=kernel_size, stride=kernel_size, bias=False)
def forward(self, hidden_states: torch.Tensor) -> torch.Tensor:
target_dtype = self.proj.weight.dtype
hidden_states = hidden_states.view(
-1, self.in_channels, self.temporal_patch_size, self.patch_size, self.patch_size
)
return self.proj(hidden_states.to(dtype=target_dtype)).view(-1, self.embed_dim)
class MiMoVisionSwiGLUMLP(nn.Module):
def __init__(self, dim: int, intermediate_dim: int, hidden_act: str = "silu"):
super().__init__()
self.gate_proj = nn.Linear(dim, intermediate_dim, bias=True)
self.up_proj = nn.Linear(dim, intermediate_dim, bias=True)
self.down_proj = nn.Linear(intermediate_dim, dim, bias=True)
self.act_fn = ACT2FN[hidden_act]
def forward(self, x: torch.Tensor) -> torch.Tensor:
return self.down_proj(self.act_fn(self.gate_proj(x)) * self.up_proj(x))
class MiMoVisionAttention(nn.Module):
def __init__(
self,
dim: int,
num_heads: int,
num_kv_heads: int | None = None,
head_dim: int | None = None,
use_sinks: bool = False,
window_size: int = -1,
):
super().__init__()
self.dim = dim
self.num_heads = num_heads
self.num_kv_heads = num_kv_heads if num_kv_heads is not None else num_heads
self.head_dim = head_dim if head_dim is not None else dim // num_heads
self.num_kv_groups = self.num_heads // self.num_kv_heads
self.scaling = self.head_dim**-0.5
self.window_size = window_size
qkv_dim = (self.num_heads + 2 * self.num_kv_heads) * self.head_dim
self.qkv = nn.Linear(dim, qkv_dim, bias=True)
self.proj = nn.Linear(self.num_heads * self.head_dim, dim, bias=True)
self.sinks = nn.Parameter(torch.zeros(self.num_heads)) if use_sinks else None
def _build_window_mask(self, seq_len: int, device: torch.device, dtype: torch.dtype) -> torch.Tensor | None:
if self.window_size <= 0:
return None
row_idx = torch.arange(seq_len, device=device).unsqueeze(1)
col_idx = torch.arange(seq_len, device=device).unsqueeze(0)
mask = torch.zeros(seq_len, seq_len, device=device, dtype=dtype)
mask = mask.masked_fill((row_idx - col_idx).abs() > self.window_size, float("-inf"))
return mask
def forward(
self,
hidden_states: torch.Tensor,
cu_seqlens: torch.Tensor,
position_embeddings: tuple[torch.Tensor, torch.Tensor],
full_attn: bool = False,
) -> torch.Tensor:
seq_len = hidden_states.shape[0]
qkv = self.qkv(hidden_states)
q_dim = self.num_heads * self.head_dim
kv_dim = self.num_kv_heads * self.head_dim
q = qkv[:, :q_dim].view(seq_len, self.num_heads, self.head_dim)
k = qkv[:, q_dim : q_dim + kv_dim].view(seq_len, self.num_kv_heads, self.head_dim)
v = qkv[:, q_dim + kv_dim :].view(seq_len, self.num_kv_heads, self.head_dim)
cos, sin = position_embeddings
q, k = _apply_rotary_pos_emb_vision(q, k, cos, sin)
lengths = cu_seqlens[1:] - cu_seqlens[:-1]
q_chunks = torch.split(q, lengths.tolist(), dim=0)
k_chunks = torch.split(k, lengths.tolist(), dim=0)
v_chunks = torch.split(v, lengths.tolist(), dim=0)
outputs = []
for q_c, k_c, v_c in zip(q_chunks, k_chunks, v_chunks):
q_c = q_c.unsqueeze(0).transpose(1, 2)
k_c = k_c.unsqueeze(0).transpose(1, 2)
v_c = v_c.unsqueeze(0).transpose(1, 2)
if self.num_kv_groups > 1:
k_c = k_c.repeat_interleave(self.num_kv_groups, dim=1)
v_c = v_c.repeat_interleave(self.num_kv_groups, dim=1)
attn_mask = None
if not full_attn:
attn_mask = self._build_window_mask(q_c.shape[2], q_c.device, q_c.dtype)
if self.sinks is not None:
sink_bias = torch.zeros(
1, self.num_heads, q_c.shape[2], k_c.shape[2], device=q_c.device, dtype=q_c.dtype
)
sink_bias[..., 0] = self.sinks.view(1, self.num_heads, 1)
attn_mask = sink_bias if attn_mask is None else attn_mask + sink_bias
attn_out = F.scaled_dot_product_attention(q_c, k_c, v_c, attn_mask=attn_mask, scale=self.scaling)
outputs.append(attn_out.squeeze(0).transpose(0, 1))
attn_output = torch.cat(outputs, dim=0)
attn_output = attn_output.reshape(seq_len, -1)
return self.proj(attn_output)
class MiMoVisionBlock(nn.Module):
def __init__(
self,
dim: int,
intermediate_dim: int,
num_heads: int,
num_kv_heads: int | None = None,
head_dim: int | None = None,
hidden_act: str = "silu",
rms_norm_eps: float = 1e-6,
use_sinks: bool = False,
window_size: int = -1,
):
super().__init__()
self.norm1 = nn.RMSNorm(dim, eps=rms_norm_eps)
self.norm2 = nn.RMSNorm(dim, eps=rms_norm_eps)
self.attn = MiMoVisionAttention(
dim=dim, num_heads=num_heads, num_kv_heads=num_kv_heads, head_dim=head_dim,
use_sinks=use_sinks, window_size=window_size,
)
self.mlp = MiMoVisionSwiGLUMLP(dim=dim, intermediate_dim=intermediate_dim, hidden_act=hidden_act)
def forward(
self,
hidden_states: torch.Tensor,
cu_seqlens: torch.Tensor,
position_embeddings: tuple[torch.Tensor, torch.Tensor],
full_attn: bool = False,
) -> torch.Tensor:
hidden_states = hidden_states + self.attn(
self.norm1(hidden_states), cu_seqlens=cu_seqlens,
position_embeddings=position_embeddings, full_attn=full_attn,
)
hidden_states = hidden_states + self.mlp(self.norm2(hidden_states))
return hidden_states
class MiMoVisionPatchMerger(nn.Module):
def __init__(self, dim: int, context_dim: int, spatial_merge_size: int = 2):
super().__init__()
self.hidden_size = context_dim * (spatial_merge_size**2)
self.ln_q = nn.LayerNorm(context_dim, eps=1e-6)
self.mlp = nn.Sequential(
nn.Linear(self.hidden_size, self.hidden_size),
nn.GELU(),
nn.Linear(self.hidden_size, dim),
)
def forward(self, x: torch.Tensor) -> torch.Tensor:
return self.mlp(self.ln_q(x).view(-1, self.hidden_size))
class MiMoVisionTransformer(nn.Module):
def __init__(self, config):
super().__init__()
self.config = config
hidden_size = config.hidden_size
depth = config.depth
num_heads = config.num_heads
num_kv_heads = getattr(config, "num_key_value_heads", num_heads)
head_dim = getattr(config, "qk_channels", 64)
spatial_merge_size = getattr(config, "spatial_merge_size", 2)
rms_norm_eps = getattr(config, "rms_norm_eps", 1e-6)
self.fullatt_block_indexes = getattr(config, "fullatt_block_indexes", [])
use_sink = getattr(config, "use_sink", False)
visual_token_window_size = getattr(config, "visual_token_window_size", -1)
self.vit_window_attn_types = getattr(config, "vit_window_attn_types", None) or [-1] * depth
self.spatial_merge_size = spatial_merge_size
self.spatial_merge_unit = spatial_merge_size * spatial_merge_size
self.patch_embed = MiMoVisionPatchEmbed(
patch_size=config.patch_size,
temporal_patch_size=config.temporal_patch_size,
in_channels=getattr(config, "in_channels", None) or getattr(config, "in_chans", 3),
embed_dim=hidden_size,
)
self.rotary_pos_emb = MiMoVisionRotaryEmbedding(head_dim // 2)
self.blocks = nn.ModuleList(
[
MiMoVisionBlock(
dim=hidden_size,
intermediate_dim=config.intermediate_size,
num_heads=num_heads,
num_kv_heads=num_kv_heads,
head_dim=head_dim,
hidden_act=config.hidden_act,
rms_norm_eps=rms_norm_eps,
use_sinks=use_sink and (i not in self.fullatt_block_indexes),
window_size=visual_token_window_size,
)
for i in range(depth)
]
)
self.merger = MiMoVisionPatchMerger(
dim=config.out_hidden_size,
context_dim=hidden_size,
spatial_merge_size=spatial_merge_size,
)
@property
def dtype(self) -> torch.dtype:
return self.patch_embed.proj.weight.dtype
def apply_index(self, tensor: torch.Tensor, index: torch.Tensor) -> torch.Tensor:
tensor = tensor.unflatten(0, (-1, self.spatial_merge_unit))
tensor = tensor[index]
return tensor.flatten(0, 1)
def get_window_index_1d(self, grid_thw: torch.Tensor, col: bool = True) -> torch.Tensor:
window_index = []
window_index_id = 0
for grid_t, grid_h, grid_w in grid_thw:
llm_grid_h = grid_h // self.spatial_merge_size
llm_grid_w = grid_w // self.spatial_merge_size
index = torch.arange(grid_t * llm_grid_h * llm_grid_w).reshape(grid_t, llm_grid_h, llm_grid_w)
index_new = index.transpose(1, 2).reshape(-1) if col else index.reshape(-1)
window_index.append(index_new + window_index_id)
window_index_id += (grid_t * llm_grid_h * llm_grid_w).item()
return torch.cat(window_index, dim=0)
def rot_pos_emb(self, grid_thw: torch.Tensor) -> torch.Tensor:
pos_ids = []
for t, h, w in grid_thw:
hpos_ids = torch.arange(h).unsqueeze(1).expand(-1, w)
hpos_ids = hpos_ids.reshape(
h // self.spatial_merge_size, self.spatial_merge_size,
w // self.spatial_merge_size, self.spatial_merge_size,
)
hpos_ids = hpos_ids.permute(0, 2, 1, 3).flatten()
wpos_ids = torch.arange(w).unsqueeze(0).expand(h, -1)
wpos_ids = wpos_ids.reshape(
h // self.spatial_merge_size, self.spatial_merge_size,
w // self.spatial_merge_size, self.spatial_merge_size,
)
wpos_ids = wpos_ids.permute(0, 2, 1, 3).flatten()
pos_ids.append(torch.stack([hpos_ids, wpos_ids], dim=-1).repeat(t, 1))
pos_ids = torch.cat(pos_ids, dim=0)
max_grid_size = grid_thw[:, 1:].max()
rotary_pos_emb_full = self.rotary_pos_emb(max_grid_size)
return rotary_pos_emb_full[pos_ids].flatten(1)
def forward(self, pixel_values: torch.Tensor, grid_thw: torch.Tensor) -> torch.Tensor:
x = pixel_values.to(device=self.patch_embed.proj.weight.device, dtype=self.dtype)
x = self.patch_embed(x)
rotary_emb = self.rot_pos_emb(grid_thw)
rotary_emb = rotary_emb.to(device=x.device)
emb = torch.cat((rotary_emb, rotary_emb), dim=-1)
window_index_1d_col = self.get_window_index_1d(grid_thw, col=True).to(device=x.device)
reverse_window_index_1d_col = torch.argsort(window_index_1d_col).to(device=x.device)
row_based_embeddings = (emb.cos(), emb.sin())
col_emb = self.apply_index(emb, window_index_1d_col)
col_based_embeddings = (col_emb.cos(), col_emb.sin())
cu_seqlens = torch.repeat_interleave(grid_thw[:, 1] * grid_thw[:, 2], grid_thw[:, 0]).cumsum(
dim=0, dtype=torch.int32
)
cu_seqlens = F.pad(cu_seqlens, (1, 0), value=0).to(device=x.device)
for i, blk in enumerate(self.blocks):
window_attn_type = self.vit_window_attn_types[i]
if window_attn_type == 1 and (i == 0 or self.vit_window_attn_types[i - 1] != 1):
x = self.apply_index(x, window_index_1d_col)
if i > 0 and window_attn_type != 1 and self.vit_window_attn_types[i - 1] == 1:
x = self.apply_index(x, reverse_window_index_1d_col)
position_embeddings = col_based_embeddings if window_attn_type == 1 else row_based_embeddings
full_attn = i in self.fullatt_block_indexes
x = blk(x, cu_seqlens=cu_seqlens, position_embeddings=position_embeddings, full_attn=full_attn)
return self.merger(x)
# ---------------------------------------------------------------------------
# Audio encoder
# ---------------------------------------------------------------------------
class AudioProjection(nn.Module):
def __init__(self, input_size: int, hidden_size: int, output_size: int):
super().__init__()
self.mlp = nn.Sequential(
nn.Linear(input_size, hidden_size, bias=False),
nn.GELU(),
nn.Linear(hidden_size, output_size, bias=False),
)
def forward(self, x: torch.Tensor) -> torch.Tensor:
return self.mlp(x)
class MiMoAudioEncoder(nn.Module):
def __init__(self, config):
super().__init__()
self.config = config
self.audio_channels = getattr(config, "audio_channels")
self.group_size = getattr(config, "group_size")
self.input_local_dim = getattr(config, "input_local_dim")
self.out_hidden_size = getattr(config, "out_hidden_size")
self.input_full_attention = getattr(config, "input_full_attention", True)
self.audio_segment_size = getattr(config, "audio_segment_size", 6000)
input_local_config = Qwen2Config(
hidden_size=getattr(config, "input_local_dim"),
num_hidden_layers=getattr(config, "input_local_layers"),
num_attention_heads=getattr(config, "input_local_attn_heads"),
num_key_value_heads=getattr(config, "input_local_attn_heads"),
intermediate_size=getattr(config, "input_local_intermediate_size"),
attention_dropout=getattr(config, "input_local_hidden_dropout", 0.0),
rope_theta=getattr(config, "rope_theta", 640000.0),
partial_rotary_factor=getattr(config, "partial_rotary_factor", 1.0),
)
self.input_local_transformer = Qwen2Model(input_local_config)
if not getattr(config, "add_post_norm", True):
self.input_local_transformer.norm = nn.Identity()
proj_in = self.input_local_dim * self.group_size
projection_layers = getattr(config, "projection_layers", 2)
if projection_layers == 1:
self.projection = nn.Linear(proj_in, self.out_hidden_size, bias=False)
elif projection_layers == 2:
self.projection = AudioProjection(proj_in, proj_in * 4, self.out_hidden_size)
else:
raise ValueError(f"Unsupported projection_layers={projection_layers}, expected 1 or 2.")
def _apply_speech_embeddings(self, audio_codes: torch.Tensor, speech_embeddings: nn.ModuleList) -> torch.Tensor:
num_segments = audio_codes.shape[0]
out = torch.zeros(
(num_segments, self.group_size, self.input_local_dim),
dtype=speech_embeddings[0].weight.dtype,
device=audio_codes.device,
)
for i in range(self.audio_channels):
out.add_(speech_embeddings[i](audio_codes[:, :, i].long()))
return out
def _apply_input_local_transformer(self, speech_embeddings: torch.Tensor) -> torch.Tensor:
output = self.input_local_transformer(
inputs_embeds=speech_embeddings, return_dict=True, use_cache=False,
is_causal=not self.input_full_attention,
)
return output.last_hidden_state
def _process_audio_codes(self, audio_codes: torch.Tensor, speech_embeddings: nn.ModuleList) -> torch.Tensor:
audio_codes = _pad_and_group_audio_codes(audio_codes, self.audio_channels, self.group_size)
audio_embs = self._apply_speech_embeddings(audio_codes, speech_embeddings)
audio_hidden = self._apply_input_local_transformer(audio_embs)
return self.projection(audio_hidden.reshape(audio_hidden.shape[0], -1))
def get_audio_feature(
self,
mels: list[torch.Tensor],
speech_embeddings: nn.ModuleList,
audio_tokenizer_encoder,
) -> torch.Tensor:
"""Full pipeline: mel spectrograms → tokenize → codes → embed → project."""
if not mels:
device = next(self.projection.parameters()).device
dtype = next(self.projection.parameters()).dtype
return torch.empty(0, self.out_hidden_size, device=device, dtype=dtype)
device = next(audio_tokenizer_encoder.parameters()).device
code_list = tokenize_audio_batch(
mels, audio_tokenizer_encoder, segment_size=self.audio_segment_size, device=device,
)
codecs_to_concat = []
for codecs in code_list:
codecs_to_concat.append(_pad_and_group_audio_codes(codecs, self.audio_channels, self.group_size))
audio_codes = torch.cat(codecs_to_concat, dim=0)
audio_embs = self._apply_speech_embeddings(audio_codes, speech_embeddings)
audio_hidden = self._apply_input_local_transformer(audio_embs)
return self.projection(audio_hidden.reshape(audio_hidden.shape[0], -1))
def forward(
self,
speech_embeddings: nn.ModuleList,
audio_codes: torch.Tensor | None = None,
audio_embeds: torch.Tensor | None = None,
) -> torch.Tensor:
if audio_embeds is not None:
if audio_embeds.dim() != 2:
raise ValueError(f"`audio_embeds` must be 2D [N, H], got shape={tuple(audio_embeds.shape)}")
if audio_embeds.shape[-1] != self.out_hidden_size:
raise ValueError(
f"Unexpected audio_embeds hidden size {audio_embeds.shape[-1]}, expected {self.out_hidden_size}"
)
return audio_embeds
if audio_codes is None:
raise ValueError("Either `audio_codes` or `audio_embeds` must be provided.")
return self._process_audio_codes(audio_codes, speech_embeddings)
# ---------------------------------------------------------------------------
# Audio tokenizer (codec: mel → encoder → VQ → codes)
# Adapted from https://github.com/XiaomiMiMo/MiMo-Audio-Tokenizer.git
# ---------------------------------------------------------------------------
class MiMoAudioTokenizerConfig(PretrainedConfig):
model_type = "mimo_audio_tokenizer"
def __init__(
self,
max_audio_seconds: int = 1800,
stride_size: int = 2,
avg_pooler: int = 1,
d_model: int = 768,
scale_embedding: bool = True,
kernel_size: int = 3,
activation_function: str = "gelu",
encoder_layers: int = 8,
encoder_skip_layer_id: int = None,
encoder_attention_heads: int = 12,
encoder_ffn_dim: int = 3072,
encoder_causal: bool = False,
encoder_attn_window_size: list = None,
decoder_layers: int = 8,
decoder_attention_heads: int = 12,
decoder_ffn_dim: int = 3072,
decoder_kernel_size: int = 3,
decoder_stride_size: int = 2,
decoder_causal: bool = True,
decoder_attn_window_size: list = None,
nfft: int = 1024,
vocoder_dim: int = 512,
vocoder_intermediate_dim: int = 4096,
vocoder_num_layers: int = 30,
n_mels: int = 80,
sampling_rate: int = 24000,
hop_length: int = 240,
window_size: int = 1024,
vocoder_padding: str = "same",
fmin: int = 0,
fmax: int = None,
num_quantizers: int = 12,
codebook_size: list = None,
threshold_ema_dead_code: int = 10,
position_embedding_type: str = "rope",
rope_theta: int = 10000,
rope_type: str = "default",
ln_type: str = "LayerNorm",
vocoder_attention_heads: int = 4,
vocoder_attn_window_size: list = None,
use_istft_only: bool = False,
hybrid_attention: bool = False,
hybrid_block_size: int = 8,
swa_per_block: int = 2,
**kwargs,
):
super().__init__(**kwargs)
self.max_audio_seconds = max_audio_seconds
self.stride_size = stride_size
self.avg_pooler = avg_pooler
self.d_model = d_model
self.scale_embedding = scale_embedding
self.kernel_size = kernel_size
self.activation_function = activation_function
self.encoder_layers = encoder_layers
self.encoder_skip_layer_id = encoder_skip_layer_id
self.encoder_attention_heads = encoder_attention_heads
self.encoder_ffn_dim = encoder_ffn_dim
self.encoder_causal = encoder_causal
self.encoder_attn_window_size = encoder_attn_window_size if encoder_attn_window_size is not None else [-1, -1]
self.decoder_layers = decoder_layers
self.decoder_attention_heads = decoder_attention_heads
self.decoder_ffn_dim = decoder_ffn_dim
self.decoder_kernel_size = decoder_kernel_size
self.decoder_stride_size = decoder_stride_size
self.decoder_causal = decoder_causal
self.decoder_attn_window_size = decoder_attn_window_size if decoder_attn_window_size is not None else [-1, -1]
self.nfft = nfft
self.vocoder_dim = vocoder_dim
self.vocoder_intermediate_dim = vocoder_intermediate_dim
self.vocoder_num_layers = vocoder_num_layers
self.n_mels = n_mels
self.sampling_rate = sampling_rate
self.hop_length = hop_length
self.window_size = window_size
self.vocoder_padding = vocoder_padding
self.fmin = fmin
self.fmax = fmax
self.num_quantizers = num_quantizers
self.codebook_size = codebook_size if codebook_size is not None else [1024]
self.threshold_ema_dead_code = threshold_ema_dead_code
self.position_embedding_type = position_embedding_type
self.rope_theta = rope_theta
self.rope_type = rope_type
self.ln_type = ln_type
self.vocoder_attention_heads = vocoder_attention_heads
self.vocoder_attn_window_size = vocoder_attn_window_size if vocoder_attn_window_size is not None else [40, 10]
self.use_istft_only = use_istft_only
self.hybrid_attention = hybrid_attention
self.hybrid_block_size = hybrid_block_size
self.swa_per_block = swa_per_block
class EuclideanCodebook(nn.Module):
def __init__(self, dim: int, codebook_size: int, kmeans_init: bool = False, **kwargs):
super().__init__()
init_fn = torch.zeros if kmeans_init else self._uniform_init
embed = init_fn(codebook_size, dim)
self.codebook_size = codebook_size
self.register_buffer("inited", torch.Tensor([not kmeans_init]))
self.register_buffer("cluster_size", torch.zeros(codebook_size))
self.register_buffer("embed", embed)
self.register_buffer("embed_avg", embed.clone())
def quantize(self, x):
embed = self.embed.t()
dist = -(x.pow(2).sum(1, keepdim=True) - 2 * x @ embed + embed.pow(2).sum(0, keepdim=True))
return dist.max(dim=-1).indices
def encode(self, x):
shape = x.shape
x = x.reshape(-1, x.shape[-1])
embed_ind = self.quantize(x)
return embed_ind.view(*shape[:-1])
def decode(self, embed_ind):
return F.embedding(embed_ind, self.embed)
@staticmethod
def _uniform_init(*shape: int):
t = torch.empty(shape)
nn.init.kaiming_uniform_(t)
return t
class VectorQuantization(nn.Module):
def __init__(self, dim: int, codebook_size: int, codebook_dim: Optional[int] = None, kmeans_init: bool = True, **kwargs):
super().__init__()
_codebook_dim = codebook_dim if codebook_dim is not None else dim
requires_projection = _codebook_dim != dim
self.project_in = nn.Linear(dim, _codebook_dim) if requires_projection else nn.Identity()
self.project_out = nn.Linear(_codebook_dim, dim) if requires_projection else nn.Identity()
self._codebook = EuclideanCodebook(dim=_codebook_dim, codebook_size=codebook_size, kmeans_init=kmeans_init)
self.codebook_size = codebook_size
def encode(self, x):
return self._codebook.encode(self.project_in(x))
def decode(self, embed_ind):
return self.project_out(self._codebook.decode(embed_ind))
class ResidualVectorQuantization(nn.Module):
def __init__(self, *, num_quantizers, codebook_size, **kwargs):
super().__init__()
if isinstance(codebook_size, int):
codebook_size = [codebook_size] * num_quantizers
elif len(codebook_size) < num_quantizers:
codebook_size += [codebook_size[-1]] * (num_quantizers - len(codebook_size))
self.layers = nn.ModuleList(
[VectorQuantization(codebook_size=codebook_size[i], **kwargs) for i in range(num_quantizers)]
)
def encode(self, x: torch.Tensor, n_q: Optional[int] = None, st: Optional[int] = None) -> torch.Tensor:
residual = x
all_indices = []
n_q = len(self.layers) if n_q is None else n_q
st = 0 if st is None else st
for layer in self.layers[st:n_q]:
indices = layer.encode(residual)
quantized = layer.decode(indices)
residual = residual - quantized
all_indices.append(indices)
return torch.stack(all_indices)
def decode(self, q_indices: torch.Tensor, st: int = 0) -> torch.Tensor:
quantized_out = self.layers[st].decode(q_indices[0])
for i in range(1, len(q_indices)):
quantized_out = quantized_out + self.layers[st + i].decode(q_indices[i])
return quantized_out
class ResidualVectorQuantizer(nn.Module):
def __init__(self, dimension: int = 256, n_q: int = 8, bins: int | list = 1024, kmeans_init: bool = True, **kwargs):
super().__init__()
self.n_q = n_q
self.vq = ResidualVectorQuantization(dim=dimension, codebook_size=bins, num_quantizers=n_q, kmeans_init=kmeans_init)
def encode(self, x: torch.Tensor, n_q: Optional[int] = None, st: Optional[int] = None) -> torch.Tensor:
return self.vq.encode(x, n_q=n_q or self.n_q, st=st or 0)
def decode(self, codes: torch.Tensor, st: int = 0) -> torch.Tensor:
return self.vq.decode(codes, st=st)
class AudioTokenizerRotaryEmbedding(nn.Module):
def __init__(self, base, dim, max_seq_len, rope_type="default", device=None):
super().__init__()
self.attention_scaling = 1.0
inv_freq = 1.0 / (base ** (torch.arange(0, dim, 2, dtype=torch.float, device=device) / dim))
self.register_buffer("inv_freq", inv_freq, persistent=False)
@torch.no_grad()
def forward(self, x, position_ids):
inv_freq_expanded = self.inv_freq[:, None].float().expand(-1, 1).to(x.device)
position_ids_expanded = position_ids[None, :].float()
with torch.autocast(device_type="cpu", enabled=False):
freqs = (inv_freq_expanded.float() @ position_ids_expanded.float()).transpose(0, 1)
emb = torch.cat((freqs, freqs), dim=-1)
cos = emb.cos() * self.attention_scaling
sin = emb.sin() * self.attention_scaling
return cos.to(dtype=x.dtype), sin.to(dtype=x.dtype)
def _at_get_position_ids(lengths):
total_len = lengths.sum()
offset = torch.cat([torch.zeros(1, device=lengths.device, dtype=lengths.dtype), lengths[:-1].cumsum(dim=0)])
offset = torch.repeat_interleave(offset, lengths)
return torch.arange(0, total_len, device=lengths.device) - offset
def _at_get_sequence_mask(inputs, inputs_length):
if inputs.dim() == 3:
bsz, tgt_len, _ = inputs.size()
else:
bsz, tgt_len = inputs_length.shape[0], torch.max(inputs_length)
sequence_mask = torch.arange(0, tgt_len, device=inputs.device)
sequence_mask = torch.lt(sequence_mask, inputs_length.reshape(bsz, 1)).view(bsz, tgt_len, 1)
unpacking_index = torch.cumsum(sequence_mask.to(torch.int64).view(-1), dim=0) - 1
return sequence_mask, unpacking_index
def _at_unpack_hidden_states(hidden_states, lengths, sequence_mask=None, unpacking_index=None):
bsz = lengths.shape[0]
if sequence_mask is None or unpacking_index is None:
sequence_mask, unpacking_index = _at_get_sequence_mask(hidden_states, lengths)
hidden_states = torch.index_select(hidden_states, 0, unpacking_index).view(
bsz, torch.max(lengths), hidden_states.shape[-1]
)
return torch.where(sequence_mask, hidden_states, 0)
def _at_rotate_half(x):
x1 = x[..., : x.shape[-1] // 2]
x2 = x[..., x.shape[-1] // 2 :]
return torch.cat((-x2, x1), dim=-1)
def _at_apply_rotary_pos_emb(q, k, cos, sin, unsqueeze_dim=1):
cos = cos.unsqueeze(unsqueeze_dim)
sin = sin.unsqueeze(unsqueeze_dim)
return (q * cos) + (_at_rotate_half(q) * sin), (k * cos) + (_at_rotate_half(k) * sin)
_AT_LAYER_NORM = {"LayerNorm": nn.LayerNorm}
class AudioTokenizerAttention(nn.Module):
def __init__(self, embed_dim: int, num_heads: int, window_size: tuple[int, int] = (-1, -1), causal: bool = False):
super().__init__()
self.embed_dim = embed_dim
self.num_heads = num_heads
self.head_dim = embed_dim // num_heads
self.window_size = window_size
self.causal = causal
self.scaling = self.head_dim**-0.5
self.k_proj = nn.Linear(embed_dim, embed_dim, bias=False)
self.v_proj = nn.Linear(embed_dim, embed_dim, bias=True)
self.q_proj = nn.Linear(embed_dim, embed_dim, bias=True)
self.out_proj = nn.Linear(embed_dim, embed_dim, bias=True)
def _build_attn_mask(self, seq_len: int, device: torch.device, dtype: torch.dtype) -> torch.Tensor | None:
has_window = self.window_size[0] > 0
if not self.causal and not has_window:
return None
mask = torch.zeros(seq_len, seq_len, device=device, dtype=dtype)
if self.causal:
mask = mask + torch.triu(torch.full((seq_len, seq_len), float("-inf"), device=device, dtype=dtype), diagonal=1)
if has_window:
row_idx = torch.arange(seq_len, device=device).unsqueeze(1)
col_idx = torch.arange(seq_len, device=device).unsqueeze(0)
mask = mask.masked_fill((row_idx - col_idx).abs() > self.window_size[0], float("-inf"))
return mask
def forward(self, hidden_states, cu_seqlens, max_seqlen, rope_position_embeddings=None):
total_len = hidden_states.shape[0]
q = self.q_proj(hidden_states).view(total_len, self.num_heads, self.head_dim)
k = self.k_proj(hidden_states).view(total_len, self.num_heads, self.head_dim)
v = self.v_proj(hidden_states).view(total_len, self.num_heads, self.head_dim)
if rope_position_embeddings is not None:
cos, sin = rope_position_embeddings
q, k = _at_apply_rotary_pos_emb(q, k, cos, sin)
num_seqs = cu_seqlens.shape[0] - 1
outputs = []
for i in range(num_seqs):
start, end = cu_seqlens[i].item(), cu_seqlens[i + 1].item()
seq_len = end - start
q_seq = q[start:end].transpose(0, 1).unsqueeze(0)
k_seq = k[start:end].transpose(0, 1).unsqueeze(0)
v_seq = v[start:end].transpose(0, 1).unsqueeze(0)
attn_mask = self._build_attn_mask(seq_len, q_seq.device, q_seq.dtype)
out = F.scaled_dot_product_attention(q_seq, k_seq, v_seq, attn_mask=attn_mask, scale=self.scaling)
outputs.append(out.squeeze(0).transpose(0, 1))
return self.out_proj(torch.cat(outputs, dim=0).reshape(total_len, self.embed_dim))
class AudioTokenizerTransformerLayer(nn.Module):
def __init__(self, config: MiMoAudioTokenizerConfig, causal: bool, attn_window_size: tuple[int, int] = (-1, -1)):
super().__init__()
self.embed_dim = config.d_model
self.self_attn = AudioTokenizerAttention(
embed_dim=self.embed_dim, num_heads=config.encoder_attention_heads,
window_size=attn_window_size, causal=causal,
)
self.self_attn_layer_norm = _AT_LAYER_NORM[config.ln_type](self.embed_dim)
self.activation_fn = ACT2FN[config.activation_function]
self.fc1 = nn.Linear(self.embed_dim, config.encoder_ffn_dim)
self.fc2 = nn.Linear(config.encoder_ffn_dim, self.embed_dim)
self.final_layer_norm = _AT_LAYER_NORM[config.ln_type](self.embed_dim)
def forward(self, hidden_states, cu_seqlens, max_seqlen, rope_position_embeddings):
residual = hidden_states
hidden_states = self.self_attn_layer_norm(hidden_states)
hidden_states = self.self_attn(hidden_states, cu_seqlens, max_seqlen, rope_position_embeddings=rope_position_embeddings)
hidden_states = residual + hidden_states
residual = hidden_states
hidden_states = self.final_layer_norm(hidden_states)
hidden_states = self.activation_fn(self.fc1(hidden_states))
hidden_states = self.fc2(hidden_states)
hidden_states = residual + hidden_states
return hidden_states
class AudioTokenizerEncoder(nn.Module):
def __init__(self, config: MiMoAudioTokenizerConfig):
super().__init__()
self.config = config
self.max_source_positions = (config.max_audio_seconds * config.sampling_rate // config.hop_length) // config.stride_size
self.embed_scale = math.sqrt(config.d_model) if config.scale_embedding else 1.0
self.skip_layer_idx = config.encoder_skip_layer_id
self.conv1 = nn.Conv1d(config.n_mels, config.d_model, kernel_size=config.kernel_size, padding=1)
self.conv2 = nn.Conv1d(config.d_model, config.d_model, kernel_size=config.kernel_size, stride=config.stride_size, padding=1)
self.position_embedding = AudioTokenizerRotaryEmbedding(
config.rope_theta, config.d_model // config.encoder_attention_heads,
self.max_source_positions, config.rope_type,
)
attn_window_sizes = []
if config.hybrid_attention:
for i in range(config.encoder_layers):
if i % config.swa_per_block < config.swa_per_block - 1:
attn_window_sizes.append(tuple(config.encoder_attn_window_size))
else:
attn_window_sizes.append((-1, -1))
else:
attn_window_sizes = [tuple(config.encoder_attn_window_size)] * config.encoder_layers
self.layers = nn.ModuleList([
AudioTokenizerTransformerLayer(config=config, causal=config.encoder_causal, attn_window_size=attn_window_sizes[i])
for i in range(config.encoder_layers)
])
self.layer_norm = _AT_LAYER_NORM[config.ln_type](config.d_model)
if config.avg_pooler != 1:
self.down_sample_layer = nn.Sequential(
nn.Conv1d(config.d_model, config.d_model, config.avg_pooler, config.avg_pooler, bias=False),
nn.GELU(),
)
self.down_sample_norm = _AT_LAYER_NORM[config.ln_type](config.d_model)
else:
self.down_sample_layer = None
if config.num_quantizers != 0:
self.quantizer = ResidualVectorQuantizer(
dimension=config.d_model, n_q=config.num_quantizers,
bins=config.codebook_size,
threshold_ema_dead_code=config.threshold_ema_dead_code,
)
else:
self.quantizer = None
def get_output_length(self, mel_len):
tgt_len = mel_len + 3 - self.config.kernel_size
return (tgt_len + 2 - self.config.kernel_size) // self.config.stride_size + 1
def get_features(self, input_features, output_length):
input_features = input_features.to(self.conv1.weight)
inputs_embeds = F.gelu(self.conv1(input_features))
inputs_embeds = F.gelu(self.conv2(inputs_embeds))
inputs_embeds = inputs_embeds.permute(0, 2, 1)
bsz, tgt_len, _ = inputs_embeds.size()
position_ids = _at_get_position_ids(output_length).long().to(input_features.device)
rope_position_embeddings = self.position_embedding(input_features, position_ids)
attention_mask, unpacking_index = _at_get_sequence_mask(inputs_embeds, output_length)
hidden_states = torch.masked_select(inputs_embeds, attention_mask).view(
torch.sum(output_length), self.config.d_model
)
cu_seqlens = F.pad(torch.cumsum(output_length, dim=0), (1, 0), "constant", 0).to(
device=hidden_states.device, dtype=torch.int32
)
max_seqlen = torch.max(output_length).to(torch.int32).item()
skip_connect_hidden_states = 0.0
for idx, encoder_layer in enumerate(self.layers):
hidden_states = encoder_layer(hidden_states, cu_seqlens, max_seqlen, rope_position_embeddings=rope_position_embeddings)
if self.skip_layer_idx is not None and idx == self.skip_layer_idx - 1:
skip_connect_hidden_states = hidden_states.clone()
hidden_states += skip_connect_hidden_states
hidden_states = self.layer_norm(hidden_states)
if self.down_sample_layer is not None:
hidden_states = torch.index_select(hidden_states, 0, unpacking_index).view(bsz, tgt_len, self.config.d_model)
if hidden_states.size(1) % self.config.avg_pooler:
pad_len = self.config.avg_pooler - hidden_states.size(1) % self.config.avg_pooler
hidden_states = F.pad(hidden_states, (0, 0, 0, pad_len), mode="constant", value=0.0)
tgt_len += pad_len
tgt_len = tgt_len // self.config.avg_pooler
hidden_states = self.down_sample_layer(hidden_states.transpose(1, 2))
output_length = output_length // self.config.avg_pooler + (output_length % self.config.avg_pooler != 0).int()
hidden_states = hidden_states.transpose(1, 2)
attention_mask, unpacking_index = _at_get_sequence_mask(hidden_states, output_length)
hidden_states = torch.masked_select(hidden_states, attention_mask).view(
torch.sum(output_length), self.config.d_model
)
hidden_states = self.down_sample_norm(hidden_states)
return hidden_states, output_length, attention_mask, unpacking_index, tgt_len, bsz
@torch.no_grad()
def encode(self, input_features, input_lens=None, output_length=None, return_codes_only=False, n_q=None, use_quantizer=True):
if output_length is None:
output_length = self.get_output_length(input_lens)
input_features = _at_unpack_hidden_states(input_features, input_lens)
hidden_states, output_length, attention_mask, unpacking_index, tgt_len, bsz = self.get_features(
input_features=input_features.transpose(1, 2), output_length=output_length,
)
dtype = hidden_states.dtype
if use_quantizer and self.quantizer is not None:
self.quantizer.float()
codes = self.quantizer.encode(hidden_states.float(), n_q=n_q)
if return_codes_only:
return codes, output_length
hidden_states = self.quantizer.decode(codes)
hidden_states = hidden_states.to(dtype)
else:
codes = None
hidden_states_packed = hidden_states.clone()
hidden_states = torch.index_select(hidden_states, 0, unpacking_index).view(bsz, tgt_len, self.config.d_model)
hidden_states = torch.where(attention_mask, hidden_states, 0)
return hidden_states, hidden_states_packed, output_length, codes
class MiMoAudioTokenizer(PreTrainedModel):
config_class = MiMoAudioTokenizerConfig
def __init__(self, config: MiMoAudioTokenizerConfig):
super().__init__(config)
self.config = config
self.sampling_rate = config.sampling_rate
self.encoder = AudioTokenizerEncoder(config=config)
self.downsample_rate = int(config.hop_length * 2 * config.avg_pooler)
def get_output_length(self, mel_len):
return self.encoder.get_output_length(mel_len)
@torch.no_grad()
def encode(self, mels, input_lens, use_quantizer=True):
return self.encoder.encode(mels, input_lens=input_lens, use_quantizer=use_quantizer)
def _at_group_by_length(features, lengths, max_length):
split_points, current_sum = [], 0
for i, seq_len in enumerate(lengths):
if current_sum + seq_len > max_length and current_sum > 0:
split_points.append(i)
current_sum = seq_len.item()
else:
current_sum += seq_len.item()
group_sizes, prev = [], 0
for point in split_points:
group_sizes.append(point - prev)
prev = point
if prev < len(lengths):
group_sizes.append(len(lengths) - prev)
len_groups = torch.split(lengths, group_sizes)
feature_groups = torch.split(features, [g.sum().item() for g in len_groups])
return feature_groups, len_groups
@torch.no_grad()
def tokenize_audio_batch(mels, audio_tokenizer_encoder, segment_size=6000, device=None):
if not mels:
return []
if device is None:
device = next(audio_tokenizer_encoder.parameters()).device
input_len_seg_per_mel = []
for m in mels:
input_len = m.size(0)
segs = [segment_size] * (input_len // segment_size)
if input_len % segment_size > 0:
segs.append(input_len % segment_size)
input_len_seg_per_mel.append(segs)
input_lens_flat = [s for segs in input_len_seg_per_mel for s in segs]
input_features = torch.cat([m.to(device) for m in mels], dim=0)
input_lens_t = torch.tensor(input_lens_flat, dtype=torch.long, device=device)
feature_groups, len_groups = _at_group_by_length(input_features, input_lens_t, 256000)
encoded_parts = []
for features, lengths in zip(feature_groups, len_groups):
codes, _ = audio_tokenizer_encoder.encode(input_features=features, input_lens=lengths, return_codes_only=True)
encoded_parts.append(codes)
codes = torch.cat(encoded_parts, dim=-1).transpose(0, 1).detach()
code_lengths = []
for segs in input_len_seg_per_mel:
out_len = audio_tokenizer_encoder.get_output_length(torch.tensor(segs, dtype=torch.long, device=device))
if getattr(audio_tokenizer_encoder, "down_sample_layer", None) is not None:
avg = audio_tokenizer_encoder.config.avg_pooler
out_len = out_len // avg + (out_len % avg != 0).long()
code_lengths.append(out_len.sum().item())
return list(torch.split(codes, code_lengths))
# ---------------------------------------------------------------------------
# LLM backbone
# ---------------------------------------------------------------------------
class MiMoV2Model(PreTrainedModel):
config_class = MiMoV2Config
attention_projection_layout = "split"
def __init__(self, config):
super().__init__(config)
self.attention_projection_layout = getattr(
config, "attention_projection_layout", self.attention_projection_layout
)
self.vocab_size = config.vocab_size
self.embed_tokens = nn.Embedding(config.vocab_size, config.hidden_size)
self.layers = nn.ModuleList(
[
MiMoV2DecoderLayer(
config,
layer_idx,
attention_projection_layout=self.attention_projection_layout,
)
for layer_idx in range(config.num_hidden_layers)
]
)
self.norm = MiMoV2RMSNorm(config.hidden_size, eps=config.layernorm_epsilon)
self.rotary_emb = MiMoV2RotaryEmbedding(config=config, is_swa=False)
self.swa_rotary_emb = MiMoV2RotaryEmbedding(config=config, is_swa=True)
self.has_sliding_layers = any(pattern == 1 for pattern in config.hybrid_layer_pattern)
self.config.layer_types = [
"sliding_attention" if config.hybrid_layer_pattern[i] == 1 else "full_attention"
for i in range(config.num_hidden_layers)
]
self.post_init()
def get_input_embeddings(self):
return self.embed_tokens
def set_input_embeddings(self, value):
self.embed_tokens = value
def forward(
self,
input_ids: Optional[torch.LongTensor] = None,
attention_mask: Optional[torch.Tensor] = None,
position_ids: Optional[torch.LongTensor] = None,
past_key_values: Optional[Cache] = None,
inputs_embeds: Optional[torch.FloatTensor] = None,
use_cache: Optional[bool] = None,
cache_position: Optional[torch.LongTensor] = None,
**kwargs: Unpack[TransformersKwargs],
) -> BaseModelOutputWithPast:
if (input_ids is None) ^ (inputs_embeds is not None):
raise ValueError("You must specify exactly one of input_ids or inputs_embeds")
use_cache = use_cache if use_cache is not None else self.config.use_cache
if inputs_embeds is None:
inputs_embeds = self.embed_tokens(input_ids)
if use_cache and past_key_values is None:
past_key_values = DynamicCache(config=self.config)
if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
cache_position = torch.arange(
past_seen_tokens, past_seen_tokens + inputs_embeds.shape[1], device=inputs_embeds.device
)
if position_ids is None:
position_ids = cache_position.unsqueeze(0)
if not isinstance(causal_mask_mapping := attention_mask, dict):
mask_kwargs = {
"config": self.config,
"input_embeds": inputs_embeds,
"attention_mask": attention_mask,
"cache_position": cache_position,
"past_key_values": past_key_values,
"position_ids": position_ids,
}
causal_mask_mapping = {
"full_attention": create_causal_mask(**mask_kwargs),
}
if self.has_sliding_layers:
if getattr(self.config, "sliding_window", None) is None:
raise ValueError("MiMoV2 config `sliding_window` must be set when hybrid_layer_pattern uses SWA.")
causal_mask_mapping["sliding_window_attention"] = create_sliding_window_causal_mask(**mask_kwargs)
hidden_states = inputs_embeds
position_embeddings = self.rotary_emb(hidden_states, position_ids)
swa_position_embeddings = self.swa_rotary_emb(hidden_states, position_ids)
for decoder_layer in self.layers[: self.config.num_hidden_layers]:
hidden_states = decoder_layer(
hidden_states,
attention_mask=causal_mask_mapping[decoder_layer.attention_type],
position_embeddings=position_embeddings
if decoder_layer.attention_type == "full_attention"
else swa_position_embeddings,
position_ids=position_ids,
past_key_values=past_key_values,
use_cache=use_cache,
cache_position=cache_position,
**kwargs,
)
hidden_states = self.norm(hidden_states)
return BaseModelOutputWithPast(
last_hidden_state=hidden_states,
past_key_values=past_key_values if use_cache else None,
)
class MiMoV2ForCausalLM(PreTrainedModel, GenerationMixin):
config_class = MiMoV2Config
model_class = MiMoV2Model
_tied_weights_keys = {"lm_head.weight": "model.embed_tokens.weight"}
_tp_plan = {"lm_head": "colwise_rep"}
_pp_plan = {"lm_head": (["hidden_states"], ["logits"])}
_keys_to_ignore_on_load_unexpected = [
r"model\.(swa_)?rotary_emb\.inv_freq",
r"model\.layers\.\d+\.self_attn\.rotary_emb\.inv_freq",
r"model\.layers\.\d+\.self_attn\.rotary_emb\.(cos_cached|sin_cached)",
r"model\.mtp\..*",
]
_keys_to_ignore_on_load_missing = [
r"audio_encoder\.input_local_transformer\.embed_tokens\.weight",
]
def __init__(self, config):
super().__init__(config)
self.model = self.model_class(config)
self.vocab_size = config.vocab_size
self.lm_head = nn.Linear(config.hidden_size, config.vocab_size, bias=False)
if config.vision_config:
self.visual = MiMoVisionTransformer(_as_namespace(config.vision_config))
if config.audio_config:
audio_cfg = _as_namespace(config.audio_config)
self.speech_embeddings = _build_speech_embeddings(audio_cfg)
self.audio_encoder = MiMoAudioEncoder(audio_cfg)
self.audio_tokenizer = None
self.post_init()
def load_audio_tokenizer(self, path: str, device: torch.device | str | None = None, dtype: torch.dtype = torch.bfloat16):
"""Load the audio tokenizer from a directory containing config.json and model.safetensors."""
import json
import os
from safetensors.torch import load_file
config_path = os.path.join(path, "config.json")
with open(config_path) as f:
config_dict = json.load(f)
tokenizer_config = MiMoAudioTokenizerConfig(**config_dict)
tokenizer_model = MiMoAudioTokenizer(tokenizer_config)
safetensors_path = os.path.join(path, "model.safetensors")
bin_path = os.path.join(path, "pytorch_model.bin")
if os.path.exists(safetensors_path):
state_dict = load_file(safetensors_path, device="cpu")
elif os.path.exists(bin_path):
state_dict = torch.load(bin_path, map_location="cpu", weights_only=True)
else:
raise FileNotFoundError(f"No model weights found in {path}")
tokenizer_model.load_state_dict(state_dict, strict=False)
if device is None:
device = next(self.parameters()).device
tokenizer_model = tokenizer_model.to(device=device, dtype=dtype)
tokenizer_model.eval()
tokenizer_model.requires_grad_(False)
self.audio_tokenizer = tokenizer_model
def get_input_embeddings(self):
return self.model.embed_tokens
def set_input_embeddings(self, value):
self.model.embed_tokens = value
def get_output_embeddings(self):
return self.lm_head
def set_output_embeddings(self, new_embeddings):
self.lm_head = new_embeddings
def _get_multimodal_embeds(
self,
input_ids: torch.Tensor,
inputs_embeds: torch.Tensor,
pixel_values: Optional[torch.Tensor] = None,
image_grid_thw: Optional[torch.Tensor] = None,
image_embeds: Optional[torch.Tensor] = None,
video_pixel_values: Optional[torch.Tensor] = None,
video_grid_thw: Optional[torch.Tensor] = None,
video_embeds: Optional[torch.Tensor] = None,
audio_codes: Optional[torch.Tensor] = None,
audio_embeds: Optional[torch.Tensor] = None,
) -> torch.Tensor:
has_image = image_embeds is not None or pixel_values is not None
has_video = video_embeds is not None or video_pixel_values is not None
has_audio = audio_embeds is not None or audio_codes is not None
if not (has_image or has_video or has_audio):
return inputs_embeds
inputs_embeds = inputs_embeds.clone()
if has_image:
cur_image_embeds = image_embeds if image_embeds is not None else self.visual(pixel_values=pixel_values, grid_thw=image_grid_thw)
_replace_modal_embeddings_inplace(
input_ids=input_ids, inputs_embeds=inputs_embeds,
token_id=getattr(self.config, "image_token_id", None), modal_embeds=cur_image_embeds,
)
if has_video:
cur_video_embeds = video_embeds if video_embeds is not None else self.visual(pixel_values=video_pixel_values, grid_thw=video_grid_thw)
_replace_modal_embeddings_inplace(
input_ids=input_ids, inputs_embeds=inputs_embeds,
token_id=getattr(self.config, "video_token_id", None), modal_embeds=cur_video_embeds,
)
if has_audio:
_replace_modal_embeddings_inplace(
input_ids=input_ids, inputs_embeds=inputs_embeds,
token_id=getattr(self.config, "audio_token_id", None),
modal_embeds=self.audio_encoder(
speech_embeddings=self.speech_embeddings, audio_codes=audio_codes, audio_embeds=audio_embeds,
),
)
return inputs_embeds
@can_return_tuple
def forward(
self,
input_ids: Optional[torch.LongTensor] = None,
attention_mask: Optional[torch.Tensor] = None,
position_ids: Optional[torch.LongTensor] = None,
past_key_values: Optional[Cache] = None,
inputs_embeds: Optional[torch.FloatTensor] = None,
labels: Optional[torch.LongTensor] = None,
use_cache: Optional[bool] = None,
cache_position: Optional[torch.LongTensor] = None,
logits_to_keep: Union[int, torch.Tensor] = 0,
pixel_values: Optional[torch.Tensor] = None,
image_grid_thw: Optional[torch.Tensor] = None,
image_embeds: Optional[torch.Tensor] = None,
video_pixel_values: Optional[torch.Tensor] = None,
video_grid_thw: Optional[torch.Tensor] = None,
video_embeds: Optional[torch.Tensor] = None,
audio_codes: Optional[torch.Tensor] = None,
audio_embeds: Optional[torch.Tensor] = None,
**kwargs: Unpack[TransformersKwargs],
) -> CausalLMOutputWithPast:
if inputs_embeds is None and input_ids is not None:
inputs_embeds = self.model.get_input_embeddings()(input_ids)
if any(x is not None for x in [pixel_values, image_embeds, video_pixel_values, video_embeds, audio_codes, audio_embeds]):
inputs_embeds = self._get_multimodal_embeds(
input_ids=input_ids, inputs_embeds=inputs_embeds,
pixel_values=pixel_values, image_grid_thw=image_grid_thw, image_embeds=image_embeds,
video_pixel_values=video_pixel_values, video_grid_thw=video_grid_thw, video_embeds=video_embeds,
audio_codes=audio_codes, audio_embeds=audio_embeds,
)
input_ids = None
outputs: BaseModelOutputWithPast = self.model(
input_ids=input_ids,
attention_mask=attention_mask,
position_ids=position_ids,
past_key_values=past_key_values,
inputs_embeds=inputs_embeds,
use_cache=use_cache,
cache_position=cache_position,
**kwargs,
)
hidden_states = outputs.last_hidden_state
slice_indices = slice(-logits_to_keep, None) if isinstance(logits_to_keep, int) else logits_to_keep
logits = self.lm_head(hidden_states[:, slice_indices, :])
loss = None
if labels is not None:
loss = self.loss_function(logits=logits, labels=labels, vocab_size=self.config.vocab_size, **kwargs)
return CausalLMOutputWithPast(
loss=loss,
logits=logits,
past_key_values=outputs.past_key_values,
hidden_states=outputs.hidden_states,
attentions=outputs.attentions,
)
__all__ = [
"MiMoAudioTokenizer",
"MiMoAudioTokenizerConfig",
"MiMoV2Attention",
"MiMoV2DecoderLayer",
"MiMoV2ForCausalLM",
"MiMoV2MLP",
"MiMoV2MoE",
"MiMoV2MoEGate",
"MiMoV2Model",
"MiMoV2RMSNorm",
"MiMoV2RotaryEmbedding",
]
|