Struct burn::module::Param

source · [−]

pub struct Param<T> { /* private fields */ }

Implementations

source

pub fn inner(&self) -> Param<Vec<M::InnerModule>>where
M: ADModule,
M::Backend: ADBackend,

source

impl<M: Module> Param<M>

source

pub fn inner(&self) -> Param<M::InnerModule>where
M: ADModule,
M::Backend: ADBackend,

source

impl<const D: usize, B: Backend> Param<Tensor<B, D>>

source

pub fn inner(&self) -> Param<Tensor<B::InnerBackend, D>>where
B: ADBackend,

source

impl<const D: usize, B: Backend> Param<Option<Tensor<B, D>>>

source

pub fn inner(&self) -> Param<Option<Tensor<B::InnerBackend, D>>>where
B: ADBackend,

Trait Implementations

source

impl<T: Debug> Debug for Param<T>

source

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

Formats the value using the given formatter. Read more

source

impl<T> Deref for Param<T>

type Target = T

The resulting type after dereferencing.

source

fn deref(&self) -> &Self::Target

Dereferences the value.

source

impl<T> Display for Param<T>

source

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

Formats the value using the given formatter. Read more

source

impl<M: Module> Module for Param<M>

type Backend = <M as Module>::Backend

source

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules.

source

fn update_params<O: Optimizer<Backend = M::Backend>>(
 &mut self,
 grads: &Gradients,
 optim: &mut O
)where
 M::Backend: ADBackend,

Update the module parameters with the given gradients and optimizer.

source

fn load_optim_state<O: Optimizer<Backend = M::Backend>>(
 &self,
 optim: &mut O,
 state_optim: &StateNamed<<M::Backend as Backend>::Elem>
)where
 M::Backend: ADBackend,

Load the optimizer state for the module, including all of its sub-modules. Read more

source

fn register_optim_state<O: Optimizer<Backend = M::Backend>>(
 &self,
 optim: &O,
 state_optim: &mut StateNamed<<M::Backend as Backend>::Elem>
)where
 M::Backend: ADBackend,

Register the optimizer state for the module, including all of its sub-modules. Read more

source

fn devices(&self) -> Vec<<M::Backend as Backend>::Device>

Get the device list of the module and all of its sub-modules.

source

fn to_device(&mut self, device: <Self::Backend as Backend>::Device)

Move the module and all of its sub-modules to the given device.

source

fn state(&self) -> State<<M::Backend as Backend>::Elem>

Get the module state.

source

fn load(
&mut self,
state: &State<<M::Backend as Backend>::Elem>
) -> Result<(), LoadingError>

Load the module state.

source

impl<const D: usize, B: Backend> Module for Param<Option<Tensor<B, D>>>

type Backend = B

source

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules.

source

fn update_params<O: Optimizer<Backend = B>>(
 &mut self,
 grads: &Gradients,
 optim: &mut O
)where
 B: ADBackend,

Update the module parameters with the given gradients and optimizer.

source

fn load_optim_state<O: Optimizer<Backend = B>>(
 &self,
 optim: &mut O,
 state_optim: &StateNamed<B::Elem>
)where
 B: ADBackend,

Load the optimizer state for the module, including all of its sub-modules. Read more

source

fn register_optim_state<O: Optimizer<Backend = B>>(
 &self,
 optim: &O,
 state_optim: &mut StateNamed<B::Elem>
)where
 B: ADBackend,

Register the optimizer state for the module, including all of its sub-modules. Read more

source

fn devices(&self) -> Vec<B::Device>

Get the device list of the module and all of its sub-modules.

source

fn to_device(&mut self, device: B::Device)

Move the module and all of its sub-modules to the given device.

source

fn state(&self) -> State<B::Elem>

Get the module state.

source

fn load(&mut self, state: &State<B::Elem>) -> Result<(), LoadingError>

Load the module state.

source

impl<const D: usize, B: Backend> Module for Param<Tensor<B, D>>

type Backend = B

source

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules.

source

fn update_params<O: Optimizer<Backend = B>>(
 &mut self,
 grads: &Gradients,
 optim: &mut O
)where
 B: ADBackend,

Update the module parameters with the given gradients and optimizer.

source

fn load_optim_state<O: Optimizer<Backend = B>>(
 &self,
 optim: &mut O,
 state_optim: &StateNamed<B::Elem>
)where
 B: ADBackend,

Load the optimizer state for the module, including all of its sub-modules. Read more

source

fn register_optim_state<O: Optimizer<Backend = B>>(
 &self,
 optim: &O,
 state_optim: &mut StateNamed<B::Elem>
)where
 B: ADBackend,

Register the optimizer state for the module, including all of its sub-modules. Read more

source

fn devices(&self) -> Vec<B::Device>

Get the device list of the module and all of its sub-modules.

source

fn to_device(&mut self, device: B::Device)

Move the module and all of its sub-modules to the given device.

source

fn state(&self) -> State<B::Elem>

Get the module state.

source

fn load(&mut self, state: &State<B::Elem>) -> Result<(), LoadingError>

Load the module state.

source

impl<M: Module> Module for Param<Vec<M>>

type Backend = <M as Module>::Backend

source

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules.

source

fn update_params<O: Optimizer<Backend = M::Backend>>(
 &mut self,
 grads: &Gradients,
 optim: &mut O
)where
 M::Backend: ADBackend,

Update the module parameters with the given gradients and optimizer.

source

fn load_optim_state<O: Optimizer<Backend = M::Backend>>(
 &self,
 optim: &mut O,
 state_optim: &StateNamed<<M::Backend as Backend>::Elem>
)where
 M::Backend: ADBackend,

Load the optimizer state for the module, including all of its sub-modules. Read more

source

fn register_optim_state<O: Optimizer<Backend = M::Backend>>(
 &self,
 optim: &O,
 state_optim: &mut StateNamed<<M::Backend as Backend>::Elem>
)where
 M::Backend: ADBackend,

Register the optimizer state for the module, including all of its sub-modules. Read more

source

fn devices(&self) -> Vec<<M::Backend as Backend>::Device>

Get the device list of the module and all of its sub-modules.

source

fn to_device(&mut self, device: <M::Backend as Backend>::Device)

Move the module and all of its sub-modules to the given device.

source

fn state(&self) -> State<<M::Backend as Backend>::Elem>

Get the module state.

source

fn load(
&mut self,
state: &State<<M::Backend as Backend>::Elem>
) -> Result<(), LoadingError>

Load the module state.

Auto Trait Implementations

impl<T> RefUnwindSafe for Param<T>where
T: RefUnwindSafe,

impl<T> Send for Param<T>where
T: Send,

impl<T> Sync for Param<T>where
T: Sync,

impl<T> Unpin for Param<T>where
T: Unpin,

impl<T> UnwindSafe for Param<T>where
T: UnwindSafe,

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Fake for T

fn fake(&self) -> Uwhere
Self: FakeBase,

fn fake_with_rng<U, R>(&self, rng: &mut R) -> Uwhere
R: Rng + ?Sized,
Self: FakeBase,

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToString for Twhere
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct burn::module::Param

Implementations

impl<T> Param<T>

pub fn new(value: T) -> Self

impl<M: Module> Param<Vec<M>>

pub fn inner(&self) -> Param<Vec<M::InnerModule>>where M: ADModule, M::Backend: ADBackend,

impl<M: Module> Param<M>

pub fn inner(&self) -> Param<M::InnerModule>where M: ADModule, M::Backend: ADBackend,

impl<const D: usize, B: Backend> Param<Tensor<B, D>>

pub fn inner(&self) -> Param<Tensor<B::InnerBackend, D>>where B: ADBackend,

impl<const D: usize, B: Backend> Param<Option<Tensor<B, D>>>

pub fn inner(&self) -> Param<Option<Tensor<B::InnerBackend, D>>>where B: ADBackend,

Trait Implementations

impl<T: Debug> Debug for Param<T>

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

impl<T> Deref for Param<T>

type Target = T

fn deref(&self) -> &Self::Target

impl<T> Display for Param<T>

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

impl<M: Module> Module for Param<M>

type Backend = <M as Module>::Backend

fn num_params(&self) -> usize

fn update_params<O: Optimizer<Backend = M::Backend>>( &mut self, grads: &Gradients, optim: &mut O)where M::Backend: ADBackend,

fn load_optim_state<O: Optimizer<Backend = M::Backend>>( &self, optim: &mut O, state_optim: &StateNamed<<M::Backend as Backend>::Elem>)where M::Backend: ADBackend,

fn register_optim_state<O: Optimizer<Backend = M::Backend>>( &self, optim: &O, state_optim: &mut StateNamed<<M::Backend as Backend>::Elem>)where M::Backend: ADBackend,

fn devices(&self) -> Vec<<M::Backend as Backend>::Device>

fn to_device(&mut self, device: <Self::Backend as Backend>::Device)

fn state(&self) -> State<<M::Backend as Backend>::Elem>

fn load( &mut self, state: &State<<M::Backend as Backend>::Elem>) -> Result<(), LoadingError>

impl<const D: usize, B: Backend> Module for Param<Option<Tensor<B, D>>>

type Backend = B

fn num_params(&self) -> usize

fn update_params<O: Optimizer<Backend = B>>( &mut self, grads: &Gradients, optim: &mut O)where B: ADBackend,

fn load_optim_state<O: Optimizer<Backend = B>>( &self, optim: &mut O, state_optim: &StateNamed<B::Elem>)where B: ADBackend,

fn register_optim_state<O: Optimizer<Backend = B>>( &self, optim: &O, state_optim: &mut StateNamed<B::Elem>)where B: ADBackend,

fn devices(&self) -> Vec<B::Device>

fn to_device(&mut self, device: B::Device)

fn state(&self) -> State<B::Elem>

fn load(&mut self, state: &State<B::Elem>) -> Result<(), LoadingError>

impl<const D: usize, B: Backend> Module for Param<Tensor<B, D>>

type Backend = B

fn num_params(&self) -> usize

fn update_params<O: Optimizer<Backend = B>>( &mut self, grads: &Gradients, optim: &mut O)where B: ADBackend,

fn load_optim_state<O: Optimizer<Backend = B>>( &self, optim: &mut O, state_optim: &StateNamed<B::Elem>)where B: ADBackend,

fn register_optim_state<O: Optimizer<Backend = B>>( &self, optim: &O, state_optim: &mut StateNamed<B::Elem>)where B: ADBackend,

fn devices(&self) -> Vec<B::Device>

fn to_device(&mut self, device: B::Device)

fn state(&self) -> State<B::Elem>

fn load(&mut self, state: &State<B::Elem>) -> Result<(), LoadingError>

impl<M: Module> Module for Param<Vec<M>>

type Backend = <M as Module>::Backend

fn num_params(&self) -> usize

fn update_params<O: Optimizer<Backend = M::Backend>>( &mut self, grads: &Gradients, optim: &mut O)where M::Backend: ADBackend,

fn load_optim_state<O: Optimizer<Backend = M::Backend>>( &self, optim: &mut O, state_optim: &StateNamed<<M::Backend as Backend>::Elem>)where M::Backend: ADBackend,

fn register_optim_state<O: Optimizer<Backend = M::Backend>>( &self, optim: &O, state_optim: &mut StateNamed<<M::Backend as Backend>::Elem>)where M::Backend: ADBackend,

fn devices(&self) -> Vec<<M::Backend as Backend>::Device>

fn to_device(&mut self, device: <M::Backend as Backend>::Device)

fn state(&self) -> State<<M::Backend as Backend>::Elem>

fn load( &mut self, state: &State<<M::Backend as Backend>::Elem>) -> Result<(), LoadingError>

Auto Trait Implementations

impl<T> RefUnwindSafe for Param<T>where T: RefUnwindSafe,

impl<T> Send for Param<T>where T: Send,

impl<T> Sync for Param<T>where T: Sync,

impl<T> Unpin for Param<T>where T: Unpin,

impl<T> UnwindSafe for Param<T>where T: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Fake for T

fn fake<U>(&self) -> Uwhere Self: FakeBase<U>,

fn fake_with_rng<U, R>(&self, rng: &mut R) -> Uwhere R: Rng + ?Sized, Self: FakeBase<U>,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

pub fn inner(&self) -> Param<Vec<M::InnerModule>>where
M: ADModule,
M::Backend: ADBackend,

pub fn inner(&self) -> Param<M::InnerModule>where
M: ADModule,
M::Backend: ADBackend,

pub fn inner(&self) -> Param<Tensor<B::InnerBackend, D>>where
B: ADBackend,

pub fn inner(&self) -> Param<Option<Tensor<B::InnerBackend, D>>>where
B: ADBackend,

fn update_params<O: Optimizer<Backend = M::Backend>>(
&mut self,
grads: &Gradients,
optim: &mut O
)where
M::Backend: ADBackend,

fn load_optim_state<O: Optimizer<Backend = M::Backend>>(
&self,
optim: &mut O,
state_optim: &StateNamed<<M::Backend as Backend>::Elem>
)where
M::Backend: ADBackend,

fn register_optim_state<O: Optimizer<Backend = M::Backend>>(
&self,
optim: &O,
state_optim: &mut StateNamed<<M::Backend as Backend>::Elem>
)where
M::Backend: ADBackend,

fn load(
&mut self,
state: &State<<M::Backend as Backend>::Elem>
) -> Result<(), LoadingError>

fn update_params<O: Optimizer<Backend = B>>(
&mut self,
grads: &Gradients,
optim: &mut O
)where
B: ADBackend,

fn load_optim_state<O: Optimizer<Backend = B>>(
&self,
optim: &mut O,
state_optim: &StateNamed<B::Elem>
)where
B: ADBackend,

fn register_optim_state<O: Optimizer<Backend = B>>(
&self,
optim: &O,
state_optim: &mut StateNamed<B::Elem>
)where
B: ADBackend,

fn update_params<O: Optimizer<Backend = B>>(
&mut self,
grads: &Gradients,
optim: &mut O
)where
B: ADBackend,

fn load_optim_state<O: Optimizer<Backend = B>>(
&self,
optim: &mut O,
state_optim: &StateNamed<B::Elem>
)where
B: ADBackend,

fn register_optim_state<O: Optimizer<Backend = B>>(
&self,
optim: &O,
state_optim: &mut StateNamed<B::Elem>
)where
B: ADBackend,

fn update_params<O: Optimizer<Backend = M::Backend>>(
&mut self,
grads: &Gradients,
optim: &mut O
)where
M::Backend: ADBackend,

fn load_optim_state<O: Optimizer<Backend = M::Backend>>(
&self,
optim: &mut O,
state_optim: &StateNamed<<M::Backend as Backend>::Elem>
)where
M::Backend: ADBackend,

fn register_optim_state<O: Optimizer<Backend = M::Backend>>(
&self,
optim: &O,
state_optim: &mut StateNamed<<M::Backend as Backend>::Elem>
)where
M::Backend: ADBackend,

fn load(
&mut self,
state: &State<<M::Backend as Backend>::Elem>
) -> Result<(), LoadingError>

impl<T> RefUnwindSafe for Param<T>where
T: RefUnwindSafe,

impl<T> Send for Param<T>where
T: Send,

impl<T> Sync for Param<T>where
T: Sync,

impl<T> Unpin for Param<T>where
T: Unpin,

impl<T> UnwindSafe for Param<T>where
T: UnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

fn fake<U>(&self) -> Uwhere
Self: FakeBase<U>,

fn fake_with_rng<U, R>(&self, rng: &mut R) -> Uwhere
R: Rng + ?Sized,
Self: FakeBase<U>,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToString for Twhere
T: Display + ?Sized,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

impl<T> Formattable for Twhere
T: Deref,
<T as Deref>::Target: Formattable,