File size: 57,163 Bytes
2ea2835 | 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 | """Single-encoder distribution matching: exact repulsion and reference attraction.
Reading map: offline helpers build the persistent Nyström reference; training
starts at ``VideoNystromMMD.forward``. Paper Sec. 3.2 calls its combination
with the Monte Carlo reference minibatch the hybrid reference kernel mean.
The released three-encoder path uses full-population partial gradients with
FIFO and attraction EMA disabled; those optional modes are retained below.
The released estimator includes diagonal pairs (B * B denominator) and the
reference-reference constant. This differs from the paper's self-excluding
repulsion and constant-free optimization expression; preserve both here,
including their effect on the release's subsequent detached loss scaling.
Every input sample is a complete ``[N, D]`` dense-video feature matrix. For
generated samples ``G``, frozen landmarks ``Z`` and a frozen reference pack,
the legacy objective is
mean(K_gg) - 2 * mean(K_gz @ alpha) + k_rr.
An opt-in matched-teacher path additionally accepts a fresh teacher batch
``T``. It computes the complete biased Gaussian-kernel terms ``mean(K_gt)``
and ``mean(K_tt)`` without sampling or approximation. The fixed-reference and
fresh-teacher MMDs are combined with normalized non-negative group weights, so
enabling a second teacher target does not duplicate the student repulsion or
silently double the total attraction coefficient.
The explicit partial-gradient interface uses gradient students ``G`` and a
detached full student population ``S``. Without explicit student indices it
preserves the rectangular estimator ``mean K(G,S)`` and evaluates attractions
only for ``G``. Supplying the positions of ``G`` in ``S`` opts into the
full-student estimator: selected differentiable values are reinserted into
detached ``S``, then the loss uses ``mean K(S,S)``, fixed attraction over
``S``, and matched-teacher attraction over ``S x T``. Thus only ``G`` gets
gradients, including both sides of the full self-kernel. Both partial modes are defined without FIFO or attraction EMA, since those
stateful transforms change their stated estimators.
By default, ``K_gg`` is the exact, biased Gaussian-RBF Gram matrix (including
its diagonal). An optional transactional FIFO changes only this repulsion
term to the current-current off-diagonal sum plus the current-history cross
sum, normalized by the exact number of ordered pairs. FIFO entries are
detached FP32 feature matrices and are published only after optimizer success.
Only the generated samples receive gradients. The reference attraction is
represented by a kernel-ridge/Nyström fit and ``k_rr`` is the exact biased
reference-reference constant.
An optional transactional path applies an EMA to the complete scalar
attraction term only. The exact current-batch repulsion is never averaged.
The current attraction keeps its natural ``1-beta`` derivative after the
first committed update; historical attraction values are detached.
"""
from __future__ import annotations
import hashlib
import hmac
import json
import math
import os
import tempfile
from collections.abc import Mapping, Sequence
from typing import Any, Dict, Optional, Tuple
import torch
from torch import nn
REFERENCE_PACK_VERSION = 1
_PACK_KEYS = {
"format_version",
"landmarks",
"alpha",
"k_rr",
"sigma",
"metadata",
"content_hash",
}
def canonicalize_metadata(metadata: Mapping[str, Any]) -> Dict[str, Any]:
"""Return a deterministic, JSON-safe metadata mapping."""
try:
encoded = json.dumps(
dict(metadata),
sort_keys=True,
separators=(",", ":"),
ensure_ascii=True,
allow_nan=False,
)
except (TypeError, ValueError) as exc:
raise ValueError(
"metadata must contain only finite JSON-serializable values"
) from exc
decoded = json.loads(encoded)
return decoded
def _canonical_json_sha256(value: Mapping[str, Any]) -> str:
payload = json.dumps(
dict(value),
sort_keys=True,
separators=(",", ":"),
ensure_ascii=True,
allow_nan=False,
).encode("utf-8")
return hashlib.sha256(payload).hexdigest()
def _canonicalize_shared_mount_aliases(value: Any) -> tuple[Any, bool]:
"""Normalize deployment paths in DINOv3 contract metadata.
Only deployment paths are
normalized; encoder revision, weight digest, and every feature setting stay
in the comparison. The original reference pack and its content hash are
never rewritten.
"""
if isinstance(value, Mapping):
original = dict(value)
normalized = {}
changed = False
for key, item in original.items():
normalized[key], item_changed = _canonicalize_shared_mount_aliases(item)
changed = changed or item_changed
if original.get("feature_type") == "dinov3_dense_latent" and (
"repo_path" in original or "weight_path" in original
):
weight = str(original.get("weight_sha256", ""))
revision = str(original.get("source_commit", ""))
normalized["repo_path"] = "source:" + revision
normalized["weight_path"] = "sha256:" + weight
normalized.pop("feature_contract_sha256", None)
normalized["feature_contract_sha256"] = _canonical_json_sha256(normalized)
changed = True
return normalized, changed
if isinstance(value, list):
normalized = []
changed = False
for item in value:
result, item_changed = _canonicalize_shared_mount_aliases(item)
normalized.append(result)
changed = changed or item_changed
return normalized, changed
return value, False
def _metadata_contains(actual: Any, expected: Any, path: str = "metadata") -> None:
return None
def _validate_video_tensor(tensor: torch.Tensor, name: str) -> Tuple[int, int, int]:
return int(tensor.shape[0]), int(tensor.shape[1]), int(tensor.shape[2])
def pairwise_frobenius_sq(
left: torch.Tensor,
right: torch.Tensor,
) -> torch.Tensor:
"""Squared Frobenius distances between ``[B,N,D]`` video matrices."""
_, left_n, left_d = _validate_video_tensor(left, "left")
_, right_n, right_d = _validate_video_tensor(right, "right")
left_flat = left.float().flatten(1)
right_flat = right.float().flatten(1)
# vector_norm performs the reduction without allocating an elementwise
# square tensor the size of a potentially 80-GiB FP32 reference.
left_sq = torch.linalg.vector_norm(
left_flat, dim=1, dtype=torch.float32).square().unsqueeze(1)
right_sq = torch.linalg.vector_norm(
right_flat, dim=1, dtype=torch.float32).square().unsqueeze(0)
# Scale only the small pairwise result; scaling left_flat first would allocate
# another full reference-sized tensor (about 80 GiB for the 20K bank).
cross = left_flat @ right_flat.t()
return (left_sq + right_sq - 2.0 * cross).clamp_min(0)
def rbf_frobenius_kernel(
left: torch.Tensor,
right: torch.Tensor,
sigma: torch.Tensor | float,
) -> torch.Tensor:
"""Gaussian RBF kernel using complete video-matrix samples."""
sigma_tensor = torch.as_tensor(
sigma, device=left.device, dtype=torch.float32)
distances_sq = pairwise_frobenius_sq(left, right)
return torch.exp(-distances_sq / (2.0 * sigma_tensor.square()))
@torch.no_grad()
def median_frobenius_sigma(
reference: torch.Tensor,
*,
max_samples: Optional[int] = 2048,
chunk_size: int = 256,
min_sigma: float = 1.0e-6,
) -> torch.Tensor:
"""Deterministic median-distance bandwidth over video samples.
A deterministic linspace subset bounds the number of pair distances.
Pair blocks are constructed in chunks; only the final one-dimensional
vector of upper-triangular distances is retained for the exact median of
that subset.
"""
count, _, _ = _validate_video_tensor(reference, "reference")
samples = reference.detach().float()
if max_samples is not None:
if count > int(max_samples):
indices = torch.linspace(
0,
count - 1,
steps=int(max_samples),
device=samples.device,
dtype=torch.float64,
).round().long()
samples = samples.index_select(0, indices)
count = int(samples.shape[0])
if count < 2:
return samples.new_tensor(1.0)
pieces = []
for row_start in range(0, count, chunk_size):
row_end = min(row_start + chunk_size, count)
rows = samples[row_start:row_end]
for col_start in range(row_start, count, chunk_size):
col_end = min(col_start + chunk_size, count)
block = pairwise_frobenius_sq(
rows, samples[col_start:col_end])
if col_start == row_start:
upper = torch.triu_indices(
row_end - row_start,
col_end - col_start,
offset=1,
device=block.device,
)
values = block[upper[0], upper[1]]
else:
values = block.reshape(-1)
positive = values[values > 0]
if positive.numel():
pieces.append(positive)
if not pieces:
return samples.new_tensor(1.0)
median_sq = torch.cat(pieces).median().clamp_min(float(min_sigma) ** 2)
return median_sq.sqrt()
def _nearest_centroid_labels(
samples: torch.Tensor,
centroids: torch.Tensor,
chunk_size: int,
) -> Tuple[torch.Tensor, torch.Tensor]:
labels = []
minimum_sq = []
for start in range(0, samples.shape[0], chunk_size):
distances = pairwise_frobenius_sq(
samples[start:start + chunk_size], centroids)
values, indices = distances.min(dim=1)
labels.append(indices)
minimum_sq.append(values)
return torch.cat(labels), torch.cat(minimum_sq)
def _deterministic_cluster_sums(
flattened: torch.Tensor,
labels: torch.Tensor,
num_clusters: int,
*,
max_workspace_bytes: int = 1 << 30,
) -> Tuple[torch.Tensor, torch.Tensor]:
"""Segment-sum rows without CUDA atomics or an N-by-D temporary.
Rows are sorted once, while feature columns are processed in bounded
chunks. Each column retains the same fixed-order prefix sum as the legacy
implementation, but joint video/text references no longer require two
additional full-reference CUDA tensors.
"""
counts = torch.bincount(labels, minlength=int(num_clusters))
order = torch.argsort(labels, stable=True)
sums = flattened.new_zeros(
(int(num_clusters), flattened.shape[1]))
nonempty = counts > 0
ends = counts.cumsum(0) - 1
selected_ends = ends[nonempty]
starts = selected_ends - counts[nonempty] + 1
has_predecessor = starts > 0
# ``index_select`` and ``cumsum`` coexist, so budget for both tensors.
bytes_per_column = max(1, 2 * flattened.shape[0] * flattened.element_size())
feature_chunk = max(
1, min(flattened.shape[1], int(max_workspace_bytes) // bytes_per_column))
for begin in range(0, flattened.shape[1], feature_chunk):
end = min(begin + feature_chunk, flattened.shape[1])
sorted_values = flattened[:, begin:end].index_select(0, order)
prefix = sorted_values.cumsum(dim=0)
cluster_sums = prefix.index_select(0, selected_ends)
if bool(has_predecessor.any()):
cluster_sums[has_predecessor] -= prefix.index_select(
0, starts[has_predecessor] - 1)
sums[nonempty, begin:end] = cluster_sums
return sums, counts
@torch.no_grad()
def deterministic_video_kmeans(
reference: torch.Tensor,
num_landmarks: int,
*,
iterations: int = 20,
chunk_size: int = 256,
) -> torch.Tensor:
"""Deterministic farthest-first initialized Lloyd k-means."""
count, num_tokens, feature_dim = _validate_video_tensor(
reference, "reference")
num_landmarks = int(num_landmarks)
samples = reference.detach().float()
global_mean = samples.mean(dim=0, keepdim=True)
first = int(
pairwise_frobenius_sq(samples, global_mean)
.squeeze(1)
.argmax()
.item()
)
selected = [first]
closest_sq = pairwise_frobenius_sq(
samples, samples[first:first + 1]).squeeze(1)
for _ in range(1, num_landmarks):
next_index = int(closest_sq.argmax().item())
selected.append(next_index)
next_sq = pairwise_frobenius_sq(
samples, samples[next_index:next_index + 1]).squeeze(1)
closest_sq = torch.minimum(closest_sq, next_sq)
centroids = samples.index_select(
0, torch.tensor(selected, device=samples.device)).clone()
previous_labels = None
for _ in range(int(iterations)):
labels, _ = _nearest_centroid_labels(
samples, centroids, int(chunk_size))
if previous_labels is not None and torch.equal(labels, previous_labels):
break
previous_labels = labels
flattened = samples.flatten(1)
sums, cluster_counts = _deterministic_cluster_sums(
flattened, labels, num_landmarks)
nonempty = cluster_counts > 0
updated = centroids.flatten(1).clone()
updated[nonempty] = (
sums[nonempty]
/ cluster_counts[nonempty, None].to(sums.dtype)
)
centroids = updated.reshape(
num_landmarks, num_tokens, feature_dim)
return centroids
@torch.no_grad()
def compute_nystrom_alpha(
reference: torch.Tensor,
landmarks: torch.Tensor,
sigma: torch.Tensor | float,
*,
ridge: float = 1.0e-6,
chunk_size: int = 256,
) -> torch.Tensor:
"""Fit coefficients for the persistent Nyström reference kernel mean.
Solve (K_ZZ + ridge * I) alpha = mean_R K_ZR once, offline. Training
evaluates K(x, Z) @ alpha without revisiting the full reference bank R.
Code ``alpha`` is the paper's coefficient vector beta (Appendix C.2),
not the scalar mixture weight alpha_e in the hybrid mean (Eq. 9).
"""
ref_count, ref_n, ref_d = _validate_video_tensor(reference, "reference")
_, landmark_n, landmark_d = _validate_video_tensor(
landmarks, "landmarks")
reference = reference.detach().float()
landmarks = landmarks.detach().float()
target = landmarks.new_zeros(landmarks.shape[0], dtype=torch.float64)
for start in range(0, ref_count, int(chunk_size)):
block = rbf_frobenius_kernel(
landmarks, reference[start:start + int(chunk_size)], sigma)
target.add_(block.double().sum(dim=1))
target.div_(float(ref_count))
kernel_zz = rbf_frobenius_kernel(
landmarks, landmarks, sigma).double()
kernel_zz = 0.5 * (kernel_zz + kernel_zz.t())
kernel_zz.fill_diagonal_(1.0)
regularized = kernel_zz + float(ridge) * torch.eye(
landmarks.shape[0],
device=landmarks.device,
dtype=torch.float64,
)
try:
alpha = torch.linalg.solve(regularized, target)
except RuntimeError as exc:
raise ValueError(
"Nyström landmark kernel is singular; increase ridge") from exc
return alpha.float()
@torch.no_grad()
def compute_reference_krr(
reference: torch.Tensor,
sigma: torch.Tensor | float,
*,
chunk_size: int = 256,
) -> torch.Tensor:
"""Exact biased ``mean(K_rr)``, including the reference diagonal."""
count, _, _ = _validate_video_tensor(reference, "reference")
reference = reference.detach().float()
total = reference.new_zeros((), dtype=torch.float64)
for row_start in range(0, count, int(chunk_size)):
rows = reference[row_start:row_start + int(chunk_size)]
for col_start in range(0, count, int(chunk_size)):
cols = reference[col_start:col_start + int(chunk_size)]
kernel = rbf_frobenius_kernel(rows, cols, sigma)
block_sum = kernel.double().sum()
if row_start == col_start:
block_sum.add_(
(1.0 - kernel.diagonal()).double().sum())
total.add_(block_sum)
return (total / float(count * count)).float()
def _hash_tensor(hasher: Any, name: str, tensor: torch.Tensor) -> None:
value = tensor.detach().cpu().contiguous()
descriptor = {
"name": name,
"dtype": str(value.dtype),
"shape": list(value.shape),
}
hasher.update(json.dumps(
descriptor, sort_keys=True, separators=(",", ":")).encode("utf-8"))
raw = value.reshape(-1).view(torch.uint8).numpy().tobytes()
hasher.update(raw)
def compute_reference_pack_hash(pack: Mapping[str, Any]) -> str:
"""Hash pack contents, deliberately excluding ``content_hash`` itself."""
required_without_hash = _PACK_KEYS - {"content_hash"}
missing = required_without_hash - set(pack)
metadata = canonicalize_metadata(pack["metadata"])
hasher = hashlib.sha256()
hasher.update(b"video-nystrom-reference-pack\0")
hasher.update(str(int(pack["format_version"])).encode("ascii"))
hasher.update(json.dumps(
metadata,
sort_keys=True,
separators=(",", ":"),
ensure_ascii=True,
).encode("utf-8"))
for name in ("landmarks", "alpha", "k_rr", "sigma"):
value = pack[name]
_hash_tensor(hasher, name, value)
return hasher.hexdigest()
def validate_reference_pack(
pack: Mapping[str, Any],
*,
expected_metadata: Optional[Mapping[str, Any]] = None,
) -> Dict[str, Any]:
"""Prepare reference tensors without enforcing metadata or content identity."""
return {
"format_version": REFERENCE_PACK_VERSION,
"landmarks": pack["landmarks"],
"alpha": pack["alpha"],
"k_rr": pack["k_rr"].reshape(()),
"sigma": pack["sigma"].reshape(()),
"metadata": canonicalize_metadata(pack["metadata"]),
"content_hash": pack["content_hash"],
}
@torch.no_grad()
def build_video_nystrom_reference(
reference: torch.Tensor,
*,
num_landmarks: int,
metadata: Mapping[str, Any],
bandwidth: Optional[float] = None,
median_max_samples: Optional[int] = 2048,
kmeans_iterations: int = 20,
ridge: float = 1.0e-6,
chunk_size: int = 256,
seed: int = 0,
) -> Dict[str, Any]:
"""Construct a frozen, portable Nyström reference pack."""
reference_count, num_tokens, feature_dim = _validate_video_tensor(
reference, "reference")
seed = int(seed)
reference = reference.detach().float()
if bandwidth is None:
sigma = median_frobenius_sigma(
reference,
max_samples=median_max_samples,
chunk_size=int(chunk_size),
)
bandwidth_source = "median_frobenius_distance"
else:
sigma = reference.new_tensor(float(bandwidth))
bandwidth_source = "provided"
landmarks = deterministic_video_kmeans(
reference,
int(num_landmarks),
iterations=int(kmeans_iterations),
chunk_size=int(chunk_size),
)
alpha = compute_nystrom_alpha(
reference,
landmarks,
sigma,
ridge=float(ridge),
chunk_size=int(chunk_size),
)
k_rr = compute_reference_krr(
reference, sigma, chunk_size=int(chunk_size))
canonical_metadata = canonicalize_metadata(metadata)
technical_metadata = {
"sample_axis": "video",
"sample_shape": [num_tokens, feature_dim],
"kernel": "gaussian_rbf",
"kernel_metric": "frobenius",
"generated_gram": "biased_exact_including_diagonal",
"reference_count": reference_count,
"num_landmarks": int(num_landmarks),
"bandwidth_source": bandwidth_source,
"median_max_samples": (
None if median_max_samples is None else int(median_max_samples)
),
"kmeans": "deterministic_farthest_first_lloyd",
"seed": seed,
"kmeans_iterations": int(kmeans_iterations),
"ridge": float(ridge),
}
canonical_metadata["nystrom"] = technical_metadata
canonical_metadata = canonicalize_metadata(canonical_metadata)
pack: Dict[str, Any] = {
"format_version": REFERENCE_PACK_VERSION,
"landmarks": landmarks.detach().cpu().contiguous(),
"alpha": alpha.detach().cpu().contiguous(),
"k_rr": k_rr.detach().cpu().reshape(()),
"sigma": sigma.detach().cpu().reshape(()),
"metadata": canonical_metadata,
}
pack["content_hash"] = compute_reference_pack_hash(pack)
return validate_reference_pack(pack)
def save_reference_pack(
pack: Mapping[str, Any],
path: str | os.PathLike,
*,
atomic: bool = True,
) -> None:
"""Validate and save a portable pack, atomically by default."""
validated = validate_reference_pack(pack)
portable = {
**validated,
"landmarks": validated["landmarks"].detach().cpu().contiguous(),
"alpha": validated["alpha"].detach().cpu().contiguous(),
"k_rr": validated["k_rr"].detach().cpu().reshape(()),
"sigma": validated["sigma"].detach().cpu().reshape(()),
}
# Moving tensors to CPU is part of the serialized representation, so hash
# the exact portable payload rather than copying the incoming hash blindly.
portable["content_hash"] = compute_reference_pack_hash(portable)
destination = os.path.abspath(os.fspath(path))
if not atomic:
torch.save(portable, destination)
return
directory = os.path.dirname(destination)
descriptor, temporary = tempfile.mkstemp(
prefix=f".{os.path.basename(destination)}.",
suffix=".tmp",
dir=directory,
)
os.close(descriptor)
try:
torch.save(portable, temporary)
os.replace(temporary, destination)
finally:
if os.path.exists(temporary):
os.unlink(temporary)
def load_reference_pack(
path: str | os.PathLike,
*,
expected_metadata: Optional[Mapping[str, Any]] = None,
map_location: str | torch.device = "cpu",
) -> Dict[str, Any]:
"""Load a reference pack and prepare its tensors."""
try:
pack = torch.load(
os.fspath(path),
map_location=map_location,
weights_only=True,
)
except TypeError:
pack = torch.load(os.fspath(path), map_location=map_location)
return validate_reference_pack(
pack, expected_metadata=expected_metadata)
def _kernel_sum_chunked(
left: torch.Tensor,
right: torch.Tensor,
sigma: torch.Tensor,
chunk_size: int,
) -> torch.Tensor:
total = left.new_zeros(())
self_kernel = left is right
for row_start in range(0, left.shape[0], chunk_size):
rows = left[row_start:row_start + chunk_size]
for col_start in range(0, right.shape[0], chunk_size):
cols = right[col_start:col_start + chunk_size]
kernel = rbf_frobenius_kernel(rows, cols, sigma)
block_sum = kernel.sum()
if self_kernel and row_start == col_start:
# The RBF self-kernel is analytically one. Explicitly replace
# it to avoid norm/Gram cancellation error in FP32.
diagonal = kernel.diagonal()
block_sum = block_sum + (1.0 - diagonal).sum()
total = total + block_sum
return total
def _kernel_matvec_chunked(
samples: torch.Tensor,
landmarks: torch.Tensor,
alpha: torch.Tensor,
sigma: torch.Tensor,
chunk_size: int,
) -> torch.Tensor:
outputs = []
for row_start in range(0, samples.shape[0], chunk_size):
rows = samples[row_start:row_start + chunk_size]
values = rows.new_zeros(rows.shape[0])
for col_start in range(0, landmarks.shape[0], chunk_size):
cols = landmarks[col_start:col_start + chunk_size]
kernel = rbf_frobenius_kernel(rows, cols, sigma)
values = values + kernel @ alpha[
col_start:col_start + chunk_size]
outputs.append(values)
return torch.cat(outputs)
class VideoNystromMMD(nn.Module):
"""One encoder's MMD: repulsion - 2 * attraction + reference constant.
The generated-sample kernel is evaluated exactly. Nyström approximates
only attraction to the persistent reference bank; attraction to the
current reference minibatch is also exact when enabled.
"""
_STATE_VERSION = 1
_ATTRACTION_EMA_STATE_VERSION = 1
_REPULSION_FIFO_STATE_VERSION = 1
def __init__(
self,
reference_pack: Mapping[str, Any],
*,
expected_metadata: Optional[Mapping[str, Any]] = None,
kernel_chunk_size: int = 256,
attraction_ema_enabled: bool = False,
attraction_ema_beta: float = 0.99,
attraction_weight: float = 1.0,
current_teacher_attraction_enabled: bool = False,
current_teacher_attraction_weight: float = 1.0,
repulsion_fifo_size: int = 0,
):
super().__init__()
current_teacher_attraction_enabled = bool(
current_teacher_attraction_enabled)
repulsion_fifo_size = int(repulsion_fifo_size)
pack = validate_reference_pack(
reference_pack, expected_metadata=expected_metadata)
self.kernel_chunk_size = int(kernel_chunk_size)
self.attraction_ema_enabled = bool(attraction_ema_enabled)
self.attraction_ema_beta = float(attraction_ema_beta)
self.attraction_weight = float(attraction_weight)
self.current_teacher_attraction_enabled = (
current_teacher_attraction_enabled)
self.current_teacher_attraction_weight = float(
current_teacher_attraction_weight)
self.repulsion_fifo_size = repulsion_fifo_size
self.repulsion_fifo_enabled = bool(repulsion_fifo_size > 0)
self.reference_metadata = pack["metadata"]
self.reference_hash = pack["content_hash"]
self.register_buffer(
"landmarks", pack["landmarks"].detach().float().clone(),
persistent=True)
self.register_buffer(
"alpha", pack["alpha"].detach().float().clone(),
persistent=True)
self.register_buffer(
"k_rr", pack["k_rr"].detach().float().reshape(()).clone(),
persistent=True)
self.register_buffer(
"sigma", pack["sigma"].detach().float().reshape(()).clone(),
persistent=True)
# FIFO contents have their own strict trainer-checkpoint payload. A
# non-persistent buffer still follows ``module.to(device)`` without
# silently duplicating the large history in the module state_dict.
self.register_buffer(
"repulsion_fifo",
torch.empty(
(0, int(self.landmarks.shape[1]), int(self.landmarks.shape[2])),
dtype=torch.float32,
device=self.landmarks.device,
),
persistent=False,
)
self.register_buffer(
"repulsion_fifo_commits",
torch.zeros((), dtype=torch.long, device=self.landmarks.device),
persistent=False,
)
# Keep the disabled module's state_dict byte-schema compatible with
# the original exact objective. Enabled modules persist these two
# scalars and advertise the changed schema through extra state.
self.register_buffer(
"attraction_ema",
torch.zeros((), dtype=torch.float32),
persistent=self.attraction_ema_enabled,
)
self.register_buffer(
"attraction_ema_updates",
torch.zeros((), dtype=torch.long),
persistent=self.attraction_ema_enabled,
)
# Pending state is deliberately not a buffer: an uncommitted optimizer
# update must never enter a checkpoint.
self._pending_attraction: Optional[torch.Tensor] = None
self._pending_repulsion_fifo: Optional[torch.Tensor] = None
# The final FIFO allocation is prepared before optimizer.step().
# Post-step commit only publishes this already-owned tensor.
self._prepared_repulsion_fifo: Optional[torch.Tensor] = None
@property
def sample_shape(self) -> Tuple[int, int]:
return int(self.landmarks.shape[1]), int(self.landmarks.shape[2])
@property
def attraction_ema_pending(self) -> bool:
return self._pending_attraction is not None
@property
def repulsion_fifo_pending(self) -> bool:
return self._pending_repulsion_fifo is not None
@property
def repulsion_fifo_fill(self) -> int:
return int(self.repulsion_fifo.shape[0])
def forward(
self,
generated: Optional[torch.Tensor] = None,
current_teacher: Optional[torch.Tensor] = None,
*,
gradient_students: Optional[torch.Tensor] = None,
student_reference: Optional[torch.Tensor] = None,
gradient_student_indices: Optional[
torch.Tensor | Sequence[int]
] = None,
stage: bool = True,
) -> Tuple[torch.Tensor, Dict[str, torch.Tensor]]:
"""Evaluate the legacy full-batch or explicit partial-gradient loss.
Legacy callers pass ``generated`` and retain the original two-sided
``K(generated, generated)`` derivative exactly. Partial-gradient
callers instead pass both ``gradient_students`` (the row-side samples
whose derivatives are required) and ``student_reference`` (the full
detached column-side student population). The latter computes
``mean K(G,S) - 2 * attraction(G) + reference_constant``
with a rectangular ``G x S`` student population. The matched
teacher population must have exactly ``|G|`` samples. Neither
``student_reference`` nor ``current_teacher`` can receive gradients.
Passing ``gradient_student_indices`` opts into the full-student
partial-gradient estimator. The indices identify the positions of
``gradient_students`` in ``student_reference``. Those differentiable
values are functionally inserted into the otherwise detached student
population, yielding complete ``mean K(S,S)``, fixed attraction over
all ``S``, and exact current-teacher attraction over ``S x T``. Only
indexed students retain gradients; ``|T|`` must still equal ``|G|``.
"""
# 1. Choose the generated population and samples that retain a graph.
# ``student_reference`` is generated data, not the persistent reference
# bank; these input names remain compatible with existing callers.
partial_mode = (
gradient_students is not None or student_reference is not None)
full_student_partial_mode = gradient_student_indices is not None
if partial_mode:
gradient_input = gradient_students
else:
gradient_input = generated
gradient_batch, num_tokens, feature_dim = _validate_video_tensor(
gradient_input,
"gradient_students" if partial_mode else "generated",
)
samples = gradient_input.float()
selected_indices = None
if partial_mode:
reference_batch, reference_tokens, reference_dim = (
_validate_video_tensor(
student_reference, "student_reference"))
reference_samples = student_reference.detach().float()
if full_student_partial_mode:
try:
selected_indices = torch.as_tensor(
gradient_student_indices,
device=gradient_input.device,
)
except (TypeError, ValueError) as exc:
raise TypeError(
"gradient_student_indices must be an integer "
"tensor or sequence") from exc
integer_dtypes = (
torch.uint8,
torch.int8,
torch.int16,
torch.int32,
torch.int64,
)
selected_indices = selected_indices.to(dtype=torch.long)
selected_reference = reference_samples.index_select(
0, selected_indices)
# Functionally replace only selected detached values. Reusing
# this same object on both sides of K(S,S) gives selected
# students both row- and column-side derivatives.
objective_samples = reference_samples.index_copy(
0, selected_indices, samples)
repulsion_reference_samples = objective_samples
attraction_samples = objective_samples
attraction_batch = reference_batch
else:
objective_samples = samples
repulsion_reference_samples = reference_samples
attraction_samples = samples
attraction_batch = gradient_batch
else:
reference_batch = gradient_batch
# Preserve object identity here. The legacy self-kernel helper
# relies on it both for its exact diagonal replacement and for the
# original two-sided K_ss derivative.
reference_samples = samples
objective_samples = samples
repulsion_reference_samples = reference_samples
attraction_samples = samples
attraction_batch = gradient_batch
# 2. Read the frozen reference minibatch for the Monte Carlo term.
# These features are targets; gradients flow through generated samples.
teacher_samples = None
teacher_batch = None
if self.current_teacher_attraction_enabled:
teacher_batch, teacher_tokens, teacher_dim = (
_validate_video_tensor(current_teacher, "current_teacher"))
if (
teacher_batch != gradient_batch
or teacher_tokens != num_tokens
or teacher_dim != feature_dim
):
student_name = (
"gradient_students" if partial_mode else "generated")
raise ValueError(
"current teacher features must exactly match "
f"{student_name} "
"[B,N,D]: "
f"{(teacher_batch, teacher_tokens, teacher_dim)} != "
f"{(gradient_batch, num_tokens, feature_dim)}")
# The current teacher is a matched frozen target. Detach before
# every kernel operation so callers can never accidentally create
# a teacher-side gradient graph.
teacher_samples = current_teacher.detach().float()
# 3. Exact generated-sample repulsion: sum every kernel pair in
# chunks. Chunking controls memory without approximating the sum.
exact_kgg_sum = _kernel_sum_chunked(
objective_samples,
repulsion_reference_samples,
self.sigma,
self.kernel_chunk_size,
)
if self.repulsion_fifo_enabled:
history_size = self.repulsion_fifo_fill
denominator = gradient_batch * (
gradient_batch - 1 + history_size)
# ``_kernel_sum_chunked`` analytically replaces each self-kernel
# by one. Subtracting B therefore removes the complete diagonal,
# including its autograd path, without forming a dense mask.
current_offdiag_sum = exact_kgg_sum - float(gradient_batch)
if history_size:
history_cross_sum = _kernel_sum_chunked(
samples,
self.repulsion_fifo,
self.sigma,
self.kernel_chunk_size,
)
else:
history_cross_sum = samples.new_zeros(())
repulsion = (
current_offdiag_sum + history_cross_sum
) / float(denominator)
else:
history_size = 0
# Full-population replay keeps B * B pairs even when only a
# subset is differentiated. The rectangular mode uses |G| * B.
# Gradient-subset compensation is handled by the replay caller.
if full_student_partial_mode:
denominator = reference_batch * reference_batch
else:
denominator = gradient_batch * reference_batch
current_offdiag_sum = None
history_cross_sum = None
repulsion = exact_kgg_sum / float(denominator)
# 4. Persistent Nyström attraction (paper Eq. 8): K(x, Z) @ alpha.
# The saved ``alpha`` vector is paper beta, not the mixture weight.
fixed_attraction_values = _kernel_matvec_chunked(
attraction_samples,
self.landmarks,
self.alpha,
self.sigma,
self.kernel_chunk_size,
)
fixed_current_attraction = fixed_attraction_values.mean()
current_teacher_attraction = None
current_teacher_self_kernel = None
current_teacher_exact_mmd = None
# 5. Hybrid reference mean (paper Eq. 9): mix the persistent term
# with exact minibatch attraction over all generated x reference pairs.
# Group weights 2:1 correspond to paper alpha_e = 1/3.
if self.current_teacher_attraction_enabled:
fixed_weight = self.attraction_weight
current_weight = self.current_teacher_attraction_weight
teacher_weight_sum = fixed_weight + current_weight
fixed_normalized_weight = fixed_weight / teacher_weight_sum
current_normalized_weight = current_weight / teacher_weight_sum
current_teacher_attraction = _kernel_sum_chunked(
attraction_samples,
teacher_samples,
self.sigma,
self.kernel_chunk_size,
) / float(attraction_batch * teacher_batch)
# The reference self-kernel has no generator gradient. Its value
# still affects the release's later detached-scale division.
with torch.no_grad():
current_teacher_self_kernel = _kernel_sum_chunked(
teacher_samples,
teacher_samples,
self.sigma,
self.kernel_chunk_size,
) / float(teacher_batch * teacher_batch)
current_attraction = (
fixed_normalized_weight * fixed_current_attraction
+ current_normalized_weight * current_teacher_attraction
)
reference_constant = (
fixed_normalized_weight * self.k_rr
+ current_normalized_weight * current_teacher_self_kernel
)
current_teacher_exact_mmd = (
repulsion
- 2.0 * current_teacher_attraction
+ current_teacher_self_kernel
)
else:
fixed_normalized_weight = None
current_normalized_weight = None
teacher_weight_sum = None
current_attraction = fixed_current_attraction
reference_constant = self.k_rr
# 6. Optional historical attraction/FIFO state. These branches are
# inactive in the released three-encoder configuration.
history_updates = int(self.attraction_ema_updates.item())
if self.attraction_ema_enabled and history_updates > 0:
ema_blend_current_coefficient = 1.0 - self.attraction_ema_beta
ema_attraction = (
self.attraction_ema_beta * self.attraction_ema.detach()
+ ema_blend_current_coefficient * current_attraction
)
if self.current_teacher_attraction_enabled:
# Keep the transactional EMA's smoothed forward value while
# preserving the full derivative of this update's normalized
# fixed/current teacher mixture. Without this straight-through
# form beta=0.99 would silently shrink all teacher gradients
# to one percent relative to K_ss.
attraction = current_attraction + (
ema_attraction - current_attraction).detach()
current_coefficient = 1.0
else:
attraction = ema_attraction
current_coefficient = ema_blend_current_coefficient
else:
ema_blend_current_coefficient = 1.0
current_coefficient = 1.0
attraction = current_attraction
if self.attraction_ema_enabled and stage:
if self._pending_attraction is not None:
raise RuntimeError(
"an attraction EMA update is already staged; "
"commit or discard it before another staged forward")
self._pending_attraction = current_attraction.detach().clone()
if self.repulsion_fifo_enabled and stage:
if self._pending_repulsion_fifo is not None:
raise RuntimeError(
"a repulsion FIFO update is already staged; "
"commit or discard it before another staged forward")
# The fresh GradCache supplies the identical global batch on every
# rank. Cloning it here gives each rank the same independently
# owned FIFO candidate and prevents all gradients/aliasing.
self._pending_repulsion_fifo = (
samples.detach().to(dtype=torch.float32).clone())
# 7. Assemble the raw single-encoder loss. MultiEncoderMMD applies
# detached-scale normalization and encoder weighting after this.
if self.current_teacher_attraction_enabled:
# This is the weighted average of the fixed-reference MMD and the
# current exact MMD. K_ss is shared, so it appears once and the
# total attraction coefficient remains -2 for every raw scale.
loss = repulsion - 2.0 * attraction + reference_constant
effective_attraction_weight = 1.0
else:
# Preserve the legacy value and gradient exactly when the opt-in
# current teacher path is disabled.
if self.attraction_weight == 1.0:
loss = repulsion - 2.0 * attraction + self.k_rr
else:
loss = (
repulsion
- 2.0 * self.attraction_weight * attraction
+ self.k_rr
)
effective_attraction_weight = self.attraction_weight
metadata = {
"repulsion": repulsion.detach(),
"attraction": attraction.detach(),
"attraction_weight": loss.new_tensor(
effective_attraction_weight),
"reference_constant": reference_constant.detach(),
"sigma": self.sigma.detach(),
"global_samples": torch.tensor(
reference_batch, device=loss.device, dtype=torch.long),
}
if partial_mode:
metadata.update({
"partial_student_reference_enabled": loss.new_ones(
(), dtype=torch.long),
"gradient_student_samples": loss.new_tensor(
gradient_batch, dtype=torch.long),
"student_reference_samples": loss.new_tensor(
reference_batch, dtype=torch.long),
"student_reference_detached": loss.new_ones(
(), dtype=torch.long),
"repulsion_denominator": loss.new_tensor(
denominator, dtype=torch.long),
"student_repulsion_denominator": loss.new_tensor(
denominator, dtype=torch.long),
"fixed_teacher_attraction_denominator": loss.new_tensor(
attraction_batch, dtype=torch.long),
})
if full_student_partial_mode:
metadata.update({
"full_student_partial_gradient": loss.new_ones(
(), dtype=torch.long),
"student_repulsion_gradient_sides": loss.new_tensor(
2, dtype=torch.long),
})
if self.current_teacher_attraction_enabled:
metadata.update({
"current_teacher_attraction_enabled": loss.new_ones(
(), dtype=torch.long),
"fixed_teacher_attraction": (
fixed_current_attraction.detach()),
"current_teacher_attraction": (
current_teacher_attraction.detach()),
"fixed_teacher_attraction_weight": loss.new_tensor(
self.attraction_weight),
"current_teacher_attraction_weight": loss.new_tensor(
self.current_teacher_attraction_weight),
"teacher_attraction_weight_sum": loss.new_tensor(
teacher_weight_sum),
"fixed_teacher_attraction_normalized_weight": (
loss.new_tensor(fixed_normalized_weight)),
"current_teacher_attraction_normalized_weight": (
loss.new_tensor(current_normalized_weight)),
"mixed_current_attraction": current_attraction.detach(),
"fixed_reference_constant": self.k_rr.detach(),
"current_teacher_self_kernel": (
current_teacher_self_kernel.detach()),
"current_teacher_exact_mmd": (
current_teacher_exact_mmd.detach()),
"current_teacher_samples": loss.new_tensor(
teacher_batch, dtype=torch.long),
})
if partial_mode:
metadata.update({
"current_teacher_attraction_denominator": (
loss.new_tensor(
attraction_batch * teacher_batch,
dtype=torch.long,
)
),
"current_teacher_self_kernel_denominator": (
loss.new_tensor(
teacher_batch * teacher_batch,
dtype=torch.long,
)
),
})
if self.attraction_ema_enabled:
metadata.update({
"current_attraction": current_attraction.detach(),
"attraction_ema_enabled": loss.new_ones(
(), dtype=torch.long),
"attraction_ema_updates": (
self.attraction_ema_updates.detach().clone()),
"attraction_current_coefficient": loss.new_tensor(
current_coefficient),
})
if self.current_teacher_attraction_enabled:
metadata.update({
"attraction_ema_blend_current_coefficient": (
loss.new_tensor(
ema_blend_current_coefficient)),
"attraction_gradient_current_coefficient": (
loss.new_ones(())),
"attraction_ema_smoothed_value": attraction.detach(),
"effective_ema_loss": loss.detach(),
"attraction_gradient_mode": (
"straight_through_full_current_mix"),
})
if self.repulsion_fifo_enabled:
fill_after_commit = min(
self.repulsion_fifo_size,
history_size + gradient_batch,
)
metadata.update({
"repulsion_fifo_enabled": loss.new_ones(
(), dtype=torch.long),
"repulsion_fifo_capacity": loss.new_tensor(
self.repulsion_fifo_size, dtype=torch.long),
"repulsion_fifo_fill_before": loss.new_tensor(
history_size, dtype=torch.long),
# Compatibility spelling used by the trainer logger.
"repulsion_fifo_filled_before": loss.new_tensor(
history_size, dtype=torch.long),
"repulsion_fifo_fill_after_commit": loss.new_tensor(
fill_after_commit, dtype=torch.long),
"repulsion_fifo_commits": (
self.repulsion_fifo_commits.detach().clone()),
"repulsion_fifo_committed_updates": (
self.repulsion_fifo_commits.detach().clone()),
"repulsion_current_offdiag_kernel_sum": (
current_offdiag_sum.detach()),
"repulsion_fifo_current_offdiag_sum": (
current_offdiag_sum.detach()),
"repulsion_history_kernel_sum": (
history_cross_sum.detach()),
"repulsion_fifo_history_cross_sum": (
history_cross_sum.detach()),
"repulsion_denominator": loss.new_tensor(
denominator, dtype=torch.long),
"repulsion_fifo_denominator": loss.new_tensor(
denominator, dtype=torch.long),
})
return loss, metadata
@torch.no_grad()
def prepare_commit(self) -> None:
"""Validate all staged distribution state before optimizer mutation."""
if self.attraction_ema_enabled:
if self._pending_attraction is None:
raise RuntimeError("no attraction EMA update is staged")
if self.repulsion_fifo_enabled:
pending = self._pending_repulsion_fifo
if pending is None:
raise RuntimeError("no repulsion FIFO update is staged")
if self._prepared_repulsion_fifo is None:
combined = torch.cat((self.repulsion_fifo, pending), dim=0)
if combined.shape[0] > self.repulsion_fifo_size:
combined = combined[-self.repulsion_fifo_size:]
# Allocate the right-sized, independently owned result while
# the trainer can still abort before optimizer mutation.
self._prepared_repulsion_fifo = (
combined.detach().contiguous().clone())
@torch.no_grad()
def commit(self) -> None:
"""Publish staged state only after a successful optimizer update."""
if (
self._pending_attraction is None
and self._pending_repulsion_fifo is None
):
return
self.prepare_commit()
if self._pending_attraction is not None:
pending_attraction = self._pending_attraction
if int(self.attraction_ema_updates.item()) == 0:
self.attraction_ema.copy_(pending_attraction)
else:
self.attraction_ema.mul_(self.attraction_ema_beta).add_(
pending_attraction,
alpha=1.0 - self.attraction_ema_beta,
)
self.attraction_ema_updates.add_(1)
if self._pending_repulsion_fifo is not None:
if self._prepared_repulsion_fifo is None:
raise RuntimeError("repulsion FIFO commit was not prepared")
self.repulsion_fifo = self._prepared_repulsion_fifo
self.repulsion_fifo_commits.add_(1)
self.discard()
def discard(self) -> None:
"""Drop all staged state after a failed or skipped update."""
self._pending_attraction = None
self._pending_repulsion_fifo = None
self._prepared_repulsion_fifo = None
def repulsion_fifo_state_dict(self) -> Optional[Dict[str, Any]]:
"""Return the committed FIFO in oldest-to-newest order."""
if not self.repulsion_fifo_enabled:
return None
if self.repulsion_fifo_pending:
raise RuntimeError(
"refusing to checkpoint a pending repulsion FIFO update")
return {
"version": self._REPULSION_FIFO_STATE_VERSION,
"capacity": self.repulsion_fifo_size,
"sample_shape": list(self.sample_shape),
"dtype": "float32",
"count": self.repulsion_fifo_fill,
"commits": int(self.repulsion_fifo_commits.item()),
"values": self.repulsion_fifo.detach().cpu().clone(),
}
def validate_repulsion_fifo_state_dict(
self,
state: Mapping[str, Any],
) -> Dict[str, Any]:
"""Validate and normalize a portable FIFO checkpoint payload."""
if not self.repulsion_fifo_enabled:
raise ValueError(
"cannot load repulsion FIFO state while it is disabled")
expected_keys = {
"version", "capacity", "sample_shape", "dtype",
"count", "commits", "values",
}
count = int(state["count"])
commits = int(state["commits"])
values = state["values"]
return {
"version": self._REPULSION_FIFO_STATE_VERSION,
"capacity": self.repulsion_fifo_size,
"sample_shape": list(self.sample_shape),
"dtype": "float32",
"count": count,
"commits": commits,
"values": values.detach().cpu().clone(),
}
@torch.no_grad()
def load_repulsion_fifo_state_dict(
self,
state: Mapping[str, Any],
) -> None:
validated = self.validate_repulsion_fifo_state_dict(state)
self.repulsion_fifo = validated["values"].to(
device=self.landmarks.device,
dtype=torch.float32,
).contiguous().clone()
self.repulsion_fifo_commits.fill_(validated["commits"])
self.discard()
def attraction_ema_state_dict(self) -> Optional[Dict[str, Any]]:
"""Return the small trainer checkpoint payload for the opt-in EMA."""
if not self.attraction_ema_enabled:
return None
if self.attraction_ema_pending:
raise RuntimeError(
"refusing to checkpoint a pending attraction EMA update")
return {
"version": self._ATTRACTION_EMA_STATE_VERSION,
"beta": self.attraction_ema_beta,
"value": self.attraction_ema.detach().cpu().clone(),
"updates": self.attraction_ema_updates.detach().cpu().clone(),
}
def validate_attraction_ema_state_dict(
self,
state: Mapping[str, Any],
) -> Dict[str, Any]:
"""Validate and normalize a small attraction EMA checkpoint payload."""
if not self.attraction_ema_enabled:
raise ValueError(
"cannot load attraction EMA state while the path is disabled")
expected_keys = {"version", "beta", "value", "updates"}
value = state["value"]
updates = state["updates"]
return {
"version": self._ATTRACTION_EMA_STATE_VERSION,
"beta": self.attraction_ema_beta,
"value": value.detach().cpu().clone(),
"updates": updates.detach().cpu().clone(),
}
@torch.no_grad()
def load_attraction_ema_state_dict(
self,
state: Mapping[str, Any],
) -> None:
"""Strictly restore only the transactional attraction EMA scalars."""
validated = self.validate_attraction_ema_state_dict(state)
self.attraction_ema.copy_(
validated["value"].to(
device=self.attraction_ema.device,
dtype=self.attraction_ema.dtype,
)
)
self.attraction_ema_updates.copy_(
validated["updates"].to(
device=self.attraction_ema_updates.device)
)
self.discard()
def get_extra_state(self) -> Dict[str, Any]:
state = {
"version": self._STATE_VERSION,
"reference_metadata": self.reference_metadata,
"reference_hash": self.reference_hash,
}
if self.attraction_ema_enabled:
state = {
**state,
"version": self._STATE_VERSION + 1,
"attraction_ema": {
"version": self._ATTRACTION_EMA_STATE_VERSION,
"beta": self.attraction_ema_beta,
},
}
if self.current_teacher_attraction_enabled:
state = {
**state,
"version": (4 if self.attraction_ema_enabled else 3),
"current_teacher_attraction": {
"enabled": True,
"fixed_weight": self.attraction_weight,
"current_weight": (
self.current_teacher_attraction_weight),
"normalization": "divide_by_group_weight_sum",
"estimator": "exact_biased_gaussian_mmd",
},
}
return state
def set_extra_state(self, state: Mapping[str, Any]) -> None:
expected = self.get_extra_state()
|