Struct burn::optim::GradientsParams

pub struct GradientsParams { /* private fields */ }

Data type that contains gradients for parameters.

Implementations

impl GradientsParams

pub fn new() -> GradientsParams

Creates a new GradientsParams.

pub fn from_grads<B, M>( grads: <B as AutodiffBackend>::Gradients, module: &M, ) -> GradientsParams

where B: AutodiffBackend, M: AutodiffModule<B>,

Extract each tensor gradients for the given module.

Note: This consumes the gradients. See [‘from_module’] to extract gradients only for a specific module.

pub fn from_module<B, M>( grads: &mut <B as AutodiffBackend>::Gradients, module: &M, ) -> GradientsParams

where B: AutodiffBackend, M: AutodiffModule<B>,

Extract each tensor gradients for the given module.

pub fn from_params<B, M>( grads: &mut <B as AutodiffBackend>::Gradients, module: &M, params: &[ParamId], ) -> GradientsParams

where B: AutodiffBackend, M: AutodiffModule<B>,

Extract tensor gradients for the given module and given parameters.

pub fn get<B, const D: usize>(&self, id: ParamId) -> Option<Tensor<B, D>>

where B: Backend,

Get the gradients for the given parameter id.

Notes

You should use remove if you want to get the gradients only one time.

pub fn remove<B, const D: usize>(&mut self, id: ParamId) -> Option<Tensor<B, D>>

where B: Backend,

Remove the gradients for the given parameter id.

pub fn register<B, const D: usize>(&mut self, id: ParamId, value: Tensor<B, D>)

where B: Backend,

Register a gradients tensor for the given parameter id.

Notes

If a tensor is already registered for the given parameter id, it will be replaced.

pub fn len(&self) -> usize

The number of gradients tensors registered.

pub fn is_empty(&self) -> bool

If any tensor is contained.

pub fn to_device<B, M>( self, device: &<B as Backend>::Device, module: &M, ) -> GradientsParams

where B: AutodiffBackend, M: AutodiffModule<B>,

Change the device of each tensor gradients registered for the given module.

Trait Implementations

impl Debug for GradientsParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for GradientsParams

fn default() -> GradientsParams

Returns the “default value” for a type.