Struct burn_core::module::Param

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

Define a parameter.

Implementations

impl<T> Param<T>

pub fn new(id: ParamId, value: T) -> Self

Constructs a new Param.

impl<T: Clone> Param<T>

pub fn val(&self) -> T

Gets the parameter value.

Returns

The parameter value.

pub fn map<F: FnOnce(T) -> T>(self, func: F) -> Self

Execute the given function on the inner value.

Trait Implementations

impl<const D: usize, B: AutodiffBackend> AutodiffModule<B> for Param<Tensor<B, D>>

type InnerModule = Param<Tensor<<B as AutodiffBackend>::InnerBackend, D>>

Inner module without auto-differentiation.

fn valid(&self) -> Self::InnerModule

Get the same module, but on the inner backend without auto-differentiation.

impl<const D: usize, B: AutodiffBackend> AutodiffModule<B> for Param<Tensor<B, D, Bool>>

type InnerModule = Param<Tensor<<B as AutodiffBackend>::InnerBackend, D, Bool>>

Inner module without auto-differentiation.

fn valid(&self) -> Self::InnerModule

Get the same module, but on the inner backend without auto-differentiation.

impl<const D: usize, B: AutodiffBackend> AutodiffModule<B> for Param<Tensor<B, D, Int>>

type InnerModule = Param<Tensor<<B as AutodiffBackend>::InnerBackend, D, Int>>

Inner module without auto-differentiation.

fn valid(&self) -> Self::InnerModule

Get the same module, but on the inner backend without auto-differentiation.

impl<T: Clone> Clone for Param<T>

fn clone(&self) -> Param<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T> Deref for Param<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> Display for Param<T>

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

Formats the value using the given formatter.

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

fn from(value: Tensor<B, D>) -> Self

Converts to this type from the input type.

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

fn from(value: Tensor<B, D, Bool>) -> Self

Converts to this type from the input type.

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

fn from(value: Tensor<B, D, Int>) -> Self

Converts to this type from the input type.

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

type Record = Param<Tensor<B, D>>

Type to save and load the module.

fn visit<V: ModuleVisitor<B>>(&self, visitor: &mut V)

Visit each tensor parameter in the module with a visitor.

fn map<M: ModuleMapper<B>>(self, mapper: &mut M) -> Self

Map each tensor parameter in the module with a mapper.

fn into_record(self) -> Self::Record

Convert the module into a record containing the state.

fn load_record(self, record: Self::Record) -> Self

Load the module state from a record.

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

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

fn fork(self, device: &<B as Backend>::Device) -> Self

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

fn collect_devices( &self, devices: Vec<<B as Backend>::Device> ) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree added to the given vector without duplicates.

fn devices(&self) -> Devices<B>

Return all the devices found in the underneath module tree without duplicates.

fn no_grad(self) -> Self

Each tensor in the module tree will not require grad.

fn num_params(&self) -> usize

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

fn save_file<FR: FileRecorder, PB: Into<PathBuf>>( self, file_path: PB, recorder: &FR ) -> Result<(), RecorderError>

Save the module to a file using the provided file recorder.

fn load_file<FR: FileRecorder, PB: Into<PathBuf>>( self, file_path: PB, recorder: &FR ) -> Result<Self, RecorderError>

Load the module from a file using the provided file recorder.

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

type Record = Param<Tensor<B, D, Bool>>

Type to save and load the module.

fn visit<V: ModuleVisitor<B>>(&self, visitor: &mut V)

Visit each tensor parameter in the module with a visitor.

fn map<M: ModuleMapper<B>>(self, mapper: &mut M) -> Self

Map each tensor parameter in the module with a mapper.

fn into_record(self) -> Self::Record

Convert the module into a record containing the state.

fn load_record(self, record: Self::Record) -> Self

Load the module state from a record.

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

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

fn fork(self, device: &<B as Backend>::Device) -> Self

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

fn collect_devices( &self, devices: Vec<<B as Backend>::Device> ) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree added to the given vector without duplicates.

fn devices(&self) -> Devices<B>

Return all the devices found in the underneath module tree without duplicates.

fn no_grad(self) -> Self

Each tensor in the module tree will not require grad.

fn num_params(&self) -> usize

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

fn save_file<FR: FileRecorder, PB: Into<PathBuf>>( self, file_path: PB, recorder: &FR ) -> Result<(), RecorderError>

Save the module to a file using the provided file recorder.

fn load_file<FR: FileRecorder, PB: Into<PathBuf>>( self, file_path: PB, recorder: &FR ) -> Result<Self, RecorderError>

Load the module from a file using the provided file recorder.

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

type Record = Param<Tensor<B, D, Int>>

Type to save and load the module.

fn visit<V: ModuleVisitor<B>>(&self, visitor: &mut V)

Visit each tensor parameter in the module with a visitor.

fn map<M: ModuleMapper<B>>(self, mapper: &mut M) -> Self

Map each tensor parameter in the module with a mapper.

fn into_record(self) -> Self::Record

Convert the module into a record containing the state.

fn load_record(self, record: Self::Record) -> Self

Load the module state from a record.

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

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

fn fork(self, device: &<B as Backend>::Device) -> Self

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

fn collect_devices( &self, devices: Vec<<B as Backend>::Device> ) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree added to the given vector without duplicates.

fn devices(&self) -> Devices<B>

Return all the devices found in the underneath module tree without duplicates.

fn no_grad(self) -> Self

Each tensor in the module tree will not require grad.

fn num_params(&self) -> usize

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

fn save_file<FR: FileRecorder, PB: Into<PathBuf>>( self, file_path: PB, recorder: &FR ) -> Result<(), RecorderError>

Save the module to a file using the provided file recorder.

fn load_file<FR: FileRecorder, PB: Into<PathBuf>>( self, file_path: PB, recorder: &FR ) -> Result<Self, RecorderError>

Load the module from a file using the provided file recorder.

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

type Item<S: PrecisionSettings> = ParamSerde<FloatTensorSerde<S>>

Type of the item that can be serialized and deserialized.

fn into_item<S: PrecisionSettings>(self) -> Self::Item<S>

Convert the current record into the corresponding item that follows the given settings.

fn from_item<S: PrecisionSettings>(item: Self::Item<S>) -> Self

Convert the given item into a record.

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

type Item<S: PrecisionSettings> = ParamSerde<BoolTensorSerde>

Type of the item that can be serialized and deserialized.

fn into_item<S: PrecisionSettings>(self) -> Self::Item<S>

Convert the current record into the corresponding item that follows the given settings.

fn from_item<S: PrecisionSettings>(item: Self::Item<S>) -> Self

Convert the given item into a record.

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

type Item<S: PrecisionSettings> = ParamSerde<IntTensorSerde<S>>

Type of the item that can be serialized and deserialized.

fn into_item<S: PrecisionSettings>(self) -> Self::Item<S>

Convert the current record into the corresponding item that follows the given settings.

fn from_item<S: PrecisionSettings>(item: Self::Item<S>) -> Self

Convert the given item into a record.