Struct burn::nn::loss::MseLoss

pub struct MseLoss;

Calculate the mean squared error loss from the input logits and the targets.

Implementations

impl MseLoss

pub fn new() -> MseLoss

Create the criterion.

pub fn forward<const D: usize, B>( &self, logits: Tensor<B, D>, targets: Tensor<B, D>, reduction: Reduction, ) -> Tensor<B, 1>

where B: Backend,

Compute the criterion on the input tensor.

Shapes

• logits: [batch_size, num_targets]
• targets: [batch_size, num_targets]

pub fn forward_no_reduction<const D: usize, B>( &self, logits: Tensor<B, D>, targets: Tensor<B, D>, ) -> Tensor<B, D>

where B: Backend,

Compute the criterion on the input tensor without reducing.

Trait Implementations

impl<B> AutodiffModule<B> for MseLoss

where B: AutodiffBackend,

type InnerModule = MseLoss

Inner module without auto-differentiation.

fn valid(&self) -> <MseLoss as AutodiffModule<B>>::InnerModule

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

impl Clone for MseLoss

fn clone(&self) -> MseLoss

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MseLoss

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

Formats the value using the given formatter.

impl Default for MseLoss

fn default() -> MseLoss

Returns the “default value” for a type.

impl Display for MseLoss

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

Formats the value using the given formatter.

impl<B> Module<B> for MseLoss

where B: Backend,

type Record = ConstantRecord

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) -> MseLoss

where M: ModuleMapper<B>,

Map each tensor parameter in the module with a mapper.

fn load_record(self, _record: <MseLoss as Module<B>>::Record) -> MseLoss

Load the module state from a record.

fn into_record(self) -> <MseLoss as Module<B>>::Record

Convert the module into a record containing the state.

fn to_device(self, _: &<B as Backend>::Device) -> MseLoss

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

fn fork(self, _: &<B as Backend>::Device) -> MseLoss

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) -> 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.

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.

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.

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

where C: Calibration,

Quantize the weights of the module.

impl ModuleDisplay for MseLoss

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

Formats the module with provided display settings.

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

Custom display settings for the module.

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

Custom attributes for the module.

impl ModuleDisplayDefault for MseLoss

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

Attributes of the module used for display purposes.

fn num_params(&self) -> usize

Gets the number of the parameters of the module.