axonml-vision 0.4.2

Computer vision utilities for the Axonml ML framework
Documentation
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
//! Transformer - Attention-based Neural Networks
//!
//! # File
//! `crates/axonml-vision/src/models/transformer.rs`
//!
//! # Author
//! Andrew Jewell Sr - AutomataNexus
//!
//! # Updated
//! March 8, 2026
//!
//! # Disclaimer
//! Use at own risk. This software is provided "as is", without warranty of any
//! kind, express or implied. The author and AutomataNexus shall not be held
//! liable for any damages arising from the use of this software.

use std::any::Any;

use axonml_autograd::no_grad::is_grad_enabled;
use axonml_autograd::{GradFn, GradientFunction, Variable};
use axonml_nn::{Dropout, LayerNorm, Linear, Module, MultiHeadAttention, Parameter};
use axonml_tensor::Tensor;

// =============================================================================
// Positional Encoding
// =============================================================================

/// Positional encoding using sinusoidal functions.
pub struct PositionalEncoding {
    encoding: Tensor<f32>,
    max_len: usize,
    d_model: usize,
}

impl PositionalEncoding {
    /// Create positional encoding.
    #[must_use]
    pub fn new(d_model: usize, max_len: usize) -> Self {
        let mut pe = vec![0.0f32; max_len * d_model];

        for pos in 0..max_len {
            for i in 0..d_model {
                let div_term = (-(i as f32 / d_model as f32) * (10000.0f32).ln()).exp();
                if i % 2 == 0 {
                    pe[pos * d_model + i] = (pos as f32 * div_term).sin();
                } else {
                    pe[pos * d_model + i] = (pos as f32 * div_term).cos();
                }
            }
        }

        Self {
            encoding: Tensor::from_vec(pe, &[max_len, d_model]).unwrap(),
            max_len,
            d_model,
        }
    }

    /// Add positional encoding to input.
    #[must_use]
    pub fn forward(&self, x: &Variable) -> Variable {
        let shape = x.shape();
        let seq_len = shape[1];
        let x_data = x.data().to_vec();
        let pe_data = self.encoding.to_vec();

        // Broadcasting PE across batch
        let batch_size = shape[0];
        let mut result = x_data.clone();

        for b in 0..batch_size {
            for s in 0..seq_len.min(self.max_len) {
                for d in 0..self.d_model {
                    let idx = b * seq_len * self.d_model + s * self.d_model + d;
                    result[idx] += pe_data[s * self.d_model + d];
                }
            }
        }

        Variable::new(Tensor::from_vec(result, &shape).unwrap(), x.requires_grad())
    }
}

// =============================================================================
// Transformer Encoder Layer
// =============================================================================

/// A single Transformer encoder layer.
pub struct TransformerEncoderLayer {
    self_attn: MultiHeadAttention,
    ff_linear1: Linear,
    ff_linear2: Linear,
    norm1: LayerNorm,
    norm2: LayerNorm,
    dropout: Dropout,
    d_model: usize,
}

impl TransformerEncoderLayer {
    /// Create encoder layer.
    #[must_use]
    pub fn new(d_model: usize, nhead: usize, dim_feedforward: usize, dropout: f32) -> Self {
        Self {
            self_attn: MultiHeadAttention::with_options(d_model, nhead, dropout, true),
            ff_linear1: Linear::new(d_model, dim_feedforward),
            ff_linear2: Linear::new(dim_feedforward, d_model),
            norm1: LayerNorm::new(vec![d_model]),
            norm2: LayerNorm::new(vec![d_model]),
            dropout: Dropout::new(dropout),
            d_model,
        }
    }

    /// Returns the model dimension.
    pub fn d_model(&self) -> usize {
        self.d_model
    }

    /// Forward with optional attention mask.
    pub fn forward_with_mask(&self, src: &Variable, src_mask: Option<&Variable>) -> Variable {
        // Self-attention with residual
        let attn_out = self.self_attn.attention(src, src, src, src_mask);
        let attn_out = self.dropout.forward(&attn_out);
        let src = src.add_var(&attn_out);
        let src = self.norm1.forward(&src);

        // Feed-forward with residual
        let ff_out = self.ff_linear1.forward(&src);
        let ff_out = ff_out.relu();
        let ff_out = self.dropout.forward(&ff_out);
        let ff_out = self.ff_linear2.forward(&ff_out);
        let ff_out = self.dropout.forward(&ff_out);
        let src = src.add_var(&ff_out);

        self.norm2.forward(&src)
    }
}

impl Module for TransformerEncoderLayer {
    fn forward(&self, input: &Variable) -> Variable {
        self.forward_with_mask(input, None)
    }

    fn parameters(&self) -> Vec<Parameter> {
        let mut params = Vec::new();
        params.extend(self.self_attn.parameters());
        params.extend(self.ff_linear1.parameters());
        params.extend(self.ff_linear2.parameters());
        params.extend(self.norm1.parameters());
        params.extend(self.norm2.parameters());
        params
    }

    fn train(&mut self) {
        self.dropout.train();
    }

    fn eval(&mut self) {
        self.dropout.eval();
    }

    fn is_training(&self) -> bool {
        self.dropout.is_training()
    }
}

// =============================================================================
// Transformer Encoder
// =============================================================================

/// Stack of Transformer encoder layers.
pub struct TransformerEncoder {
    layers: Vec<TransformerEncoderLayer>,
    norm: Option<LayerNorm>,
}

impl TransformerEncoder {
    /// Create encoder with specified layers.
    #[must_use]
    pub fn new(
        d_model: usize,
        nhead: usize,
        num_layers: usize,
        dim_feedforward: usize,
        dropout: f32,
    ) -> Self {
        let layers = (0..num_layers)
            .map(|_| TransformerEncoderLayer::new(d_model, nhead, dim_feedforward, dropout))
            .collect();

        Self {
            layers,
            norm: Some(LayerNorm::new(vec![d_model])),
        }
    }

    /// Forward with optional mask.
    #[must_use]
    pub fn forward_with_mask(&self, src: &Variable, mask: Option<&Variable>) -> Variable {
        let mut output = src.clone();
        for layer in &self.layers {
            output = layer.forward_with_mask(&output, mask);
        }
        if let Some(norm) = &self.norm {
            output = norm.forward(&output);
        }
        output
    }
}

impl Module for TransformerEncoder {
    fn forward(&self, input: &Variable) -> Variable {
        self.forward_with_mask(input, None)
    }

    fn parameters(&self) -> Vec<Parameter> {
        let mut params = Vec::new();
        for layer in &self.layers {
            params.extend(layer.parameters());
        }
        if let Some(norm) = &self.norm {
            params.extend(norm.parameters());
        }
        params
    }

    fn train(&mut self) {
        for layer in &mut self.layers {
            layer.train();
        }
    }

    fn eval(&mut self) {
        for layer in &mut self.layers {
            layer.eval();
        }
    }

    fn is_training(&self) -> bool {
        self.layers
            .first()
            .is_none_or(axonml_nn::Module::is_training)
    }
}

// =============================================================================
// Transformer Decoder Layer
// =============================================================================

/// A single Transformer decoder layer.
pub struct TransformerDecoderLayer {
    self_attn: MultiHeadAttention,
    cross_attn: MultiHeadAttention,
    ff_linear1: Linear,
    ff_linear2: Linear,
    norm1: LayerNorm,
    norm2: LayerNorm,
    norm3: LayerNorm,
    dropout: Dropout,
}

impl TransformerDecoderLayer {
    /// Create decoder layer.
    #[must_use]
    pub fn new(d_model: usize, nhead: usize, dim_feedforward: usize, dropout: f32) -> Self {
        Self {
            self_attn: MultiHeadAttention::with_options(d_model, nhead, dropout, true),
            cross_attn: MultiHeadAttention::with_options(d_model, nhead, dropout, true),
            ff_linear1: Linear::new(d_model, dim_feedforward),
            ff_linear2: Linear::new(dim_feedforward, d_model),
            norm1: LayerNorm::new(vec![d_model]),
            norm2: LayerNorm::new(vec![d_model]),
            norm3: LayerNorm::new(vec![d_model]),
            dropout: Dropout::new(dropout),
        }
    }

    /// Forward with memory and masks.
    pub fn forward_with_memory(
        &self,
        tgt: &Variable,
        memory: &Variable,
        tgt_mask: Option<&Variable>,
        memory_mask: Option<&Variable>,
    ) -> Variable {
        // Self-attention with residual
        let attn_out = self.self_attn.attention(tgt, tgt, tgt, tgt_mask);
        let attn_out = self.dropout.forward(&attn_out);
        let tgt = tgt.add_var(&attn_out);
        let tgt = self.norm1.forward(&tgt);

        // Cross-attention with residual
        let cross_out = self.cross_attn.attention(&tgt, memory, memory, memory_mask);
        let cross_out = self.dropout.forward(&cross_out);
        let tgt = tgt.add_var(&cross_out);
        let tgt = self.norm2.forward(&tgt);

        // Feed-forward with residual
        let ff_out = self.ff_linear1.forward(&tgt);
        let ff_out = ff_out.relu();
        let ff_out = self.dropout.forward(&ff_out);
        let ff_out = self.ff_linear2.forward(&ff_out);
        let ff_out = self.dropout.forward(&ff_out);
        let tgt = tgt.add_var(&ff_out);

        self.norm3.forward(&tgt)
    }
}

impl Module for TransformerDecoderLayer {
    fn forward(&self, input: &Variable) -> Variable {
        // For standard forward, use self-attention only
        self.self_attn.forward(input)
    }

    fn parameters(&self) -> Vec<Parameter> {
        let mut params = Vec::new();
        params.extend(self.self_attn.parameters());
        params.extend(self.cross_attn.parameters());
        params.extend(self.ff_linear1.parameters());
        params.extend(self.ff_linear2.parameters());
        params.extend(self.norm1.parameters());
        params.extend(self.norm2.parameters());
        params.extend(self.norm3.parameters());
        params
    }

    fn train(&mut self) {
        self.dropout.train();
    }

    fn eval(&mut self) {
        self.dropout.eval();
    }

    fn is_training(&self) -> bool {
        self.dropout.is_training()
    }
}

// =============================================================================
// Transformer Decoder
// =============================================================================

/// Stack of Transformer decoder layers.
pub struct TransformerDecoder {
    layers: Vec<TransformerDecoderLayer>,
    norm: Option<LayerNorm>,
}

impl TransformerDecoder {
    /// Create decoder with specified layers.
    #[must_use]
    pub fn new(
        d_model: usize,
        nhead: usize,
        num_layers: usize,
        dim_feedforward: usize,
        dropout: f32,
    ) -> Self {
        let layers = (0..num_layers)
            .map(|_| TransformerDecoderLayer::new(d_model, nhead, dim_feedforward, dropout))
            .collect();

        Self {
            layers,
            norm: Some(LayerNorm::new(vec![d_model])),
        }
    }

    /// Forward with memory and masks.
    #[must_use]
    pub fn forward_with_memory(
        &self,
        tgt: &Variable,
        memory: &Variable,
        tgt_mask: Option<&Variable>,
        memory_mask: Option<&Variable>,
    ) -> Variable {
        let mut output = tgt.clone();
        for layer in &self.layers {
            output = layer.forward_with_memory(&output, memory, tgt_mask, memory_mask);
        }
        if let Some(norm) = &self.norm {
            output = norm.forward(&output);
        }
        output
    }
}

impl Module for TransformerDecoder {
    fn forward(&self, input: &Variable) -> Variable {
        let mut output = input.clone();
        for layer in &self.layers {
            output = layer.forward(&output);
        }
        if let Some(norm) = &self.norm {
            output = norm.forward(&output);
        }
        output
    }

    fn parameters(&self) -> Vec<Parameter> {
        let mut params = Vec::new();
        for layer in &self.layers {
            params.extend(layer.parameters());
        }
        if let Some(norm) = &self.norm {
            params.extend(norm.parameters());
        }
        params
    }

    fn train(&mut self) {
        for layer in &mut self.layers {
            layer.train();
        }
    }

    fn eval(&mut self) {
        for layer in &mut self.layers {
            layer.eval();
        }
    }

    fn is_training(&self) -> bool {
        self.layers
            .first()
            .is_none_or(axonml_nn::Module::is_training)
    }
}

// =============================================================================
// Full Transformer
// =============================================================================

/// Full Transformer model (encoder-decoder).
pub struct Transformer {
    encoder: TransformerEncoder,
    decoder: TransformerDecoder,
    d_model: usize,
}

impl Transformer {
    /// Create a Transformer model.
    #[must_use]
    pub fn new(
        d_model: usize,
        nhead: usize,
        num_encoder_layers: usize,
        num_decoder_layers: usize,
        dim_feedforward: usize,
        dropout: f32,
    ) -> Self {
        Self {
            encoder: TransformerEncoder::new(
                d_model,
                nhead,
                num_encoder_layers,
                dim_feedforward,
                dropout,
            ),
            decoder: TransformerDecoder::new(
                d_model,
                nhead,
                num_decoder_layers,
                dim_feedforward,
                dropout,
            ),
            d_model,
        }
    }

    /// Returns the model dimension.
    #[must_use]
    pub fn d_model(&self) -> usize {
        self.d_model
    }

    /// Forward pass with source and target.
    #[must_use]
    pub fn forward_full(
        &self,
        src: &Variable,
        tgt: &Variable,
        src_mask: Option<&Variable>,
        tgt_mask: Option<&Variable>,
        memory_mask: Option<&Variable>,
    ) -> Variable {
        let memory = self.encoder.forward_with_mask(src, src_mask);
        self.decoder
            .forward_with_memory(tgt, &memory, tgt_mask, memory_mask)
    }
}

impl Module for Transformer {
    fn forward(&self, input: &Variable) -> Variable {
        // Encoder-only forward for classification tasks
        self.encoder.forward(input)
    }

    fn parameters(&self) -> Vec<Parameter> {
        let mut params = Vec::new();
        params.extend(self.encoder.parameters());
        params.extend(self.decoder.parameters());
        params
    }

    fn train(&mut self) {
        self.encoder.train();
        self.decoder.train();
    }

    fn eval(&mut self) {
        self.encoder.eval();
        self.decoder.eval();
    }

    fn is_training(&self) -> bool {
        self.encoder.is_training()
    }
}

// =============================================================================
// Vision Transformer (ViT)
// =============================================================================

/// Vision Transformer for image classification.
///
/// Converts images into patches and processes them with a Transformer encoder.
pub struct VisionTransformer {
    patch_embedding: Linear,
    pos_encoding: PositionalEncoding,
    encoder: TransformerEncoder,
    mlp_head: Linear,
    cls_token: Parameter,
    patch_size: usize,
    num_patches: usize,
    d_model: usize,
}

impl VisionTransformer {
    /// Create a Vision Transformer.
    ///
    /// # Arguments
    /// * `image_size` - Input image size (assumes square)
    /// * `patch_size` - Size of each patch
    /// * `in_channels` - Number of input channels (3 for RGB)
    /// * `num_classes` - Number of output classes
    /// * `d_model` - Model dimension
    /// * `nhead` - Number of attention heads
    /// * `num_layers` - Number of encoder layers
    /// * `dim_feedforward` - Feed-forward dimension
    /// * `dropout` - Dropout probability
    #[must_use]
    pub fn new(
        image_size: usize,
        patch_size: usize,
        in_channels: usize,
        num_classes: usize,
        d_model: usize,
        nhead: usize,
        num_layers: usize,
        dim_feedforward: usize,
        dropout: f32,
    ) -> Self {
        assert!(
            image_size % patch_size == 0,
            "Image size must be divisible by patch size"
        );

        let num_patches = (image_size / patch_size) * (image_size / patch_size);
        let patch_dim = in_channels * patch_size * patch_size;

        // CLS token as learnable parameter
        let cls_data = Tensor::from_vec(vec![0.0f32; d_model], &[1, 1, d_model]).unwrap();
        let cls_token = Parameter::named("cls_token", cls_data, true);

        Self {
            patch_embedding: Linear::new(patch_dim, d_model),
            pos_encoding: PositionalEncoding::new(d_model, num_patches + 1), // +1 for CLS
            encoder: TransformerEncoder::new(d_model, nhead, num_layers, dim_feedforward, dropout),
            mlp_head: Linear::new(d_model, num_classes),
            cls_token,
            patch_size,
            num_patches,
            d_model,
        }
    }

    /// Create ViT-Tiny.
    #[must_use]
    pub fn vit_tiny(image_size: usize, num_classes: usize) -> Self {
        Self::new(image_size, 16, 3, num_classes, 192, 3, 12, 768, 0.0)
    }

    /// Create ViT-Small.
    #[must_use]
    pub fn vit_small(image_size: usize, num_classes: usize) -> Self {
        Self::new(image_size, 16, 3, num_classes, 384, 6, 12, 1536, 0.0)
    }

    /// Create ViT-Base.
    #[must_use]
    pub fn vit_base(image_size: usize, num_classes: usize) -> Self {
        Self::new(image_size, 16, 3, num_classes, 768, 12, 12, 3072, 0.0)
    }

    /// Create ViT-Large.
    #[must_use]
    pub fn vit_large(image_size: usize, num_classes: usize) -> Self {
        Self::new(image_size, 16, 3, num_classes, 1024, 16, 24, 4096, 0.0)
    }

    /// Extract patches from image.
    fn extract_patches(&self, x: &Variable) -> Variable {
        let shape = x.shape();
        let batch_size = shape[0];
        let channels = shape[1];
        let height = shape[2];
        let width = shape[3];

        let num_patches_h = height / self.patch_size;
        let num_patches_w = width / self.patch_size;
        let patch_dim = channels * self.patch_size * self.patch_size;

        let x_data = x.data().to_vec();
        let mut patches = vec![0.0f32; batch_size * self.num_patches * patch_dim];

        for b in 0..batch_size {
            for ph in 0..num_patches_h {
                for pw in 0..num_patches_w {
                    let patch_idx = ph * num_patches_w + pw;
                    for c in 0..channels {
                        for i in 0..self.patch_size {
                            for j in 0..self.patch_size {
                                let img_h = ph * self.patch_size + i;
                                let img_w = pw * self.patch_size + j;
                                let img_idx = b * channels * height * width
                                    + c * height * width
                                    + img_h * width
                                    + img_w;
                                let patch_offset =
                                    c * self.patch_size * self.patch_size + i * self.patch_size + j;
                                let out_idx = b * self.num_patches * patch_dim
                                    + patch_idx * patch_dim
                                    + patch_offset;
                                patches[out_idx] = x_data[img_idx];
                            }
                        }
                    }
                }
            }
        }

        let output_tensor =
            Tensor::from_vec(patches, &[batch_size, self.num_patches, patch_dim]).unwrap();

        if x.requires_grad() && is_grad_enabled() {
            let grad_fn = GradFn::new(PatchExtractBackward {
                next_fns: vec![x.grad_fn().cloned()],
                input_shape: shape.clone(),
                patch_size: self.patch_size,
                num_patches_h,
                num_patches_w,
            });
            Variable::from_operation(output_tensor, grad_fn, true)
        } else {
            Variable::new(output_tensor, false)
        }
    }
}

impl Module for VisionTransformer {
    fn forward(&self, x: &Variable) -> Variable {
        let shape = x.shape();
        let batch_size = shape[0];

        // Extract patches: [B, C, H, W] -> [B, num_patches, patch_dim]
        let patches = self.extract_patches(x);

        // Embed patches: [B, num_patches, patch_dim] -> [B, num_patches, d_model]
        let patch_emb = self.patch_embedding.forward(&patches);

        // Prepend CLS token: expand to [B, 1, d_model] then cat with patches
        let cls_var = self.cls_token.variable();
        let cls_expanded = cls_var.expand(&[batch_size, 1, self.d_model]);
        let tokens = Variable::cat(&[&cls_expanded, &patch_emb], 1);

        // Add positional encoding
        let tokens = self.pos_encoding.forward(&tokens);

        // Pass through encoder
        let encoded = self.encoder.forward(&tokens);

        // Extract CLS token output: [B, num_patches+1, d_model] -> [B, 1, d_model] -> [B, d_model]
        let cls_output = encoded.narrow(1, 0, 1).reshape(&[batch_size, self.d_model]);

        // Classification head
        self.mlp_head.forward(&cls_output)
    }

    fn parameters(&self) -> Vec<Parameter> {
        let mut params = Vec::new();
        params.push(self.cls_token.clone());
        params.extend(self.patch_embedding.parameters());
        params.extend(self.encoder.parameters());
        params.extend(self.mlp_head.parameters());
        params
    }

    fn train(&mut self) {
        self.encoder.train();
    }

    fn eval(&mut self) {
        self.encoder.eval();
    }

    fn is_training(&self) -> bool {
        self.encoder.is_training()
    }
}

// =============================================================================
// Convenience Functions
// =============================================================================

/// Create ViT-Base for `ImageNet` (224x224, 1000 classes).
#[must_use]
pub fn vit_base() -> VisionTransformer {
    VisionTransformer::vit_base(224, 1000)
}

/// Create ViT-Large for `ImageNet` (224x224, 1000 classes).
#[must_use]
pub fn vit_large() -> VisionTransformer {
    VisionTransformer::vit_large(224, 1000)
}

// =============================================================================
// PatchExtractBackward
// =============================================================================

/// Gradient function for ViT patch extraction.
///
/// Scatters gradients from [B, num_patches, patch_dim] back to [B, C, H, W].
#[derive(Debug)]
struct PatchExtractBackward {
    next_fns: Vec<Option<GradFn>>,
    input_shape: Vec<usize>,
    patch_size: usize,
    num_patches_h: usize,
    num_patches_w: usize,
}

impl GradientFunction for PatchExtractBackward {
    fn apply(&self, grad_output: &Tensor<f32>) -> Vec<Option<Tensor<f32>>> {
        let (batch_size, channels, height, width) = (
            self.input_shape[0],
            self.input_shape[1],
            self.input_shape[2],
            self.input_shape[3],
        );
        let patch_dim = channels * self.patch_size * self.patch_size;
        let num_patches = self.num_patches_h * self.num_patches_w;

        let g_vec = grad_output.to_vec();
        let mut grad_input = vec![0.0f32; batch_size * channels * height * width];

        for b in 0..batch_size {
            for ph in 0..self.num_patches_h {
                for pw in 0..self.num_patches_w {
                    let patch_idx = ph * self.num_patches_w + pw;
                    for c in 0..channels {
                        for i in 0..self.patch_size {
                            for j in 0..self.patch_size {
                                let img_h = ph * self.patch_size + i;
                                let img_w = pw * self.patch_size + j;
                                let img_idx = b * channels * height * width
                                    + c * height * width
                                    + img_h * width
                                    + img_w;
                                let patch_offset =
                                    c * self.patch_size * self.patch_size + i * self.patch_size + j;
                                let out_idx = b * num_patches * patch_dim
                                    + patch_idx * patch_dim
                                    + patch_offset;
                                grad_input[img_idx] += g_vec[out_idx];
                            }
                        }
                    }
                }
            }
        }

        let gi = Tensor::from_vec(grad_input, &self.input_shape).unwrap();
        vec![Some(gi)]
    }

    fn name(&self) -> &'static str {
        "PatchExtractBackward"
    }

    fn next_functions(&self) -> &[Option<GradFn>] {
        &self.next_fns
    }

    fn as_any(&self) -> &dyn Any {
        self
    }
}

// =============================================================================
// Tests
// =============================================================================

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_positional_encoding() {
        let pe = PositionalEncoding::new(64, 100);
        let input = Variable::new(
            Tensor::from_vec(vec![0.0; 2 * 10 * 64], &[2, 10, 64]).unwrap(),
            false,
        );
        let output = pe.forward(&input);
        assert_eq!(output.shape(), vec![2, 10, 64]);
    }

    #[test]
    fn test_encoder_layer() {
        let layer = TransformerEncoderLayer::new(64, 4, 256, 0.1);
        let input = Variable::new(
            Tensor::from_vec(vec![1.0; 2 * 10 * 64], &[2, 10, 64]).unwrap(),
            false,
        );
        let output = layer.forward(&input);
        assert_eq!(output.shape(), vec![2, 10, 64]);
    }

    #[test]
    fn test_transformer_encoder() {
        let encoder = TransformerEncoder::new(64, 4, 2, 256, 0.1);
        let input = Variable::new(
            Tensor::from_vec(vec![1.0; 2 * 10 * 64], &[2, 10, 64]).unwrap(),
            false,
        );
        let output = encoder.forward(&input);
        assert_eq!(output.shape(), vec![2, 10, 64]);
    }

    #[test]
    fn test_transformer() {
        let transformer = Transformer::new(64, 4, 2, 2, 256, 0.1);
        let src = Variable::new(
            Tensor::from_vec(vec![1.0; 2 * 10 * 64], &[2, 10, 64]).unwrap(),
            false,
        );
        let tgt = Variable::new(
            Tensor::from_vec(vec![1.0; 2 * 5 * 64], &[2, 5, 64]).unwrap(),
            false,
        );
        let output = transformer.forward_full(&src, &tgt, None, None, None);
        assert_eq!(output.shape(), vec![2, 5, 64]);
    }

    #[test]
    fn test_vit_creation() {
        let vit = VisionTransformer::new(
            32,  // image_size
            8,   // patch_size
            3,   // channels
            10,  // num_classes
            64,  // d_model
            4,   // nhead
            2,   // num_layers
            256, // dim_ff
            0.1, // dropout
        );
        let params = vit.parameters();
        assert!(!params.is_empty());
    }

    #[test]
    fn test_vit_forward() {
        let vit = VisionTransformer::new(32, 8, 3, 10, 64, 4, 2, 256, 0.1);
        let input = Variable::new(
            Tensor::from_vec(vec![0.5; 2 * 3 * 32 * 32], &[2, 3, 32, 32]).unwrap(),
            false,
        );
        let output = vit.forward(&input);
        assert_eq!(output.shape(), vec![2, 10]);
    }

    #[test]
    fn test_vit_tiny() {
        let vit = VisionTransformer::vit_tiny(32, 10);
        let params = vit.parameters();
        assert!(!params.is_empty());
    }
}