Struct HuberLoss 

pub struct HuberLoss {
    pub delta: f32,
    pub lin_bias: f32,
}

Calculate the Huber loss between the inputs and the target.

The loss for each element of the residuals r = targets - predictions is given by

L(r) = 0.5 * r^2                  if |r| <= d
L(r) = 0.5 * d^2 + d * (|r| - d)  if |r| >  d

where d is the configured delta. In particular, this is equal to the L2 Loss for residuals with magnitude smaller than delta, but behaves linearly instead of quadratically for large residuals.

This loss function is less sensitive to outliers than the mean squared error loss.

See also: https://en.wikipedia.org/wiki/Huber_loss

Fields

delta: f32

The bound where the Huber loss function changes from quadratic to linear behaviour.

lin_bias: f32

Precomputed value for the linear bias.

Implementations

impl HuberLoss

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

Compute the loss element-wise for the predictions and targets, then reduce to a single loss value.

Reduction::Auto behaves as Reduction::Mean.

Shapes

• predictions: […dims]
• targets: […dims]
• output: [1]

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

Compute the loss element-wise for the predictions and targets.

Shapes

• predictions: […dims]
• targets: […dims]
• output: […dims]

pub fn forward_residuals<const D: usize>( &self, residuals: Tensor<D>, ) -> Tensor<D>

Compute the loss element-wise for the given residuals.

Shapes

• residuals: […dims]
• output: […dims]

Trait Implementations

impl Clone for HuberLoss

fn clone(&self) -> HuberLoss

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HuberLoss

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

Formats the value using the given formatter.

impl Display for HuberLoss

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

Formats the value using the given formatter.

impl Module for HuberLoss

fn visit<V>(&self, _visitor: &mut V)

where V: ModuleVisitor,

Visit each parameter and module-owned control value with a visitor.

fn map<M>(self, _mapper: &mut M) -> HuberLoss

where M: ModuleMapper,

Map each parameter and module-owned control value with a mapper.

fn to_device(self, _: &Device) -> HuberLoss

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

fn fork(self, _: &Device) -> HuberLoss

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

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

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

fn materialize(self) -> HuberLoss

Fold parameter reparameterizations into their effective values and remove them.

fn valid(&self) -> HuberLoss

Returns a validation snapshot without autodiff or active training flags.

fn train(self) -> HuberLoss

Enables autodiff and restores configured training state throughout the module.

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

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

fn set_require_grad(self, require_grad: bool) -> Self

Set whether every floating-point tensor parameter in the module tree requires gradients.

fn set_require_grad_group(self, group: ParamGroup, require_grad: bool) -> Self

Set whether matched floating-point tensor parameters require gradients.

fn no_grad(self) -> Self

Disable gradients for every floating-point tensor parameter in the module tree.

fn freeze(self) -> Self

Freeze the whole module tree.

fn unfreeze(self) -> Self

Unfreeze the whole module tree.

fn freeze_group(self, group: ParamGroup) -> Self

Freeze every module-owned value in the given group, leaving the rest of the module untouched.

fn unfreeze_group(self, group: ParamGroup) -> Self

Unfreeze every module-owned value in the given group, leaving the rest of the module untouched.

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules, without initializing the ones not initialized yet.

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

Quantize the weights of the module.

fn quantize_weights_group( self, quantizer: &mut Quantizer, group: ParamGroup, ) -> Self

Quantize the weights of the given parameter group.

fn apply_reparameterization<R>(self, reparameterizer: R) -> Self

where Self: Sized, R: Reparameterizer,

Attach reparameterizations using the given Reparameterizer.

fn apply_lora(self, lora: Lora) -> Self

where Self: Sized,

Attach LoRA adapters to the module’s 2-D weights, freezing all base tensor parameters.

fn apply_qlora(self, qlora: QLora) -> Self

where Self: Sized,

Apply QLoRA to the module: quantize the (frozen) base tensor parameters and attach trainable LoRA adapters to 2-D weights.

fn into_record(self) -> ModuleRecord

where Self: Sized,

Collect this module’s tensor parameters into a ModuleRecord.

fn into_record_group(self, group: ParamGroup) -> ModuleRecord

where Self: Sized,

Collect the tensor parameters group names into a ModuleRecord.

fn try_load_record(self, record: ModuleRecord) -> Result<Self, RecordError>

where Self: Sized,

Apply a ModuleRecord to this module, returning the loaded module.

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

where Self: Sized,

Apply a ModuleRecord to this module, consuming and returning it.

fn save_file<P>(self, path: P) -> Result<(), RecordError>

where P: AsRef<Path>, Self: Sized,

Save this module’s parameters to a burnpack file on disk.

fn load_file<P>(self, path: P) -> Self

where P: AsRef<Path>, Self: Sized,

Load this module’s parameters from a burnpack file on disk, returning the loaded module.

fn try_load_file<P>(self, path: P) -> Result<Self, RecordError>

where P: AsRef<Path>, Self: Sized,

Fallible variant of load_file.

impl ModuleDisplay for HuberLoss

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.

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

Formats the module with provided display settings.

impl ModuleDisplayDefault for HuberLoss

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.