burn-tensor 0.22.0-pre.4

Tensor library with user-friendly APIs and automatic differentiation support
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

use crate::{bridge::BasicOps, ops::BridgeTensor};

/// Trait that list all operations that can be applied on all tensors on an autodiff backend.
///
/// # Warnings
///
/// This is an internal trait, use the public API provided by the [`Tensor`](crate::Tensor) struct.
pub(crate) trait BasicAutodiffOps: BasicOps {
    /// Returns the inner tensor without the autodiff information.
    ///
    /// # Remarks
    ///
    /// This is a low-level function used internally by the library to call different backend functions
    /// with static dispatch. It is not designed for direct usage by users, and not recommended to import
    /// or use this function directly.
    ///
    /// Users should prefer [`Tensor::without_autodiff`](crate::Tensor::without_autodiff), or its
    /// [`Tensor::inner`](crate::Tensor::inner) equivalent, which are designed for public use.
    fn inner(tensor: BridgeTensor) -> BridgeTensor;

    /// Convert a tensor to the autodiff backend.
    ///
    /// # Remarks
    ///
    /// This is a low-level function used internally by the library to call different backend functions
    /// with static dispatch. It is not designed for direct usage by users, and not recommended to import
    /// or use this function directly.
    ///
    /// Users should prefer [`Tensor::autodiff`](crate::Tensor::autodiff), or its
    /// [`Tensor::from_inner`](crate::Tensor::from_inner) equivalent, which are designed for public
    /// use.
    fn from_inner(inner: BridgeTensor) -> BridgeTensor;
}