-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmodel.py
More file actions
760 lines (651 loc) · 32.6 KB
/
model.py
File metadata and controls
760 lines (651 loc) · 32.6 KB
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
import torch
import threading
import torch.nn as nn
import torch.nn.init as init
import torch_scatter
import torch.nn.functional as F
import logging
import abc
from enum import Enum, auto
from types import SimpleNamespace
# PointBind / UniBind
from models import PointBind_models
from imagebind.lora import lora_load_state_dict, save_lora_weights, load_lora_weights
from binds.languagebind import (
LanguageBind, to_device,
LanguageBindImageTokenizer, LanguageBindVideoTokenizer, LanguageBindAudioTokenizer,
LanguageBindThermalTokenizer, LanguageBindDepthTokenizer
)
from transformers import CLIPProcessor, CLIPModel
# ImageBind
from binds.imagebind.models import imagebind_model
from data_util import load_and_transform_text
from binds.imagebind.models.imagebind_model import ModalityType as ImageBindModalityType
from imagebind.imagebind_model import ModalityType
from shared_types import Modality
class ForwardMode(Enum):
EMBEDDINGS = auto()
LOGITS = auto()
MODALITY_TEMPLATES = {
Modality.IMAGE: "a photo of a {}",
Modality.VIDEO: "a video of a {}",
Modality.DEPTH: "a depth photo of a {}",
Modality.THERMAL: "a photo of a {}",
Modality.AUDIO: "a sound of a {}",
Modality.POINT: "a 3D point cloud of a {}",
Modality.EVENT: "an event frame of a {}",
}
LANGUAGEBIND_MODEL_NAME_MAP = {
Modality.VIDEO: "LanguageBind_Video_FT",
Modality.AUDIO: "LanguageBind_Audio_FT",
Modality.THERMAL: "LanguageBind_Thermal",
Modality.IMAGE: "LanguageBind_Image",
Modality.DEPTH: "LanguageBind_Depth",
}
LANGUAGEBIND_TOKENIZER_MAP = {
Modality.IMAGE: LanguageBindImageTokenizer,
Modality.VIDEO: LanguageBindVideoTokenizer,
Modality.AUDIO: LanguageBindAudioTokenizer,
Modality.THERMAL: LanguageBindThermalTokenizer,
Modality.DEPTH: LanguageBindDepthTokenizer,
}
LANGUAGEBIND_TOKENIZER_NAME_MAP = {
Modality.IMAGE: "lb203/LanguageBind_Image",
Modality.VIDEO: "lb203/LanguageBind_Video",
Modality.AUDIO: "lb203/LanguageBind_Audio",
Modality.THERMAL: "lb203/LanguageBind_Thermal",
Modality.DEPTH: "lb203/LanguageBind_Depth",
}
IMAGEBIND_MODALITY_MAP = {
Modality.TEXT: ImageBindModalityType.TEXT,
Modality.IMAGE: ImageBindModalityType.VISION,
Modality.VIDEO: ImageBindModalityType.VISION,
Modality.AUDIO: ImageBindModalityType.AUDIO,
Modality.THERMAL: ImageBindModalityType.THERMAL,
Modality.DEPTH: ImageBindModalityType.DEPTH,
}
MODALITY_TO_MLP = {
Modality.IMAGE: "mlp_for_image",
Modality.VIDEO: "mlp_for_video",
Modality.AUDIO: "mlp_for_audio",
Modality.THERMAL: "mlp_for_thermal",
Modality.POINT: "mlp_for_point",
Modality.EVENT: "mlp_for_event",
}
MODALITY_MAP = {
Modality.IMAGE: ModalityType.VISION,
Modality.VIDEO: ModalityType.VISION,
Modality.AUDIO: ModalityType.AUDIO,
Modality.THERMAL: ModalityType.THERMAL,
Modality.EVENT: ModalityType.VISION,
Modality.POINT: ModalityType.POINT,
Modality.TEXT: ModalityType.TEXT,
}
# ============================ Shared Model Base ============================
class Model(nn.Module):
@abc.abstractmethod
def forward(self, x, mode: ForwardMode):
pass
@abc.abstractmethod
def extract_tensor(self, x):
pass
@abc.abstractmethod
def wrap_tensor(self, x):
pass
@abc.abstractmethod
def data_to_device(self, x, device):
pass
class UniBind(nn.Module):
def __init__(self, args, use_flash_attention=False, use_lora=False, lora_rank=4, lora_alpha=8,
use_modality_head_mlp=False, lora_weights=None, modality_head_mlp_weights=None, logger=None):
super(UniBind, self).__init__()
self.logger = logger or logging.getLogger(__name__)
self.modality = args.modality
self.use_modality_head_mlp = use_modality_head_mlp
self.backbone = PointBind_models.PointBind_I2PMAE(
use_flash_attention=use_flash_attention, use_lora=use_lora, lora_rank=lora_rank, lora_alpha=lora_alpha
)
state_dict = torch.load(args.pretrain_weights, weights_only=True, map_location='cpu')
if lora_weights is not None:
self.logger.info(f"[UniBind init] use_lora: {use_lora}")
self.logger.info(f"[UniBind init] Loading LoRA weights from '{lora_weights}'...")
lora_state_dict = torch.load(lora_weights, weights_only=True, map_location='cpu')
state_dict.update(lora_state_dict)
self.logger.info("[UniBind init] Loaded LoRA weights.")
# Allow deprecated vision head keys from older checkpoints
allow_unexpected = ('bind.modality_heads.vision.2.weight', 'bind.modality_heads.vision.2.bias')
lora_load_state_dict(self.backbone, state_dict, allow_unexpected_keys=allow_unexpected)
# Create modality-specific MLP (frozen by default unless use_modality_head_mlp=True)
if self.modality == Modality.IMAGE:
self.mlp_for_image = init_linear_as_identity(nn.Linear(1024, 1024))
self.mlp_for_image.requires_grad_(use_modality_head_mlp)
elif self.modality == Modality.VIDEO:
self.mlp_for_video = init_linear_as_identity(nn.Linear(1024, 1024))
self.mlp_for_video.requires_grad_(use_modality_head_mlp)
elif self.modality == Modality.AUDIO:
self.mlp_for_audio = init_linear_as_identity(nn.Linear(1024, 1024))
self.mlp_for_audio.requires_grad_(use_modality_head_mlp)
elif self.modality == Modality.THERMAL:
self.mlp_for_thermal = init_linear_as_identity(nn.Linear(1024, 1024))
self.mlp_for_thermal.requires_grad_(use_modality_head_mlp)
elif self.modality == Modality.POINT:
self.mlp_for_point = init_linear_as_identity(nn.Linear(1024, 1024))
self.mlp_for_point.requires_grad_(use_modality_head_mlp)
elif self.modality == Modality.EVENT:
self.mlp_for_event = init_linear_as_identity(nn.Linear(1024, 1024))
self.mlp_for_event.requires_grad_(use_modality_head_mlp)
else:
raise ValueError(f"Unsupported modality: {self.modality}")
if modality_head_mlp_weights is not None:
self.logger.info(f"[UniBind init] Loading MLP submodules from '{modality_head_mlp_weights}'...")
self.load_modality_head_mlp_weights(modality_head_mlp_weights)
self.logger.info(f"[UniBind init] freeze all parameters")
self.freeze_all()
def forward(self, inputs, only_cls=True):
if self.modality == Modality.IMAGE:
outputs = self.__bind(inputs, only_cls)
text_embeddings = outputs[ImageBindModalityType.TEXT]
if self.use_modality_head_mlp:
vision_embeddings = self.mlp_for_image(outputs[ImageBindModalityType.VISION])
else:
vision_embeddings = outputs[ImageBindModalityType.VISION]
elif self.modality == Modality.VIDEO:
outputs = self.__bind(inputs, only_cls)
text_embeddings = outputs[ImageBindModalityType.TEXT]
if self.use_modality_head_mlp:
vision_embeddings = self.mlp_for_video(outputs[ImageBindModalityType.VISION])
else:
vision_embeddings = outputs[ImageBindModalityType.VISION]
elif self.modality == Modality.AUDIO:
outputs = self.__bind(inputs, only_cls)
text_embeddings = outputs[ImageBindModalityType.TEXT]
if self.use_modality_head_mlp:
vision_embeddings = self.mlp_for_audio(outputs[ImageBindModalityType.AUDIO])
else:
vision_embeddings = outputs[ImageBindModalityType.AUDIO]
elif self.modality == Modality.THERMAL:
outputs = self.__bind(inputs)
text_embeddings = outputs[ImageBindModalityType.TEXT]
if self.use_modality_head_mlp:
vision_embeddings = self.mlp_for_thermal(outputs[ImageBindModalityType.THERMAL])
else:
vision_embeddings = outputs[ImageBindModalityType.THERMAL]
elif self.modality == Modality.EVENT:
outputs = self.__bind(inputs, only_cls)
text_embeddings = outputs[ImageBindModalityType.TEXT]
if self.use_modality_head_mlp:
vision_embeddings = self.mlp_for_event(outputs[ImageBindModalityType.VISION])
else:
vision_embeddings = outputs[ImageBindModalityType.VISION]
elif self.modality == Modality.POINT:
pc_embeddings = self.backbone.encode_pc(inputs['point'])
pc_embeddings = self.backbone.bind.modality_head_point(pc_embeddings)
pc_embeddings = self.backbone.bind.modality_postprocessor_point(pc_embeddings)
outputs = self.__bind({ImageBindModalityType.TEXT: inputs['text']}, only_cls)
text_embeddings = outputs[ImageBindModalityType.TEXT]
if self.use_modality_head_mlp:
vision_embeddings = self.mlp_for_point(pc_embeddings)
else:
vision_embeddings = pc_embeddings
text_embeddings = text_embeddings / text_embeddings.norm(dim=-1, keepdim=True)
vision_embeddings = vision_embeddings / vision_embeddings.norm(dim=-1, keepdim=True)
return text_embeddings, vision_embeddings
def encode_vision(self, inputs, only_cls=True):
if self.modality == Modality.IMAGE:
outputs = self.__bind(inputs, only_cls)
vision_embeddings = outputs[ImageBindModalityType.VISION]
elif self.modality == Modality.VIDEO:
outputs = self.__bind(inputs, only_cls)
vision_embeddings = outputs[ImageBindModalityType.VISION]
elif self.modality == Modality.AUDIO:
outputs = self.__bind(inputs, only_cls)
vision_embeddings = outputs[ImageBindModalityType.AUDIO]
elif self.modality == Modality.THERMAL:
outputs = self.__bind(inputs, only_cls)
vision_embeddings = outputs[ImageBindModalityType.THERMAL]
elif self.modality == Modality.EVENT:
outputs = self.__bind(inputs, only_cls)
vision_embeddings = outputs[ImageBindModalityType.VISION]
elif self.modality == Modality.POINT:
pc_embeddings = self.backbone.encode_pc(inputs['point'])
pc_embeddings = self.backbone.bind.modality_head_point(pc_embeddings)
vision_embeddings = self.backbone.bind.modality_postprocessor_point(pc_embeddings)
return vision_embeddings / vision_embeddings.norm(dim=-1, keepdim=True)
def encode_vision_with_mlp(self, inputs, only_cls=True):
if self.modality == Modality.IMAGE:
outputs = self.__bind(inputs, only_cls)
if self.use_modality_head_mlp:
vision_embeddings = self.mlp_for_image(outputs[ImageBindModalityType.VISION])
else:
vision_embeddings = outputs[ImageBindModalityType.VISION]
elif self.modality == Modality.VIDEO:
outputs = self.__bind(inputs, only_cls)
if self.use_modality_head_mlp:
vision_embeddings = self.mlp_for_video(outputs[ImageBindModalityType.VISION])
else:
vision_embeddings = outputs[ImageBindModalityType.VISION]
elif self.modality == Modality.AUDIO:
outputs = self.__bind(inputs, only_cls)
if self.use_modality_head_mlp:
vision_embeddings = self.mlp_for_audio(outputs[ImageBindModalityType.AUDIO])
else:
vision_embeddings = outputs[ImageBindModalityType.AUDIO]
elif self.modality == Modality.THERMAL:
outputs = self.__bind(inputs, only_cls)
if self.use_modality_head_mlp:
vision_embeddings = self.mlp_for_thermal(outputs[ImageBindModalityType.THERMAL])
else:
vision_embeddings = outputs[ImageBindModalityType.THERMAL]
elif self.modality == Modality.EVENT:
outputs = self.__bind(inputs, only_cls)
if self.use_modality_head_mlp:
vision_embeddings = self.mlp_for_event(outputs[ImageBindModalityType.VISION])
else:
vision_embeddings = outputs[ImageBindModalityType.VISION]
elif self.modality == Modality.POINT:
pc_embeddings = self.backbone.encode_pc(inputs['point'])
pc_embeddings = self.backbone.bind.modality_head_point(pc_embeddings)
pc_embeddings = self.backbone.bind.modality_postprocessor_point(pc_embeddings)
if self.use_modality_head_mlp:
vision_embeddings = self.mlp_for_point(pc_embeddings)
else:
vision_embeddings = pc_embeddings
return vision_embeddings / vision_embeddings.norm(dim=-1, keepdim=True)
def encode_text(self, inputs):
text_embeddings = self.__bind(inputs)[ImageBindModalityType.TEXT]
return text_embeddings / text_embeddings.norm(dim=-1, keepdim=True)
def save_modality_head_mlp_weights(self, checkpoint_path: str):
mlps_dict = {}
for mod, mlp_attr in MODALITY_TO_MLP.items():
if hasattr(self, mlp_attr):
mlp_module = getattr(self, mlp_attr)
mlps_dict[mlp_attr] = mlp_module.state_dict()
torch.save(mlps_dict, checkpoint_path)
self.logger.info(f"[save_modality_head_mlp_weights] Saved all MLP submodules to '{checkpoint_path}'.")
def load_modality_head_mlp_weights(self, checkpoint_path: str, map_location='cpu'):
mlps_dict = torch.load(checkpoint_path, weights_only=True, map_location=map_location)
for mlp_attr, state_dict in mlps_dict.items():
if hasattr(self, mlp_attr):
getattr(self, mlp_attr).load_state_dict(state_dict)
self.logger.info(f"[load_modality_head_mlp_weights] Loaded '{mlp_attr}' from '{checkpoint_path}'.")
else:
self.logger.warning(f"[load_modality_head_mlp_weights] This model has no '{mlp_attr}' attribute. Skipping.")
def load_lora_weights(self, checkpoint_path: str):
self.logger.info(f"[load_lora_weights] Loading LoRA weights from '{checkpoint_path}'...")
load_lora_weights(self.backbone, checkpoint_path)
self.logger.info("[load_lora_weights] Loaded LoRA weights.")
def save_lora_weights(self, checkpoint_path: str):
self.logger.info(f"[save_lora_weights] Saving LoRA weights to '{checkpoint_path}'...")
save_lora_weights(self.backbone, checkpoint_path)
def freeze_all(self):
for p in self.parameters():
p.requires_grad = False
def enable_full_fine_tune(self):
"""Enable training of the entire backbone; keep modality-specific MLPs frozen."""
for _, p in self.backbone.named_parameters():
p.requires_grad = True
for mlp_attr in MODALITY_TO_MLP.values():
if hasattr(self, mlp_attr):
for p in getattr(self, mlp_attr).parameters():
p.requires_grad = False
def enable_lora(self):
"""Enable training only for LoRA adapter parameters."""
for n, p in self.named_parameters():
p.requires_grad = ("lora_down" in n or "lora_up" in n)
def enable_modality_head_mlp(self):
"""Enable training ONLY for the current modality's head MLP."""
for p in self.parameters():
p.requires_grad = False
mlp_attr = MODALITY_TO_MLP.get(self.modality, None)
if mlp_attr is None or not hasattr(self, mlp_attr):
raise ValueError(f"No MLP head found for modality {self.modality}")
for p in getattr(self, mlp_attr).parameters():
p.requires_grad = True
def unfreeze_all(self):
for p in self.parameters():
p.requires_grad = True
def save_backbone(self, path: str):
torch.save(self.backbone.state_dict(), path)
def load_backbone(self, path: str, strict: bool = True):
sd = torch.load(path, map_location="cpu", weights_only=True)
self.backbone.load_state_dict(sd, strict=strict)
def __bind(self, inputs, only_cls=True):
return self.backbone.bind(inputs, only_cls)
def init_linear_as_identity(linear_layer):
assert linear_layer.in_features == linear_layer.out_features
init.eye_(linear_layer.weight)
nn.init.zeros_(linear_layer.bias)
return linear_layer
# ============================ UniBindClassifier ============================
class UniBindClassifier(Model):
def __init__(
self,
device,
pretrain_weights,
modality,
centre_embeddings=None,
centre_labels=None,
label_to_index=None,
logger=None,
use_flash_attention=False,
use_lora=False,
lora_rank=4,
lora_alpha=8,
use_modality_head_mlp=False,
lora_weights=None,
modality_head_mlp_weights=None,
use_masked_logsumexp=False,
):
super().__init__()
self.logger = logger if logger else logging.getLogger(__name__)
self.logger.info("Initializing UniBindClassifier...")
self.logger.info(f"Use LoRa: {use_lora}, LoRa rank: {lora_rank}, LoRa alpha: {lora_alpha}")
self.unibind = UniBind(
SimpleNamespace(pretrain_weights=pretrain_weights, modality=modality),
use_flash_attention=use_flash_attention,
modality_head_mlp_weights=modality_head_mlp_weights,
lora_weights=lora_weights,
logger=self.logger,
use_lora=use_lora,
lora_rank=lora_rank,
lora_alpha=lora_alpha,
use_modality_head_mlp=use_modality_head_mlp,
)
self.modality = modality
self.label_to_index_map = label_to_index
self.use_masked_logsumexp = use_masked_logsumexp
if centre_embeddings is not None:
self.logger.info("Storing centre embeddings on device...")
self.centre_embeddings = centre_embeddings.to(device)
if centre_labels is not None:
self.logger.info("Building centre_label_indices...")
self.centre_label_indices = torch.tensor(
[self.label_to_index_map[lbl] for lbl in centre_labels],
dtype=torch.int64,
device=device
)
self.num_classes = len(self.label_to_index_map)
mask = F.one_hot(self.centre_label_indices, num_classes=self.num_classes).T.bool()
self.register_buffer("centre_class_mask", mask)
def forward(self, x, mode: ForwardMode, only_cls=True):
if mode == ForwardMode.EMBEDDINGS:
return self._encode(x, only_cls=only_cls)
elif mode == ForwardMode.LOGITS:
return self._logits(x, only_cls=only_cls)
else:
raise ValueError(f"Unknown mode: {mode}")
def extract_tensor(self, x):
return x
def wrap_tensor(self, x):
return x
def data_to_device(self, x, device):
return x.to(device)
def encode_text(self, x):
input_dict = {ModalityType.TEXT: x}
return self.unibind.encode_text(input_dict)
def _logits(self, x, temperature=1000.0, only_cls=True):
embeddings = self._encode(x, only_cls=only_cls)
similarity = embeddings @ self.centre_embeddings.t()
logits = self._compute_class_logits(similarity, temperature)
return logits, similarity
def _encode(self, x, only_cls=True):
modality = MODALITY_MAP[self.modality]
inp_dict = {modality: x}
emb = self.unibind.encode_vision_with_mlp(inp_dict, only_cls=only_cls)
return emb / emb.norm(dim=-1, keepdim=True)
def save_lora_weights(self, path: str):
self.logger.info(f"[save_lora_weights] Saving LoRA weights to '{path}'...")
self.unibind.save_lora_weights(path)
def load_lora_weights(self, path: str):
self.logger.info(f"[load_lora_weights] Loading LoRA weights from '{path}'...")
self.unibind.load_lora_weights(path)
def save_modality_head_mlp_weights(self, path: str):
self.logger.info(f"[save_modality_head_mlp_weights] Saving fine tuned weights to '{path}'...")
self.unibind.save_modality_head_mlp_weights(path)
def load_modality_head_mlp_weights(self, path: str):
self.logger.info(f"[load_modality_head_mlp_weights] Loading fine tuned weights from '{path}'...")
self.unibind.load_modality_head_mlp_weights(path)
def encode_vision(self, x, only_cls: bool = True):
"""Return normalized vision embeddings without applying modality head MLP (unless inherent)."""
modality = MODALITY_MAP[self.modality]
return self.unibind.encode_vision({modality: x}, only_cls=only_cls)
def encode_vision_with_mlp(self, x, only_cls: bool = True):
"""Return normalized vision embeddings passing through modality head MLP if enabled."""
modality = MODALITY_MAP[self.modality]
return self.unibind.encode_vision_with_mlp({modality: x}, only_cls=only_cls)
def freeze_all(self):
"""Freeze all parameters in underlying UniBind."""
self.unibind.freeze_all()
def unfreeze_all(self):
"""Unfreeze all parameters in underlying UniBind."""
self.unibind.unfreeze_all()
def enable_full_fine_tune(self):
"""Enable full backbone fine-tuning (MLP heads remain frozen)."""
self.unibind.enable_full_fine_tune()
def enable_lora(self):
"""Enable training only LoRA adapter parameters."""
self.unibind.enable_lora()
def enable_modality_head_mlp(self):
"""Enable training for the current modality's head MLP only."""
self.unibind.enable_modality_head_mlp()
def save_backbone(self, path: str):
"""Save underlying backbone state dict."""
self.unibind.save_backbone(path)
def load_backbone(self, path: str, strict: bool = True):
"""Load backbone weights into underlying UniBind."""
self.unibind.load_backbone(path, strict=strict)
def _compute_class_logits(self, similarity: torch.Tensor, temperature: float) -> torch.Tensor:
if self.use_masked_logsumexp:
return self._masked_logsumexp(similarity, temperature)
else:
return self._scatter_logsumexp(similarity, temperature)
def _masked_logsumexp(self, similarity: torch.Tensor, temperature: float) -> torch.Tensor:
B, N = similarity.shape
C = self.num_classes
mask = self.centre_class_mask # (C, N)
similarity_exp = similarity.unsqueeze(1) # (B, 1, N)
mask_exp = mask.unsqueeze(0).expand(B, C, N) # (B, C, N)
masked = similarity_exp.masked_fill(~mask_exp, -1e9) # (B, C, N)
return torch.logsumexp(masked * temperature, dim=2) / temperature # (B, C)
def _scatter_logsumexp(self, similarity: torch.Tensor, temperature: float) -> torch.Tensor:
class_raw_scores = torch_scatter.scatter_logsumexp(similarity * temperature, self.centre_label_indices, dim=1)
return class_raw_scores / temperature
# ============================ LanguageBindClassifier ============================
class LanguageBindClassifier(Model):
def __init__(self, device, modality, class_strings, logger=None, label_to_index=None):
super().__init__()
self.device = device
self.modality = modality
# If a label->index mapping is provided, construct class_strings in the same
# order so that class_embeddings[i] corresponds to numeric class index i.
if label_to_index is not None:
ordered = [lbl for lbl, _ in sorted(label_to_index.items(), key=lambda kv: kv[1])]
self.class_strings = ordered
else:
self.class_strings = class_strings
self.logger = logger or logging.getLogger(__name__)
template = MODALITY_TEMPLATES.get(modality, "a {}")
prompts = [template.format(cls) for cls in class_strings]
model_name = LANGUAGEBIND_MODEL_NAME_MAP[modality]
self.languagebind = LanguageBind(clip_type={modality.value: model_name}, cache_dir='.cache')
self.languagebind = self.languagebind.to(device)
self.languagebind.eval()
tokenizer_class = LANGUAGEBIND_TOKENIZER_MAP[modality]
tokenizer = tokenizer_class.from_pretrained(
LANGUAGEBIND_TOKENIZER_NAME_MAP[self.modality],
cache_dir="./cache/tokenizer"
)
tokens = tokenizer(prompts, max_length=77, padding="max_length", truncation=True, return_tensors="pt")
tokens = to_device(tokens, device)
text_embs = self.encode_text(tokens)
self.class_embeddings = text_embs
def forward(self, x, mode: ForwardMode):
if mode == ForwardMode.EMBEDDINGS:
return self._encode(x)
elif mode == ForwardMode.LOGITS:
return self._logits(x)
else:
raise ValueError(f"Unknown mode: {mode}")
def extract_tensor(self, x):
if self.modality == Modality.IMAGE:
return x["pixel_values"]
elif self.modality == Modality.VIDEO:
return x["pixel_values"]
elif self.modality == Modality.AUDIO:
return x["pixel_values"]
elif self.modality == Modality.THERMAL:
return x["pixel_values"]
elif self.modality == Modality.DEPTH:
return x["pixel_values"]
elif self.modality == Modality.EVENT:
return x["pixel_values"]
elif self.modality == Modality.POINT:
return x["point"]
else:
raise ValueError(f"Unknown modality: {self.modality}")
def wrap_tensor(self, x_tensor):
if self.modality == Modality.IMAGE:
return {"pixel_values": x_tensor}
elif self.modality == Modality.VIDEO:
return {"pixel_values": x_tensor}
elif self.modality == Modality.AUDIO:
return {"pixel_values": x_tensor}
elif self.modality == Modality.THERMAL:
return {"pixel_values": x_tensor}
elif self.modality == Modality.DEPTH:
return {"pixel_values": x_tensor}
elif self.modality == Modality.EVENT:
return {"pixel_values": x_tensor}
elif self.modality == Modality.POINT:
return {"point": x_tensor}
else:
raise ValueError(f"Unknown modality: {self.modality}")
def data_to_device(self, x, device):
return to_device(x, device)
def encode_text(self, x):
with torch.no_grad():
emb = self.languagebind({'language': x})['language']
return emb / emb.norm(dim=-1, keepdim=True)
def modality_config(self):
return self.languagebind.modality_config[self.modality.value]
def _encode(self, x):
# x is already transformed and on device
emb = self.languagebind({self.modality.value: x})[self.modality.value]
return emb / emb.norm(dim=-1, keepdim=True)
def _logits(self, x, temperature=100.0):
emb = self._encode(x)
logits = emb @ self.class_embeddings.T
return logits / temperature, logits
# ============================ ImageBindClassifier ============================
class ImageBindClassifier(Model):
def __init__(self, device, modality, class_strings, logger=None, label_to_index=None):
super().__init__()
self.device = device
self.modality = modality
# Align class_strings ordering with label_to_index if provided
if label_to_index is not None:
ordered = [lbl for lbl, _ in sorted(label_to_index.items(), key=lambda kv: kv[1])]
self.class_strings = ordered
else:
self.class_strings = class_strings
self.logger = logger or logging.getLogger(__name__)
template = MODALITY_TEMPLATES.get(modality, "a {}")
text_list = [template.format(cls) for cls in class_strings]
self.model = imagebind_model.imagebind_huge(pretrained=True).to(device)
self.model.eval()
tokens = load_and_transform_text(text_list, device)
with torch.no_grad():
text_embs = self.model({ImageBindModalityType.TEXT: tokens})[ImageBindModalityType.TEXT]
self.class_embeddings = text_embs / text_embs.norm(dim=-1, keepdim=True)
def forward(self, x, mode: ForwardMode):
if mode == ForwardMode.EMBEDDINGS:
return self._encode(x)
elif mode == ForwardMode.LOGITS:
return self._logits(x)
raise ValueError(f"Unknown mode: {mode}")
def extract_tensor(self, x):
return x
def wrap_tensor(self, x_tensor):
return x_tensor
def data_to_device(self, x, device):
return x.to(device)
def _encode(self, x):
imagebind_modality = IMAGEBIND_MODALITY_MAP[self.modality]
emb = self.model({IMAGEBIND_MODALITY_MAP[self.modality]: x})[imagebind_modality]
return emb / emb.norm(dim=-1, keepdim=True)
def _logits(self, x, temperature=100.0):
emb = self._encode(x)
logits = emb @ self.class_embeddings.T
return logits / temperature, logits
# ============================ CLIPClassifier (true CLIP) ============================
class CLIPClassifier(Model):
"""Simple wrapper around Hugging Face CLIPModel to provide the same Model interface.
Exposes forward(x, mode) where x is expected to be an image tensor of shape [B, C, H, W]
with pixel values in [0, 1] (the caller should ensure preprocessing / normalization).
"""
def __init__(self, device, modality, class_strings, logger=None, model_name: str = "openai/clip-vit-large-patch14", label_to_index=None):
super().__init__()
self.device = device
self.modality = modality
# If label_to_index provided, use its ordering to build class_strings so
# the numeric class indices match the classifier embeddings ordering.
if label_to_index is not None:
ordered = [lbl for lbl, _ in sorted(label_to_index.items(), key=lambda kv: kv[1])]
self.class_strings = ordered
else:
self.class_strings = class_strings
self.logger = logger or logging.getLogger(__name__)
self.model_name = model_name
# CLIPClassifier allows gradients through the CLIP encoders by default.
# Load CLIP model + processor
self.processor = CLIPProcessor.from_pretrained(self.model_name, cache_dir="./.cache/clip")
self.clip = CLIPModel.from_pretrained(self.model_name, cache_dir="./.cache/clip").to(device)
self.clip.eval()
# Build text prompts and compute class embeddings once
# If the caller passed class_strings derived from label_to_index we'll
# assume they are already in the correct, deduplicated order. Otherwise
# fall back to the previous behavior (dedupe+sort).
if label_to_index is None:
unique_labels = sorted(set(self.class_strings))
if len(unique_labels) != len(self.class_strings):
self.logger.info(f"CLIPClassifier: deduplicated {len(self.class_strings)} centre labels -> {len(unique_labels)} classes")
self.class_strings = unique_labels
template = MODALITY_TEMPLATES.get(modality, "a {}")
prompts = [template.format(cls) for cls in self.class_strings]
# Tokenize text and move to device
tok = self.processor(text=prompts, padding=True, truncation=True, return_tensors="pt")
tok = {k: v.to(self.device) for k, v in tok.items()}
# Compute text embeddings once. Other models do not force no_grad during
# embedding/logits computation, so allow gradients here as well to keep
# behavior consistent across model wrappers.
with torch.no_grad():
text_embs = self.clip.get_text_features(**tok)
self.class_embeddings = text_embs / text_embs.norm(dim=-1, keepdim=True)
# number of classes
self.num_classes = len(self.class_strings)
def forward(self, x, mode: ForwardMode):
if mode == ForwardMode.EMBEDDINGS:
return self._encode(x)
elif mode == ForwardMode.LOGITS:
return self._logits(x)
else:
raise ValueError(f"Unknown mode: {mode}")
def extract_tensor(self, x):
# Expect x to be raw pixel tensor
return x
def wrap_tensor(self, x_tensor):
return x_tensor
def data_to_device(self, x, device):
return x.to(device)
def _encode(self, x):
# x is expected to be a float tensor on the correct device
# CLIP's get_image_features accepts pixel_values; we assume caller already resized/preprocessed
if x.device != self.device:
x = x.to(self.device)
# Always compute image features normally so gradients can flow when needed by callers.
emb = self.clip.get_image_features(x)
return emb / emb.norm(dim=-1, keepdim=True)
def _logits(self, x, temperature=100.0):
emb = self._encode(x)
logits = emb @ self.class_embeddings.T
return logits / temperature, logits