Struct SmoothL1LossConfig 

pub struct SmoothL1LossConfig {
    pub beta: f32,
}

Configuration for the SmoothL1Loss module.

Smooth L1 loss combines L1 and L2 loss, using L2 loss for small errors (below beta) and L1 loss for large errors (above beta). This makes it less sensitive to outliers than MSE while maintaining smooth gradients near zero.

Example

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

// Create Smooth L1 loss with default beta=1.0
let smooth_l1 = SmoothL1LossConfig::new().init();

// Create with custom beta
let smooth_l1_custom = SmoothL1LossConfig::new().with_beta(0.5).init();

Fields

beta: f32

Specifies the threshold at which to change between L1 and L2 loss. The value must be positive. Default: 1.0

Implementations

impl SmoothL1LossConfig

pub fn new() -> SmoothL1LossConfig

Create a new instance of the config.

Arguments

Default Arguments

beta

Specifies the threshold at which to change between L1 and L2 loss. The value must be positive. Default: 1.0

• Defaults to 1.0

impl SmoothL1LossConfig

pub fn with_beta(self, beta: f32) -> SmoothL1LossConfig

Sets the value for the field beta.

Specifies the threshold at which to change between L1 and L2 loss. The value must be positive. Default: 1.0

• Defaults to 1.0

impl SmoothL1LossConfig

pub fn init(&self) -> SmoothL1Loss

Initializes a Smooth L1 Loss module.

Panics

Panics if beta <= 0.

Trait Implementations

impl Clone for SmoothL1LossConfig

fn clone(&self) -> SmoothL1LossConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for SmoothL1LossConfig

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 SmoothL1LossConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SmoothL1LossConfig

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SmoothL1LossConfig

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

Formats the value using the given formatter.

impl Serialize for SmoothL1LossConfig

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.