torsh-python 0.1.2

Python bindings for ToRSh - PyTorch-compatible deep learning in Rust
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
//! Dropout and regularization layers

use super::module::PyModule;
use crate::{error::PyResult, py_result, tensor::PyTensor};
use pyo3::prelude::*;
use std::collections::HashMap;

/// Dropout layer
#[pyclass(name = "Dropout", extends = PyModule)]
pub struct PyDropout {
    p: f32,
    inplace: bool,
    training: bool,
}

#[pymethods]
impl PyDropout {
    #[new]
    fn new(p: Option<f32>, inplace: Option<bool>) -> PyResult<(Self, PyModule)> {
        let p = p.unwrap_or(0.5);
        let inplace = inplace.unwrap_or(false);

        if !(0.0..=1.0).contains(&p) {
            return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(
                "dropout probability has to be between 0 and 1, but got {p}",
            ));
        }

        Ok((
            Self {
                p,
                inplace,
                training: true,
            },
            PyModule::new(),
        ))
    }

    /// Forward pass through dropout
    fn forward(&mut self, input: &PyTensor) -> PyResult<PyTensor> {
        // ✅ Proper dropout implementation with random mask
        if !self.training || self.p == 0.0 {
            // In eval mode or p=0, return input unchanged
            return Ok(PyTensor {
                tensor: input.tensor.clone(),
            });
        }

        if self.p == 1.0 {
            // All values dropped
            let zeros = py_result!(torsh_tensor::creation::zeros_like(&input.tensor))?;
            return Ok(PyTensor { tensor: zeros });
        }

        // ✅ SciRS2 POLICY: Use scirs2_core::random for RNG
        use scirs2_core::random::Distribution;
        use scirs2_core::random::{thread_rng, Uniform};

        let mut rng = thread_rng();
        let dist = Uniform::new(0.0_f32, 1.0_f32).map_err(|e| {
            PyErr::new::<pyo3::exceptions::PyValueError, _>(format!(
                "Failed to create uniform distribution: {}",
                e
            ))
        })?;

        let mut data = py_result!(input.tensor.data())?;
        let scale = 1.0 / (1.0 - self.p);

        for val in data.iter_mut() {
            if dist.sample(&mut rng) < self.p {
                *val = 0.0;
            } else {
                *val *= scale; // Scale to maintain expected value
            }
        }

        let shape = input.tensor.shape().dims().to_vec();
        let result = py_result!(torsh_tensor::Tensor::from_data(
            data,
            shape,
            input.tensor.device()
        ))?;

        Ok(PyTensor { tensor: result })
    }

    /// Get layer parameters (Dropout has no parameters)
    fn parameters(&self) -> PyResult<Vec<PyTensor>> {
        Ok(Vec::new())
    }

    /// Get named parameters (Dropout has no parameters)
    fn named_parameters(&self) -> PyResult<HashMap<String, PyTensor>> {
        Ok(HashMap::new())
    }

    /// Set training mode
    fn train(&mut self, mode: Option<bool>) -> PyResult<()> {
        self.training = mode.unwrap_or(true);
        Ok(())
    }

    /// Set evaluation mode
    fn eval(&mut self) -> PyResult<()> {
        self.training = false;
        Ok(())
    }

    /// String representation
    fn __repr__(&self) -> String {
        format!("Dropout(p={}, inplace={})", self.p, self.inplace)
    }
}

/// 2D Dropout layer
#[pyclass(name = "Dropout2d", extends = PyModule)]
pub struct PyDropout2d {
    p: f32,
    inplace: bool,
    training: bool,
}

#[pymethods]
impl PyDropout2d {
    #[new]
    fn new(p: Option<f32>, inplace: Option<bool>) -> PyResult<(Self, PyModule)> {
        let p = p.unwrap_or(0.5);
        let inplace = inplace.unwrap_or(false);

        if !(0.0..=1.0).contains(&p) {
            return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(
                "dropout probability has to be between 0 and 1, but got {p}",
            ));
        }

        Ok((
            Self {
                p,
                inplace,
                training: true,
            },
            PyModule::new(),
        ))
    }

    /// Forward pass through 2D dropout
    fn forward(&mut self, input: &PyTensor) -> PyResult<PyTensor> {
        // ✅ Proper 2D dropout implementation - drops entire channels
        if !self.training || self.p == 0.0 {
            return Ok(PyTensor {
                tensor: input.tensor.clone(),
            });
        }

        if self.p == 1.0 {
            let zeros = py_result!(torsh_tensor::creation::zeros_like(&input.tensor))?;
            return Ok(PyTensor { tensor: zeros });
        }

        // ✅ SciRS2 POLICY: Use scirs2_core::random for RNG
        use scirs2_core::random::Distribution;
        use scirs2_core::random::{thread_rng, Uniform};

        let shape = input.tensor.shape().dims().to_vec();
        if shape.len() < 2 {
            return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(
                "Dropout2d expects at least 2D input",
            ));
        }

        let mut rng = thread_rng();
        let dist = Uniform::new(0.0_f32, 1.0_f32).map_err(|e| {
            PyErr::new::<pyo3::exceptions::PyValueError, _>(format!(
                "Failed to create uniform distribution: {}",
                e
            ))
        })?;

        let batch_size = shape[0];
        let channels = shape[1];
        let spatial_size: usize = shape[2..].iter().product();

        let mut data = py_result!(input.tensor.data())?;
        let scale = 1.0 / (1.0 - self.p);

        // Drop entire channels
        for b in 0..batch_size {
            for c in 0..channels {
                if dist.sample(&mut rng) < self.p {
                    // Drop entire channel
                    let start = (b * channels + c) * spatial_size;
                    let end = start + spatial_size;
                    for val in &mut data[start..end] {
                        *val = 0.0;
                    }
                } else {
                    // Scale channel
                    let start = (b * channels + c) * spatial_size;
                    let end = start + spatial_size;
                    for val in &mut data[start..end] {
                        *val *= scale;
                    }
                }
            }
        }

        let result = py_result!(torsh_tensor::Tensor::from_data(
            data,
            shape.to_vec(),
            input.tensor.device()
        ))?;

        Ok(PyTensor { tensor: result })
    }

    /// Get layer parameters (Dropout2d has no parameters)
    fn parameters(&self) -> PyResult<Vec<PyTensor>> {
        Ok(Vec::new())
    }

    /// Get named parameters (Dropout2d has no parameters)
    fn named_parameters(&self) -> PyResult<HashMap<String, PyTensor>> {
        Ok(HashMap::new())
    }

    /// Set training mode
    fn train(&mut self, mode: Option<bool>) -> PyResult<()> {
        self.training = mode.unwrap_or(true);
        Ok(())
    }

    /// Set evaluation mode
    fn eval(&mut self) -> PyResult<()> {
        self.training = false;
        Ok(())
    }

    /// String representation
    fn __repr__(&self) -> String {
        format!("Dropout2d(p={}, inplace={})", self.p, self.inplace)
    }
}

/// 3D Dropout layer
#[pyclass(name = "Dropout3d", extends = PyModule)]
pub struct PyDropout3d {
    p: f32,
    inplace: bool,
    training: bool,
}

#[pymethods]
impl PyDropout3d {
    #[new]
    fn new(p: Option<f32>, inplace: Option<bool>) -> PyResult<(Self, PyModule)> {
        let p = p.unwrap_or(0.5);
        let inplace = inplace.unwrap_or(false);

        if !(0.0..=1.0).contains(&p) {
            return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(
                "dropout probability has to be between 0 and 1, but got {p}",
            ));
        }

        Ok((
            Self {
                p,
                inplace,
                training: true,
            },
            PyModule::new(),
        ))
    }

    /// Forward pass through 3D dropout
    fn forward(&mut self, input: &PyTensor) -> PyResult<PyTensor> {
        // ✅ Proper 3D dropout implementation - drops entire channels (same as 2D)
        if !self.training || self.p == 0.0 {
            return Ok(PyTensor {
                tensor: input.tensor.clone(),
            });
        }

        if self.p == 1.0 {
            let zeros = py_result!(torsh_tensor::creation::zeros_like(&input.tensor))?;
            return Ok(PyTensor { tensor: zeros });
        }

        // ✅ SciRS2 POLICY: Use scirs2_core::random for RNG
        use scirs2_core::random::Distribution;
        use scirs2_core::random::{thread_rng, Uniform};

        let shape = input.tensor.shape().dims().to_vec();
        if shape.len() < 3 {
            return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(
                "Dropout3d expects at least 3D input",
            ));
        }

        let mut rng = thread_rng();
        let dist = Uniform::new(0.0_f32, 1.0_f32).map_err(|e| {
            PyErr::new::<pyo3::exceptions::PyValueError, _>(format!(
                "Failed to create uniform distribution: {}",
                e
            ))
        })?;

        let batch_size = shape[0];
        let channels = shape[1];
        let spatial_size: usize = shape[2..].iter().product();

        let mut data = py_result!(input.tensor.data())?;
        let scale = 1.0 / (1.0 - self.p);

        // Drop entire channels
        for b in 0..batch_size {
            for c in 0..channels {
                if dist.sample(&mut rng) < self.p {
                    // Drop entire channel
                    let start = (b * channels + c) * spatial_size;
                    let end = start + spatial_size;
                    for val in &mut data[start..end] {
                        *val = 0.0;
                    }
                } else {
                    // Scale channel
                    let start = (b * channels + c) * spatial_size;
                    let end = start + spatial_size;
                    for val in &mut data[start..end] {
                        *val *= scale;
                    }
                }
            }
        }

        let result = py_result!(torsh_tensor::Tensor::from_data(
            data,
            shape.to_vec(),
            input.tensor.device()
        ))?;

        Ok(PyTensor { tensor: result })
    }

    /// Get layer parameters (Dropout3d has no parameters)
    fn parameters(&self) -> PyResult<Vec<PyTensor>> {
        Ok(Vec::new())
    }

    /// Get named parameters (Dropout3d has no parameters)
    fn named_parameters(&self) -> PyResult<HashMap<String, PyTensor>> {
        Ok(HashMap::new())
    }

    /// Set training mode
    fn train(&mut self, mode: Option<bool>) -> PyResult<()> {
        self.training = mode.unwrap_or(true);
        Ok(())
    }

    /// Set evaluation mode
    fn eval(&mut self) -> PyResult<()> {
        self.training = false;
        Ok(())
    }

    /// String representation
    fn __repr__(&self) -> String {
        format!("Dropout3d(p={}, inplace={})", self.p, self.inplace)
    }
}

/// Alpha Dropout layer (for SELU activation)
#[pyclass(name = "AlphaDropout", extends = PyModule)]
pub struct PyAlphaDropout {
    p: f32,
    inplace: bool,
    training: bool,
}

#[pymethods]
impl PyAlphaDropout {
    #[new]
    fn new(p: Option<f32>, inplace: Option<bool>) -> PyResult<(Self, PyModule)> {
        let p = p.unwrap_or(0.5);
        let inplace = inplace.unwrap_or(false);

        if !(0.0..=1.0).contains(&p) {
            return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(
                "dropout probability has to be between 0 and 1, but got {p}",
            ));
        }

        Ok((
            Self {
                p,
                inplace,
                training: true,
            },
            PyModule::new(),
        ))
    }

    /// Forward pass through alpha dropout
    fn forward(&mut self, input: &PyTensor) -> PyResult<PyTensor> {
        // ✅ Proper AlphaDropout implementation for SELU networks
        if !self.training || self.p == 0.0 {
            return Ok(PyTensor {
                tensor: input.tensor.clone(),
            });
        }

        if self.p == 1.0 {
            // When p=1, all values are set to alpha'
            let alpha_prime = -1.7580993408473766_f32;
            let mut data = py_result!(input.tensor.data())?;
            for val in data.iter_mut() {
                *val = alpha_prime;
            }
            let shape = input.tensor.shape().dims().to_vec();
            let result = py_result!(torsh_tensor::Tensor::from_data(
                data,
                shape,
                input.tensor.device()
            ))?;
            return Ok(PyTensor { tensor: result });
        }

        // ✅ SciRS2 POLICY: Use scirs2_core::random for RNG
        use scirs2_core::random::Distribution;
        use scirs2_core::random::{thread_rng, Uniform};

        // SELU constants
        let _alpha = 1.6732632423543772_f32;
        let alpha_prime = -1.7580993408473766_f32; // -alpha * lambda where lambda = 1.0507

        // Calculate affine transformation parameters to maintain self-normalization
        let a = ((1.0 - self.p) * (1.0 + self.p * alpha_prime * alpha_prime)).sqrt();
        let b = -a * alpha_prime * self.p;

        let mut rng = thread_rng();
        let dist = Uniform::new(0.0_f32, 1.0_f32).map_err(|e| {
            PyErr::new::<pyo3::exceptions::PyValueError, _>(format!(
                "Failed to create uniform distribution: {}",
                e
            ))
        })?;

        let mut data = py_result!(input.tensor.data())?;

        for val in data.iter_mut() {
            if dist.sample(&mut rng) < self.p {
                // Set to alpha' and apply affine transformation
                *val = (*val * 0.0 + alpha_prime) * a + b;
            } else {
                // Keep value and apply affine transformation
                *val = *val * a + b;
            }
        }

        let shape = input.tensor.shape().dims().to_vec();
        let result = py_result!(torsh_tensor::Tensor::from_data(
            data,
            shape,
            input.tensor.device()
        ))?;

        Ok(PyTensor { tensor: result })
    }

    /// Get layer parameters (AlphaDropout has no parameters)
    fn parameters(&self) -> PyResult<Vec<PyTensor>> {
        Ok(Vec::new())
    }

    /// Get named parameters (AlphaDropout has no parameters)
    fn named_parameters(&self) -> PyResult<HashMap<String, PyTensor>> {
        Ok(HashMap::new())
    }

    /// Set training mode
    fn train(&mut self, mode: Option<bool>) -> PyResult<()> {
        self.training = mode.unwrap_or(true);
        Ok(())
    }

    /// Set evaluation mode
    fn eval(&mut self) -> PyResult<()> {
        self.training = false;
        Ok(())
    }

    /// String representation
    fn __repr__(&self) -> String {
        format!("AlphaDropout(p={}, inplace={})", self.p, self.inplace)
    }
}