Struct LpLossConfig 

pub struct LpLossConfig {
    pub p: f64,
}

Configuration for the Lp Loss module.

Example

use burn_nn::loss::{LpLossConfig, Reduction};

// Create L1 loss (MAE when using mean reduction)
let l1_loss = LpLossConfig::l1();

// Create L2 loss (MSE when using mean reduction)
let l2_loss = LpLossConfig::l2();

// Create custom Lp loss with p=3
let l3_loss = LpLossConfig::new(3.0).init();

Fields

p: f64

The exponent p determining the type of error measurement.

Common values:

• p = 1.0: L1 loss (MAE with mean reduction) - robust to outliers
• p = 2.0: L2 loss (MSE with mean reduction) - standard choice, differentiable everywhere
• p > 2.0: Increasingly sensitive to large errors (outliers)
• 0 < p < 1: More robust to outliers than L1 (quasi-norm)

Implementations

impl LpLossConfig

pub fn new(p: f64) -> LpLossConfig

Create a new instance of the config.

Arguments

Required Arguments

p

The exponent p determining the type of error measurement.

Common values:

• p = 1.0: L1 loss (MAE with mean reduction) - robust to outliers
• p = 2.0: L2 loss (MSE with mean reduction) - standard choice, differentiable everywhere
• p > 2.0: Increasingly sensitive to large errors (outliers)
• 0 < p < 1: More robust to outliers than L1 (quasi-norm)

impl LpLossConfig

pub fn init(&self) -> LpLoss

Initializes a Lp Loss module.

Panics

Panics if p <= 0.

pub fn l1() -> LpLoss

Creates L1 loss (p=1).

When used with Reduction::Mean, this computes Mean Absolute Error (MAE). When used with Reduction::Sum, this computes Sum of Absolute Errors (SAE).

pub fn l2() -> LpLoss

Creates L2 loss (p=2).

When used with Reduction::Mean, this computes Mean Squared Error (MSE). When used with Reduction::Sum, this computes Sum of Squared Errors (SSE).

Trait Implementations

impl Clone for LpLossConfig

fn clone(&self) -> LpLossConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for LpLossConfig

fn save<P>(&self, file: P) -> Result<(), Error>

where P: AsRef<Path>,

Saves the configuration to a file.

fn load<P>(file: P) -> Result<Self, ConfigError>

where P: AsRef<Path>,

Loads the configuration from a file.

fn load_binary(data: &[u8]) -> Result<Self, ConfigError>

Loads the configuration from a binary buffer.

impl Debug for LpLossConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LpLossConfig

fn deserialize<D>( deserializer: D, ) -> Result<LpLossConfig, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LpLossConfig

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

Formats the value using the given formatter.

impl Serialize for LpLossConfig

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.