Struct dfdx::nn::tensor_collection::TensorOptions
source · #[non_exhaustive]pub struct TensorOptions<S: Shape, E: Dtype, D: Device<E>> {
pub do_gradient_update: bool,
pub reset: fn(_: &mut Tensor<S, E, D>) -> Result<(), D::Err>,
pub shape: S,
}
Expand description
Options to change behavior of ModuleVisitor
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.do_gradient_update: bool
Whether the tensor should be updated with gradients
reset: fn(_: &mut Tensor<S, E, D>) -> Result<(), D::Err>
How to reset the tensor in the future.
shape: S
The Shape that BuildModule uses to construct the tensor
Implementations§
source§impl<S: Shape, E: Dtype, D: Device<E>> TensorOptions<S, E, D>
impl<S: Shape, E: Dtype, D: Device<E>> TensorOptions<S, E, D>
sourcepub fn reset_to_zeros() -> Selfwhere
D: ZeroFillStorage<E>,
S: ConstShape,
pub fn reset_to_zeros() -> Selfwhere D: ZeroFillStorage<E>, S: ConstShape,
A tensor that should be updated with gradients & reset to 0
sourcepub fn reset_to_ones() -> Selfwhere
D: OneFillStorage<E>,
S: ConstShape,
pub fn reset_to_ones() -> Selfwhere D: OneFillStorage<E>, S: ConstShape,
A tensor that should be updated with gradients & reset to 1
sourcepub fn reset_with(
reset: fn(_: &mut Tensor<S, E, D>) -> Result<(), D::Err>
) -> Selfwhere
S: ConstShape,
pub fn reset_with( reset: fn(_: &mut Tensor<S, E, D>) -> Result<(), D::Err> ) -> Selfwhere S: ConstShape,
A tensor that should be updated with gradients & reset with the fn passed in
Auto Trait Implementations§
impl<S, E, D> RefUnwindSafe for TensorOptions<S, E, D>where S: RefUnwindSafe,
impl<S, E, D> Send for TensorOptions<S, E, D>
impl<S, E, D> Sync for TensorOptions<S, E, D>
impl<S, E, D> Unpin for TensorOptions<S, E, D>where S: Unpin,
impl<S, E, D> UnwindSafe for TensorOptions<S, E, D>where S: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more