-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathimage.rs
More file actions
1200 lines (1061 loc) · 42.9 KB
/
image.rs
File metadata and controls
1200 lines (1061 loc) · 42.9 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
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
//! I-JEPA (Image Joint Embedding Predictive Architecture).
//!
//! Complete I-JEPA pipeline for self-supervised image representation learning.
//!
//! ```text
//! ┌──────────────────┐
//! visible patches ──►│ Context Encoder θ │──► s_x ──┐
//! └──────────────────┘ │
//! ▼
//! ┌────────────┐
//! target positions ────►│ Predictor │──► ŝ_y ─┐
//! └────────────┘ │ L2
//! ┌──────────────────┐ │ Energy
//! target patches ──►│ Target Encoder ξ │──► s_y ──────────────────┘
//! └──────────────────┘
//! ↑ EMA(θ → ξ)
//! ```
//!
//! [`IJepa::forward_step_strict`] implements the full masked training
//! forward pass with **pre-encoder** token filtering, matching the
//! reference PyTorch implementation for exact parity.
//!
//! Reference: Assran et al. (2023), *Self-Supervised Learning from Images
//! with a Joint-Embedding Predictive Architecture*, CVPR.
use burn::nn::{LayerNorm, LayerNormConfig, Linear, LinearConfig};
use burn::prelude::*;
use burn::tensor::backend::Backend;
use burn::tensor::module::embedding;
use jepa_core::types::{Energy, MaskError, MaskSpec, Representation};
use jepa_core::{CollapseRegularizer, EnergyFn, Predictor};
/// Configuration for the transformer predictor.
///
/// # Example
///
/// ```
/// use jepa_vision::image::TransformerPredictorConfig;
/// use jepa_core::types::Representation;
/// use jepa_core::Predictor;
/// use burn_ndarray::NdArray;
/// use burn::prelude::*;
///
/// type B = NdArray<f32>;
/// let device = burn_ndarray::NdArrayDevice::Cpu;
///
/// let config = TransformerPredictorConfig {
/// encoder_embed_dim: 32,
/// predictor_embed_dim: 16,
/// num_layers: 1,
/// num_heads: 2,
/// max_target_len: 64,
/// };
/// let predictor = config.init::<B>(&device);
///
/// let context = Representation::new(Tensor::zeros([1, 8, 32], &device));
/// let target_pos: Tensor<B, 2> = Tensor::zeros([1, 4], &device);
/// let predicted = predictor.predict(&context, &target_pos, None);
/// assert_eq!(predicted.seq_len(), 4);
/// ```
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct TransformerPredictorConfig {
/// Input embedding dimension (from encoder output).
pub encoder_embed_dim: usize,
/// Predictor internal embedding dimension.
pub predictor_embed_dim: usize,
/// Number of predictor transformer layers.
pub num_layers: usize,
/// Number of attention heads in the predictor.
pub num_heads: usize,
/// Maximum flattened token position supported by the predictor.
///
/// Set this to the encoder token count, not just the number of masked
/// targets in a single training step.
pub max_target_len: usize,
}
impl TransformerPredictorConfig {
/// Initialize a [`TransformerPredictor`] module.
pub fn init<B: Backend>(&self, device: &B::Device) -> TransformerPredictor<B> {
let input_proj =
LinearConfig::new(self.encoder_embed_dim, self.predictor_embed_dim).init(device);
let output_proj =
LinearConfig::new(self.predictor_embed_dim, self.encoder_embed_dim).init(device);
let blocks: Vec<PredictorBlock<B>> = (0..self.num_layers)
.map(|_| {
PredictorBlockConfig {
embed_dim: self.predictor_embed_dim,
num_heads: self.num_heads,
}
.init(device)
})
.collect();
let norm = LayerNormConfig::new(self.predictor_embed_dim).init(device);
let prediction_tokens =
sinusoidal_prediction_tokens(self.max_target_len, self.predictor_embed_dim, device);
TransformerPredictor {
input_proj,
output_proj,
blocks,
norm,
prediction_tokens,
predictor_embed_dim: self.predictor_embed_dim,
encoder_embed_dim: self.encoder_embed_dim,
}
}
}
/// Transformer-based predictor for I-JEPA.
///
/// Predicts target representations from context representations using
/// attention over concatenated context tokens and position-conditioned
/// prediction tokens.
///
/// Architecture:
/// 1. Project context to predictor dimension
/// 2. Build position-conditioned prediction tokens for the requested targets
/// 3. Concatenate prediction tokens with context
/// 4. Apply self-attention transformer blocks
/// 5. Extract prediction token outputs
/// 6. Project back to encoder dimension
#[derive(Module, Debug)]
pub struct TransformerPredictor<B: Backend> {
/// Project encoder output to predictor dimension.
input_proj: Linear<B>,
/// Project predictor output back to encoder dimension.
output_proj: Linear<B>,
/// Transformer blocks for the predictor.
blocks: Vec<PredictorBlock<B>>,
/// Final layer norm.
norm: LayerNorm<B>,
/// Position-conditioned prediction token table. Shape: `[max_position, predictor_embed_dim]`
prediction_tokens: Tensor<B, 2>,
/// Predictor embedding dimension.
predictor_embed_dim: usize,
/// Encoder embedding dimension (output dimension).
encoder_embed_dim: usize,
}
/// Errors returned by [`TransformerPredictor::try_predict`].
#[derive(Debug, Clone, thiserror::Error, PartialEq, Eq)]
pub enum PredictorError {
#[error(
"target position batch size mismatch: context batch={context_batch}, target_positions batch={positions_batch}"
)]
BatchSizeMismatch {
context_batch: usize,
positions_batch: usize,
},
#[error("target position must be non-negative, got {0}")]
NegativeTargetPosition(i64),
#[error(
"target position {position} exceeds predictor capacity {max_supported}; increase max_target_len"
)]
TargetPositionOutOfRange {
position: usize,
max_supported: usize,
},
}
impl<B: Backend> Predictor<B> for TransformerPredictor<B> {
fn predict(
&self,
context: &Representation<B>,
target_positions: &Tensor<B, 2>,
_latent: Option<&Tensor<B, 2>>,
) -> Representation<B> {
self.try_predict(context, target_positions).expect(
"TransformerPredictor::predict failed — target positions must match the context \
batch size and not exceed max_target_len; use try_predict for error handling",
)
}
}
impl<B: Backend> TransformerPredictor<B> {
/// Fallible predictor path for caller-controlled target positions.
pub fn try_predict(
&self,
context: &Representation<B>,
target_positions: &Tensor<B, 2>,
) -> Result<Representation<B>, PredictorError> {
let [batch, _ctx_len, _enc_dim] = context.embeddings.dims();
let [positions_batch, num_targets] = target_positions.dims();
if positions_batch != batch {
return Err(PredictorError::BatchSizeMismatch {
context_batch: batch,
positions_batch,
});
}
if num_targets == 0 {
let device = context.embeddings.device();
return Ok(Representation::new(Tensor::zeros(
[batch, 0, self.encoder_embed_dim],
&device,
)));
}
let target_positions = target_positions.clone().int();
let min_position: i64 = target_positions.clone().min().into_scalar().elem();
if min_position < 0 {
return Err(PredictorError::NegativeTargetPosition(min_position));
}
let max_position: i64 = target_positions.clone().max().into_scalar().elem();
let max_supported_position = self.prediction_tokens.dims()[0];
if max_position >= max_supported_position as i64 {
return Err(PredictorError::TargetPositionOutOfRange {
position: max_position as usize,
max_supported: max_supported_position,
});
}
// 1. Project context to predictor dimension
let ctx = self.input_proj.forward(context.embeddings.clone());
// 2. Select prediction tokens using the actual target positions.
let pred_tokens = embedding(self.prediction_tokens.clone(), target_positions);
// 3. Concatenate context + prediction tokens: [batch, ctx_len + num_targets, dim]
let combined = Tensor::cat(vec![ctx, pred_tokens], 1);
let ctx_len = context.embeddings.dims()[1];
let total_len = ctx_len + num_targets;
// 4. Apply transformer blocks
let mut x = combined;
for block in &self.blocks {
x = block.forward(x);
}
// 5. Extract prediction token outputs (last num_targets positions)
let pred_out = x.slice([0..batch, ctx_len..total_len, 0..self.predictor_embed_dim]);
// 6. Normalize and project back to encoder dimension
let pred_out = self.norm.forward(pred_out);
let pred_out = self.output_proj.forward(pred_out);
Ok(Representation::new(pred_out))
}
}
fn sinusoidal_prediction_tokens<B: Backend>(
max_target_len: usize,
embed_dim: usize,
device: &B::Device,
) -> Tensor<B, 2> {
let mut data = vec![0.0f32; max_target_len * embed_dim];
for position in 0..max_target_len {
for dim in 0..embed_dim {
let exponent = (2 * (dim / 2)) as f64 / embed_dim as f64;
let angle = position as f64 / 10_000_f64.powf(exponent);
data[position * embed_dim + dim] = if dim % 2 == 0 {
angle.sin() as f32
} else {
angle.cos() as f32
};
}
}
Tensor::from_floats(
burn::tensor::TensorData::new(data, [max_target_len, embed_dim]),
device,
)
}
// --- Predictor Transformer Block ---
#[derive(Debug, Clone)]
struct PredictorBlockConfig {
embed_dim: usize,
num_heads: usize,
}
impl PredictorBlockConfig {
fn init<B: Backend>(&self, device: &B::Device) -> PredictorBlock<B> {
let head_dim = self.embed_dim / self.num_heads;
PredictorBlock {
norm1: LayerNormConfig::new(self.embed_dim).init(device),
attn: PredictorAttention {
qkv: LinearConfig::new(self.embed_dim, 3 * self.embed_dim).init(device),
out_proj: LinearConfig::new(self.embed_dim, self.embed_dim).init(device),
num_heads: self.num_heads,
head_dim,
},
norm2: LayerNormConfig::new(self.embed_dim).init(device),
mlp: PredictorMlp {
fc1: LinearConfig::new(self.embed_dim, self.embed_dim * 4).init(device),
fc2: LinearConfig::new(self.embed_dim * 4, self.embed_dim).init(device),
},
}
}
}
#[derive(Module, Debug)]
struct PredictorBlock<B: Backend> {
norm1: LayerNorm<B>,
attn: PredictorAttention<B>,
norm2: LayerNorm<B>,
mlp: PredictorMlp<B>,
}
impl<B: Backend> PredictorBlock<B> {
fn forward(&self, x: Tensor<B, 3>) -> Tensor<B, 3> {
let residual = x.clone();
let x_norm = self.norm1.forward(x);
let attn_out = self.attn.forward(x_norm);
let x = residual + attn_out;
let residual = x.clone();
let x_norm = self.norm2.forward(x);
let mlp_out = self.mlp.forward(x_norm);
residual + mlp_out
}
}
#[derive(Module, Debug)]
struct PredictorAttention<B: Backend> {
qkv: Linear<B>,
out_proj: Linear<B>,
num_heads: usize,
head_dim: usize,
}
impl<B: Backend> PredictorAttention<B> {
fn forward(&self, x: Tensor<B, 3>) -> Tensor<B, 3> {
let [batch, seq_len, _] = x.dims();
let embed_dim = self.num_heads * self.head_dim;
let qkv = self.qkv.forward(x);
let q = qkv.clone().slice([0..batch, 0..seq_len, 0..embed_dim]);
let k = qkv
.clone()
.slice([0..batch, 0..seq_len, embed_dim..2 * embed_dim]);
let v = qkv.slice([0..batch, 0..seq_len, 2 * embed_dim..3 * embed_dim]);
let q = q
.reshape([batch, seq_len, self.num_heads, self.head_dim])
.swap_dims(1, 2);
let k = k
.reshape([batch, seq_len, self.num_heads, self.head_dim])
.swap_dims(1, 2);
let v = v
.reshape([batch, seq_len, self.num_heads, self.head_dim])
.swap_dims(1, 2);
let scale = (self.head_dim as f64).sqrt();
let attn = q.matmul(k.transpose()) / scale;
let attn = burn::tensor::activation::softmax(attn, 3);
let out = attn.matmul(v);
let out = out.swap_dims(1, 2).reshape([batch, seq_len, embed_dim]);
self.out_proj.forward(out)
}
}
#[derive(Module, Debug)]
struct PredictorMlp<B: Backend> {
fc1: Linear<B>,
fc2: Linear<B>,
}
impl<B: Backend> PredictorMlp<B> {
fn forward(&self, x: Tensor<B, 3>) -> Tensor<B, 3> {
let x = self.fc1.forward(x);
let x = burn::tensor::activation::gelu(x);
self.fc2.forward(x)
}
}
/// I-JEPA model combining encoder pair and predictor.
///
/// Provides a high-level interface for the I-JEPA pipeline (Assran et al., 2023).
#[derive(Module, Debug)]
pub struct IJepa<B: Backend> {
/// Context encoder — trained via gradient descent.
pub context_encoder: crate::vit::VitEncoder<B>,
/// Target encoder — updated via EMA (no gradients).
pub target_encoder: crate::vit::VitEncoder<B>,
/// Predictor — predicts target representations from context.
pub predictor: TransformerPredictor<B>,
}
/// Output of a strict masked I-JEPA forward step.
///
/// Unlike the generic trainer helper, the context representation is produced
/// from visible tokens only, so hidden target patches never participate in
/// context self-attention.
#[derive(Debug, Clone)]
pub struct StrictIJepaForwardOutput<B: Backend> {
/// Prediction energy (main loss signal). Shape: `[1]`
pub energy: Energy<B>,
/// Collapse prevention regularization loss. Shape: `[1]`
pub regularization: Tensor<B, 1>,
/// Total loss (energy + weighted regularization). Shape: `[1]`
pub total_loss: Tensor<B, 1>,
/// The mask used for this step.
pub mask: MaskSpec,
/// Strictly encoded context representation.
pub context: Representation<B>,
/// Predicted target representations.
pub predicted: Representation<B>,
/// Actual target representations from the target encoder.
pub target: Representation<B>,
}
/// Errors returned by [`IJepa::try_forward_step_strict`].
#[derive(Debug, Clone, thiserror::Error)]
pub enum StrictIJepaError {
#[error(transparent)]
InvalidMask(#[from] MaskError),
#[error(transparent)]
Predictor(#[from] PredictorError),
}
impl<B: Backend> IJepa<B> {
/// Encode only visible context patches before self-attention runs.
///
/// This method assumes `context_indices` are already valid for the current
/// image grid. Use [`IJepa::try_forward_step_strict`] when the indices come
/// from caller-controlled masking data.
pub fn encode_context_strict(
&self,
images: &Tensor<B, 4>,
context_indices: &[usize],
) -> Representation<B> {
self.context_encoder
.forward_visible_tokens(images, context_indices)
}
/// Execute a strict masked I-JEPA forward step.
///
/// The target encoder still sees the full input, but the context encoder is
/// restricted to visible patches before any attention mixing occurs.
///
/// # Panics
///
/// Panics if `mask` is invalid or if the predictor receives target
/// positions outside its configured capacity. Use
/// [`IJepa::try_forward_step_strict`] for typed error reporting.
pub fn forward_step_strict<EF, CR>(
&self,
images: &Tensor<B, 4>,
mask: MaskSpec,
energy_fn: &EF,
regularizer: &CR,
reg_weight: f64,
) -> StrictIJepaForwardOutput<B>
where
EF: EnergyFn<B>,
CR: CollapseRegularizer<B>,
{
self.try_forward_step_strict(images, mask, energy_fn, regularizer, reg_weight)
.expect(
"IJepa::forward_step_strict failed — mask must be valid (disjoint, non-empty) \
and target count must not exceed predictor capacity; \
use try_forward_step_strict for error handling",
)
}
/// Execute a strict masked I-JEPA forward step with typed error reporting.
pub fn try_forward_step_strict<EF, CR>(
&self,
images: &Tensor<B, 4>,
mask: MaskSpec,
energy_fn: &EF,
regularizer: &CR,
reg_weight: f64,
) -> Result<StrictIJepaForwardOutput<B>, StrictIJepaError>
where
EF: EnergyFn<B>,
CR: CollapseRegularizer<B>,
{
mask.validate()?;
let context = self.encode_context_strict(images, &mask.context_indices);
let target_full = self.target_encoder.forward(images);
let target =
Representation::new(target_full.embeddings.detach()).gather(&mask.target_indices);
let batch = images.dims()[0];
let target_positions =
target_positions_tensor::<B>(&mask.target_indices, batch, &images.device());
let predicted = self.predictor.try_predict(&context, &target_positions)?;
let num_targets = target.seq_len();
let embed_dim = target.embed_dim();
let pred_flat = predicted
.embeddings
.clone()
.reshape([batch * num_targets, embed_dim]);
let target_flat = target
.embeddings
.clone()
.reshape([batch * num_targets, embed_dim]);
let energy = energy_fn.compute(&predicted, &target);
let regularization = regularizer.loss(&pred_flat, &target_flat);
let total_loss = energy.value.clone() + regularization.clone() * reg_weight;
Ok(StrictIJepaForwardOutput {
energy,
regularization,
total_loss,
mask,
context,
predicted,
target,
})
}
}
pub(crate) fn target_positions_tensor<B: Backend>(
indices: &[usize],
batch: usize,
device: &B::Device,
) -> Tensor<B, 2> {
let mut data = Vec::with_capacity(batch * indices.len());
for _ in 0..batch {
data.extend(indices.iter().map(|&index| index as f32));
}
Tensor::from_floats(
burn::tensor::TensorData::new(data, [batch, indices.len()]),
device,
)
}
/// Configuration for the I-JEPA model.
#[derive(Debug, Clone)]
pub struct IJepaConfig {
/// ViT encoder config (shared by context and target encoders).
pub encoder: crate::vit::VitConfig,
/// Predictor config.
pub predictor: TransformerPredictorConfig,
}
impl IJepaConfig {
/// Create a tiny config suitable for testing.
pub fn tiny_test() -> Self {
let encoder = crate::vit::VitConfig::tiny_test();
Self {
predictor: TransformerPredictorConfig {
encoder_embed_dim: encoder.embed_dim,
predictor_embed_dim: 16,
num_layers: 1,
num_heads: 2,
max_target_len: 64,
},
encoder,
}
}
/// Initialize an [`IJepa`] model.
pub fn init<B: Backend>(&self, device: &B::Device) -> IJepa<B> {
IJepa {
context_encoder: self.encoder.init(device),
target_encoder: self.encoder.init(device),
predictor: self.predictor.init(device),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use burn::tensor::ElementConversion;
use burn_ndarray::NdArray;
use jepa_core::{CollapseRegularizer, EnergyFn, MaskingStrategy};
use rand::SeedableRng;
type TestBackend = NdArray<f32>;
fn device() -> burn_ndarray::NdArrayDevice {
burn_ndarray::NdArrayDevice::Cpu
}
fn target_positions(indices: &[usize], batch: usize) -> Tensor<TestBackend, 2> {
let mut data = Vec::with_capacity(batch * indices.len());
for _ in 0..batch {
data.extend(indices.iter().map(|&index| index as f32));
}
Tensor::from_floats(
burn::tensor::TensorData::new(data, [batch, indices.len()]),
&device(),
)
}
fn fixed_image_mask() -> MaskSpec {
MaskSpec {
context_indices: vec![0, 1, 4, 5, 10, 11, 14, 15],
target_indices: vec![2, 3, 6, 7, 8, 9, 12, 13],
total_tokens: 16,
}
}
fn image_with_hidden_patch_value(mask: &MaskSpec, hidden_value: f32) -> Tensor<TestBackend, 4> {
let image_size = 8usize;
let patch_size = 2usize;
let mut data = vec![1.0f32; image_size * image_size];
for &index in &mask.target_indices {
let patch_row = index / 4;
let patch_col = index % 4;
let row_start = patch_row * patch_size;
let col_start = patch_col * patch_size;
for row in row_start..row_start + patch_size {
for col in col_start..col_start + patch_size {
data[row * image_size + col] = hidden_value;
}
}
}
Tensor::from_floats(
burn::tensor::TensorData::new(data, [1, 1, image_size, image_size]),
&device(),
)
}
#[test]
fn test_predictor_output_shape() {
let config = TransformerPredictorConfig {
encoder_embed_dim: 32,
predictor_embed_dim: 16,
num_layers: 1,
num_heads: 2,
max_target_len: 64,
};
let predictor = config.init::<TestBackend>(&device());
let context = Representation::new(Tensor::zeros([2, 8, 32], &device()));
let target_pos: Tensor<TestBackend, 2> = Tensor::zeros([2, 4], &device());
let predicted = predictor.predict(&context, &target_pos, None);
assert_eq!(predicted.batch_size(), 2);
assert_eq!(predicted.seq_len(), 4);
assert_eq!(predicted.embed_dim(), 32);
}
#[test]
fn test_predictor_implements_trait() {
let config = TransformerPredictorConfig {
encoder_embed_dim: 16,
predictor_embed_dim: 8,
num_layers: 1,
num_heads: 2,
max_target_len: 16,
};
let predictor = config.init::<TestBackend>(&device());
let context = Representation::new(Tensor::zeros([1, 4, 16], &device()));
let target_pos: Tensor<TestBackend, 2> = Tensor::zeros([1, 2], &device());
let pred: Representation<TestBackend> =
Predictor::predict(&predictor, &context, &target_pos, None);
assert_eq!(pred.seq_len(), 2);
}
#[test]
fn test_predictor_output_depends_on_target_positions() {
let config = TransformerPredictorConfig {
encoder_embed_dim: 16,
predictor_embed_dim: 8,
num_layers: 1,
num_heads: 2,
max_target_len: 16,
};
let predictor = config.init::<TestBackend>(&device());
let context = Representation::new(Tensor::zeros([1, 4, 16], &device()));
let positions_a = target_positions(&[0, 1], 1);
let positions_b = target_positions(&[2, 3], 1);
let pred_a = predictor.predict(&context, &positions_a, None);
let pred_b = predictor.predict(&context, &positions_b, None);
let diff: f32 = (pred_a.embeddings - pred_b.embeddings)
.abs()
.sum()
.into_scalar()
.elem();
assert!(
diff > 1e-6,
"target positions should affect predictor output, diff={diff}"
);
}
#[test]
fn test_predictor_try_predict_rejects_batch_size_mismatch() {
let config = TransformerPredictorConfig {
encoder_embed_dim: 16,
predictor_embed_dim: 8,
num_layers: 1,
num_heads: 2,
max_target_len: 16,
};
let predictor = config.init::<TestBackend>(&device());
let context = Representation::new(Tensor::zeros([2, 4, 16], &device()));
let target_pos: Tensor<TestBackend, 2> = Tensor::zeros([1, 2], &device());
let err = predictor.try_predict(&context, &target_pos).unwrap_err();
assert_eq!(
err,
PredictorError::BatchSizeMismatch {
context_batch: 2,
positions_batch: 1,
}
);
}
#[test]
fn test_predictor_try_predict_rejects_out_of_range_positions() {
let config = TransformerPredictorConfig {
encoder_embed_dim: 16,
predictor_embed_dim: 8,
num_layers: 1,
num_heads: 2,
max_target_len: 4,
};
let predictor = config.init::<TestBackend>(&device());
let context = Representation::new(Tensor::zeros([1, 4, 16], &device()));
let target_pos = target_positions(&[0, 4], 1);
let err = predictor.try_predict(&context, &target_pos).unwrap_err();
assert_eq!(
err,
PredictorError::TargetPositionOutOfRange {
position: 4,
max_supported: 4,
}
);
}
#[test]
fn test_predictor_try_predict_allows_empty_targets() {
let config = TransformerPredictorConfig {
encoder_embed_dim: 16,
predictor_embed_dim: 8,
num_layers: 1,
num_heads: 2,
max_target_len: 4,
};
let predictor = config.init::<TestBackend>(&device());
let context = Representation::new(Tensor::zeros([2, 4, 16], &device()));
let target_pos: Tensor<TestBackend, 2> = Tensor::zeros([2, 0], &device());
let predicted = predictor.try_predict(&context, &target_pos).unwrap();
assert_eq!(predicted.batch_size(), 2);
assert_eq!(predicted.seq_len(), 0);
assert_eq!(predicted.embed_dim(), 16);
}
#[test]
fn test_ijepa_full_pipeline() {
// End-to-end test: encode → mask → predict → compute energy
let config = IJepaConfig::tiny_test();
let model = config.init::<TestBackend>(&device());
// 1. Create a test image
let images: Tensor<TestBackend, 4> = Tensor::ones([1, 1, 8, 8], &device());
// 2. Encode with both encoders
let context_repr = model.context_encoder.forward(&images);
let target_repr = model.target_encoder.forward(&images);
assert_eq!(context_repr.seq_len(), 16); // 4x4 grid
assert_eq!(target_repr.seq_len(), 16);
// 3. Generate a mask
let masking = jepa_core::masking::BlockMasking {
num_targets: 2,
target_scale: (0.15, 0.3),
target_aspect_ratio: (0.75, 1.5),
};
let shape = jepa_core::types::InputShape::Image {
height: 4,
width: 4,
};
let mut rng = rand_chacha::ChaCha8Rng::seed_from_u64(42);
let mask = masking.generate_mask(&shape, &mut rng);
// 4. Predict target from context
let num_targets = mask.target_indices.len();
let target_pos = target_positions(&mask.target_indices, 1);
let predicted = model.predictor.predict(&context_repr, &target_pos, None);
assert_eq!(predicted.seq_len(), num_targets);
assert_eq!(predicted.embed_dim(), 32);
// 5. Compute energy between predicted and actual target
// We need to extract target tokens from target_repr for fair comparison
// For this test, just verify energy is computable and finite
let energy = jepa_core::energy::L2Energy.compute(&predicted, &predicted);
let val: f32 = energy.value.into_scalar().elem();
assert!(val.is_finite(), "energy should be finite");
}
#[test]
fn test_ijepa_config_tiny() {
let config = IJepaConfig::tiny_test();
assert_eq!(config.encoder.embed_dim, 32);
assert_eq!(config.predictor.predictor_embed_dim, 16);
}
#[test]
fn test_strict_context_encoding_ignores_hidden_patches() {
let config = IJepaConfig::tiny_test();
let model = config.init::<TestBackend>(&device());
let mask = fixed_image_mask();
let hidden_low = image_with_hidden_patch_value(&mask, 0.0);
let hidden_high = image_with_hidden_patch_value(&mask, 1_000.0);
let strict_low = model.encode_context_strict(&hidden_low, &mask.context_indices);
let strict_high = model.encode_context_strict(&hidden_high, &mask.context_indices);
let diff: f32 = (strict_low.embeddings - strict_high.embeddings)
.abs()
.sum()
.into_scalar()
.elem();
assert!(
diff < 1e-5,
"strict masked context should ignore hidden patches, diff={diff}"
);
}
#[test]
fn test_full_encoder_context_slice_leaks_hidden_patches() {
let config = crate::vit::VitConfig::tiny_test();
let encoder = config.init::<TestBackend>(&device());
let mask = fixed_image_mask();
let hidden_low = image_with_hidden_patch_value(&mask, 0.0);
let hidden_high = image_with_hidden_patch_value(&mask, 1_000.0);
let approx_low = encoder.forward(&hidden_low).gather(&mask.context_indices);
let approx_high = encoder.forward(&hidden_high).gather(&mask.context_indices);
let diff: f32 = (approx_low.embeddings - approx_high.embeddings)
.abs()
.sum()
.into_scalar()
.elem();
assert!(
diff > 1e-3,
"post-encoder gather path should leak hidden patches, diff={diff}"
);
}
#[test]
fn test_strict_forward_step_runs_end_to_end() {
let config = IJepaConfig::tiny_test();
let model = config.init::<TestBackend>(&device());
let mask = fixed_image_mask();
let images = image_with_hidden_patch_value(&mask, 3.0);
let energy_fn = jepa_core::energy::L2Energy;
let regularizer = jepa_core::collapse::VICReg::default();
let output =
model.forward_step_strict(&images, mask.clone(), &energy_fn, ®ularizer, 1.0);
assert_eq!(output.context.seq_len(), mask.context_indices.len());
assert_eq!(output.predicted.seq_len(), mask.target_indices.len());
assert_eq!(output.target.seq_len(), mask.target_indices.len());
let total_loss: f32 = output.total_loss.into_scalar().elem();
assert!(
total_loss.is_finite(),
"strict forward loss should be finite"
);
}
#[test]
fn test_try_strict_forward_step_rejects_invalid_mask() {
let config = IJepaConfig::tiny_test();
let model = config.init::<TestBackend>(&device());
let images = Tensor::ones([1, 1, 8, 8], &device());
let invalid_mask = MaskSpec {
context_indices: vec![],
target_indices: vec![0],
total_tokens: 16,
};
let energy_fn = jepa_core::energy::L2Energy;
let regularizer = jepa_core::collapse::VICReg::default();
let err = model
.try_forward_step_strict(&images, invalid_mask, &energy_fn, ®ularizer, 1.0)
.unwrap_err();
assert!(matches!(
err,
StrictIJepaError::InvalidMask(MaskError::EmptyContext)
));
}
// ======================================================================
// BDD-aligned integration tests (matching specs/gherkin/features.feature)
// ======================================================================
/// BDD: "Encode a batch of images into representations"
/// Given a ViT encoder with embed_dim and patch_size
/// When I encode a batch of images
/// Then I should get representations of the correct shape
/// And the representations should have non-zero variance across the batch
#[test]
fn bdd_encode_batch_correct_shape_and_nonzero_variance() {
let config = crate::vit::VitConfig::tiny_test();
let encoder = config.init::<TestBackend>(&device());
// Batch of 4 images, different values to ensure variance
let batch_size = 4;
let images: Tensor<TestBackend, 4> = Tensor::random(
[batch_size, 1, 8, 8],
burn::tensor::Distribution::Normal(0.0, 1.0),
&device(),
);
let repr = encoder.forward(&images);
// Shape: [4, 16, 32] (4x4 grid of patches, embed_dim=32)
assert_eq!(repr.batch_size(), batch_size);
assert_eq!(repr.seq_len(), 16);
assert_eq!(repr.embed_dim(), 32);
// Variance across the batch dimension should be non-zero
// Compute mean across batch, then measure deviation
let mean_repr = repr.embeddings.clone().mean_dim(0); // [1, 16, 32]
let diff = repr.embeddings.clone() - mean_repr;
let variance: f32 = (diff.clone() * diff).mean().into_scalar().elem();
assert!(
variance > 1e-6,
"representations should have non-zero variance across the batch, got {variance}"
);
}
/// BDD: "Context and target encoders produce compatible representations"
/// Given a JEPA encoder pair with shared architecture
/// And the target encoder initialized as a copy of the context encoder
/// When I encode the same image with both encoders
/// Then the representations should be identical (freshly initialized, same weights)
#[test]
fn bdd_encoder_pair_same_init_same_output() {
// Both encoders share the same config. Since they're freshly initialized
// with potentially different random weights, we create one and use it twice.
let config = crate::vit::VitConfig::tiny_test();
let encoder = config.init::<TestBackend>(&device());
let images: Tensor<TestBackend, 4> = Tensor::ones([1, 1, 8, 8], &device());
// Encoding the same image with the same encoder instance gives identical output
let repr1 = encoder.forward(&images);
let repr2 = encoder.forward(&images);
let diff: f32 = (repr1.embeddings - repr2.embeddings)
.abs()
.sum()
.into_scalar()
.elem();
assert!(
diff < 1e-6,
"same encoder + same input should produce identical representations, diff={diff}"
);
}
/// BDD: "EMA update makes target encoder lag behind context encoder"
/// Given a JEPA encoder pair
/// When I apply EMA update with momentum 0.99
/// Then the target encoder weights should move toward the context encoder
/// And the target encoder should NOT equal the context encoder
#[test]
fn bdd_ema_update_target_lags_context() {
let config = IJepaConfig::tiny_test();
let model = config.init::<TestBackend>(&device());
let images: Tensor<TestBackend, 4> = Tensor::ones([1, 1, 8, 8], &device());
// Get initial representations
let ctx_repr = model.context_encoder.forward(&images);
let tgt_repr = model.target_encoder.forward(&images);
// Since both are freshly initialized with DIFFERENT random weights,
// their outputs should differ
let initial_diff: f32 = (ctx_repr.embeddings.clone() - tgt_repr.embeddings.clone())
.abs()
.sum()
.into_scalar()
.elem();
// After many EMA updates, target should move toward context.
// We simulate this by computing what the target weight tensor would be.
let ema = jepa_core::ema::Ema::new(0.99);
let target_val = 0.0f64;
let online_val = 1.0f64;