Struct burn::module::Param

pub struct Param<T>
where
    T: Parameter,
{
    pub id: ParamId,
    /* private fields */
}
Expand description

Parameters are the fundamental building blocks of modules where they serve as containers for tensors that can be updated during training, and loaded during inference. If you don’t want to save the tensors with a record and/or don’t want to update it during training, you don’t need this type to wrap your tensor.

§Laziness

The initialization of parameters can be lazy when created using uninitialized, which can be done using an initializer.

This reduces the amount of allocations done when loading a model for inference without having to create a custom initialization function only for inference.

§Example

ⓘ
let device = Device::default();
let config = ModuleConfig::default();
let record = Recorder::new().load("/path/to/module", &device);

// No tensor allocation
let module = config.init(device);
// Will use the tensor allocated for the record if the same device is used.
let module = module.load_record(record);

Fields§

§id: ParamId

The unique ID of this parameter. This is used by eg. optimizers to associate a gradient with a specific parameter.

Implementations§

§

impl<T> Param<T>
where T: Parameter,

pub fn initialized(id: ParamId, value: T) -> Param<T>

Create a new parameter that is already initialized.

pub fn uninitialized<F>( id: ParamId, init: F, device: <T as Parameter>::Device, is_require_grad: bool, ) -> Param<T>
where F: Fn(&<T as Parameter>::Device, bool) -> T + Send + 'static,

Create a new parameter that is not already initialized.

pub fn val(&self) -> T

Gets the parameter value.

pub fn into_value(self) -> T

Gets the parameter’s value while consuming the parameter.

pub fn consume(self) -> (ParamId, T)

Gets the parameter id and value while consuming the parameter.

pub fn map<F>(self, func: F) -> Param<T>
where F: Fn(T) -> T,

Execute the given function on the inner value.

pub fn set_require_grad(self, require_grad: bool) -> Param<T>

Override the gradient requirement for the current parameter.

§

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

pub fn from_tensor(value: Tensor<B, D>) -> Param<Tensor<B, D>>

Create a new parameter from a float tensor.

§Warnings

We strongly recommend using Param::uninitialized if you are using this method to initialize parameters inside a module, since the tensor initialization will be lazy, making the loading of weights more performant.

pub fn from_data<T>( data: T, device: &<B as Backend>::Device, ) -> Param<Tensor<B, D>>
where T: Into<TensorData>,

Create a new parameter from data.

Trait Implementations§

§

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

§

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

Inner module without auto-differentiation.
§

fn valid(&self) -> <Param<Tensor<B, D>> as AutodiffModule<B>>::InnerModule

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

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

§

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

Inner module without auto-differentiation.
§

fn valid(&self) -> <Param<Tensor<B, D, Bool>> as AutodiffModule<B>>::InnerModule

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

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

§

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

Inner module without auto-differentiation.
§

fn valid(&self) -> <Param<Tensor<B, D, Int>> as AutodiffModule<B>>::InnerModule

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

impl<T> Clone for Param<T>
where T: Parameter,

§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl<T> Debug for Param<T>
where T: Parameter,

§

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

Formats the value using the given formatter. Read more
§

impl<T> Deref for Param<T>
where T: Parameter,

§

type Target = T

The resulting type after dereferencing.
§

fn deref(&self) -> &<Param<T> as Deref>::Target

Dereferences the value.
§

impl<T> Display for Param<T>
where T: Parameter,

§

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

Formats the value using the given formatter. Read more
§

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

§

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

Type to save and load the module.
§

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

Visit each tensor parameter in the module with a visitor.
§

fn map<M>(self, mapper: &mut M) -> Param<Tensor<B, D>>
where M: ModuleMapper<B>,

Map each tensor parameter in the module with a mapper.
§

fn into_record(self) -> <Param<Tensor<B, D>> as Module<B>>::Record

Convert the module into a record containing the state.
§

fn load_record( self, record: <Param<Tensor<B, D>> as Module<B>>::Record, ) -> Param<Tensor<B, D>>

Load the module state from a record.
§

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

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

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

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

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) -> Vec<<B as Backend>::Device>

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. Read more
§

fn num_params(&self) -> usize

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

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

Save the module to a file using the provided file recorder. Read more
§

fn load_file<FR, PB>( self, file_path: PB, recorder: &FR, device: &<B as Backend>::Device, ) -> Result<Self, RecorderError>
where FR: FileRecorder<B>, PB: Into<PathBuf>,

Load the module from a file using the provided file recorder. Read more
§

fn quantize_weights<C>(self, quantizer: &mut Quantizer<C>) -> Self
where C: Calibration,

Quantize the weights of the module.
§

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

§

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

Type to save and load the module.
§

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

Visit each tensor parameter in the module with a visitor.
§

fn map<M>(self, mapper: &mut M) -> Param<Tensor<B, D, Bool>>
where M: ModuleMapper<B>,

Map each tensor parameter in the module with a mapper.
§

fn into_record(self) -> <Param<Tensor<B, D, Bool>> as Module<B>>::Record

Convert the module into a record containing the state.
§

fn load_record( self, record: <Param<Tensor<B, D, Bool>> as Module<B>>::Record, ) -> Param<Tensor<B, D, Bool>>

Load the module state from a record.
§

fn to_device(self, device: &<B as Backend>::Device) -> Param<Tensor<B, D, Bool>>

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

fn fork(self, device: &<B as Backend>::Device) -> Param<Tensor<B, D, Bool>>

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

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) -> Vec<<B as Backend>::Device>

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. Read more
§

fn num_params(&self) -> usize

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

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

Save the module to a file using the provided file recorder. Read more
§

fn load_file<FR, PB>( self, file_path: PB, recorder: &FR, device: &<B as Backend>::Device, ) -> Result<Self, RecorderError>
where FR: FileRecorder<B>, PB: Into<PathBuf>,

Load the module from a file using the provided file recorder. Read more
§

fn quantize_weights<C>(self, quantizer: &mut Quantizer<C>) -> Self
where C: Calibration,

Quantize the weights of the module.
§

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

§

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

Type to save and load the module.
§

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

Visit each tensor parameter in the module with a visitor.
§

fn map<M>(self, mapper: &mut M) -> Param<Tensor<B, D, Int>>
where M: ModuleMapper<B>,

Map each tensor parameter in the module with a mapper.
§

fn into_record(self) -> <Param<Tensor<B, D, Int>> as Module<B>>::Record

Convert the module into a record containing the state.
§

fn load_record( self, record: <Param<Tensor<B, D, Int>> as Module<B>>::Record, ) -> Param<Tensor<B, D, Int>>

Load the module state from a record.
§

fn to_device(self, device: &<B as Backend>::Device) -> Param<Tensor<B, D, Int>>

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

fn fork(self, device: &<B as Backend>::Device) -> Param<Tensor<B, D, Int>>

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

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) -> Vec<<B as Backend>::Device>

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. Read more
§

fn num_params(&self) -> usize

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

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

Save the module to a file using the provided file recorder. Read more
§

fn load_file<FR, PB>( self, file_path: PB, recorder: &FR, device: &<B as Backend>::Device, ) -> Result<Self, RecorderError>
where FR: FileRecorder<B>, PB: Into<PathBuf>,

Load the module from a file using the provided file recorder. Read more
§

fn quantize_weights<C>(self, quantizer: &mut Quantizer<C>) -> Self
where C: Calibration,

Quantize the weights of the module.
§

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

§

fn format(&self, passed_settings: DisplaySettings) -> String

Formats the module with provided display settings. Read more
§

fn custom_settings(&self) -> Option<DisplaySettings>

Custom display settings for the module. Read more
§

fn custom_content(&self, _content: Content) -> Option<Content>

Custom attributes for the module. Read more
§

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

§

fn format(&self, passed_settings: DisplaySettings) -> String

Formats the module with provided display settings. Read more
§

fn custom_settings(&self) -> Option<DisplaySettings>

Custom display settings for the module. Read more
§

fn custom_content(&self, _content: Content) -> Option<Content>

Custom attributes for the module. Read more
§

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

§

fn format(&self, passed_settings: DisplaySettings) -> String

Formats the module with provided display settings. Read more
§

fn custom_settings(&self) -> Option<DisplaySettings>

Custom display settings for the module. Read more
§

fn custom_content(&self, _content: Content) -> Option<Content>

Custom attributes for the module. Read more
§

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

§

fn content(&self, content: Content) -> Option<Content>

Attributes of the module used for display purposes. Read more
§

fn num_params(&self) -> usize

Gets the number of the parameters of the module.
§

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

§

fn content(&self, content: Content) -> Option<Content>

Attributes of the module used for display purposes. Read more
§

fn num_params(&self) -> usize

Gets the number of the parameters of the module.
§

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

§

fn content(&self, content: Content) -> Option<Content>

Attributes of the module used for display purposes. Read more
§

fn num_params(&self) -> usize

Gets the number of the parameters of the module.
§

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

§

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

Type of the item that can be serialized and deserialized.
§

fn into_item<S>(self) -> <Param<Tensor<B, D>> as Record<B>>::Item<S>
where S: PrecisionSettings,

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

fn from_item<S>( item: <Param<Tensor<B, D>> as Record<B>>::Item<S>, device: &<B as Backend>::Device, ) -> Param<Tensor<B, D>>
where S: PrecisionSettings,

Convert the given item into a record.
§

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

§

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

Type of the item that can be serialized and deserialized.
§

fn into_item<S>(self) -> <Param<Tensor<B, D, Bool>> as Record<B>>::Item<S>
where S: PrecisionSettings,

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

fn from_item<S>( item: <Param<Tensor<B, D, Bool>> as Record<B>>::Item<S>, device: &<B as Backend>::Device, ) -> Param<Tensor<B, D, Bool>>
where S: PrecisionSettings,

Convert the given item into a record.
§

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

§

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

Type of the item that can be serialized and deserialized.
§

fn into_item<S>(self) -> <Param<Tensor<B, D, Int>> as Record<B>>::Item<S>
where S: PrecisionSettings,

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

fn from_item<S>( item: <Param<Tensor<B, D, Int>> as Record<B>>::Item<S>, device: &<B as Backend>::Device, ) -> Param<Tensor<B, D, Int>>
where S: PrecisionSettings,

Convert the given item into a record.

Auto Trait Implementations§

§

impl<T> !Freeze for Param<T>

§

impl<T> !RefUnwindSafe for Param<T>

§

impl<T> Send for Param<T>
where <T as Parameter>::Device: Send,

§

impl<T> !Sync for Param<T>

§

impl<T> Unpin for Param<T>
where T: Unpin, <T as Parameter>::Device: Unpin,

§

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

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

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

§

impl<T> Parsable for T
where T: Deref, <T as Deref>::Target: Parsable,

§

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