tch 0.1.6

Rust wrappers for the PyTorch C++ api (libtorch).
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

use super::tensor::Tensor;
use failure::Fallible;
use libc::c_int;

pub struct COptimizer {
    c_optimizer: *mut torch_sys::C_optimizer,
}

impl std::fmt::Debug for COptimizer {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "optimizer")
    }
}

impl COptimizer {
    pub fn adam(lr: f64, beta1: f64, beta2: f64, wd: f64) -> Fallible<COptimizer> {
        let c_optimizer = unsafe_torch_err!({ torch_sys::ato_adam(lr, beta1, beta2, wd) });
        Ok(COptimizer { c_optimizer })
    }

    // Maybe we should use the builder pattern to provide default values for these ?
    pub fn rms_prop(
        lr: f64,
        alpha: f64,
        eps: f64,
        wd: f64,
        momentum: f64,
        centered: bool,
    ) -> Fallible<COptimizer> {
        let centered = if centered { 1 } else { 0 };
        let c_optimizer =
            unsafe_torch_err!({ torch_sys::ato_rms_prop(lr, alpha, eps, wd, momentum, centered) });
        Ok(COptimizer { c_optimizer })
    }

    pub fn sgd(
        lr: f64,
        momentum: f64,
        dampening: f64,
        wd: f64,
        nesterov: bool,
    ) -> Fallible<COptimizer> {
        let nesterov = if nesterov { 1 } else { 0 };
        let c_optimizer =
            unsafe_torch_err!({ torch_sys::ato_sgd(lr, momentum, dampening, wd, nesterov) });
        Ok(COptimizer { c_optimizer })
    }

    pub fn add_parameters(&mut self, ts: &[Tensor]) -> Fallible<()> {
        let ts: Vec<_> = ts.iter().map(|x| x.c_tensor).collect();
        unsafe_torch_err!({
            torch_sys::ato_add_parameters(self.c_optimizer, ts.as_ptr(), ts.len() as c_int)
        });
        Ok(())
    }

    pub fn set_learning_rate(&mut self, lr: f64) -> Fallible<()> {
        unsafe_torch_err!({ torch_sys::ato_set_learning_rate(self.c_optimizer, lr) });
        Ok(())
    }

    pub fn set_momentum(&mut self, m: f64) -> Fallible<()> {
        unsafe_torch_err!({ torch_sys::ato_set_momentum(self.c_optimizer, m) });
        Ok(())
    }

    pub fn zero_grad(&self) -> Fallible<()> {
        unsafe_torch_err!({ torch_sys::ato_zero_grad(self.c_optimizer) });
        Ok(())
    }

    pub fn step(&self) -> Fallible<()> {
        unsafe_torch_err!({ torch_sys::ato_step(self.c_optimizer) });
        Ok(())
    }
}

impl Drop for COptimizer {
    fn drop(&mut self) {
        unsafe { torch_sys::ato_free(self.c_optimizer) }
    }
}