Struct BinaryCrossEntropy

pub struct BinaryCrossEntropy<'a> {
    pub weights: Option<&'a Array>,
    pub inputs_are_logits: bool,
    pub reduction: LossReduction,
}

Binary cross entropy loss.

By default, this function takes the pre-sigmoid logits, which results in a faster and more precise loss. For improved numerical stability when inputs_are_logits is true, the loss calculation clips the input probabilities (in log-space) to a minimum value of -100.

Fields

weights: Option<&'a Array>

Optional weights for each target

inputs_are_logits: bool

Whether the inputs are logits. Default to BinaryCrossEntropy::DEFAULT_INPUTS_ARE_LOGITS

reduction: LossReduction

Reduction type. Default to BinaryCrossEntropy::DEFAULT_REDUCTION

Implementations

impl<'a> BinaryCrossEntropy<'a>

pub fn new() -> Self

Creates a new instance of BinaryCrossEntropy.

impl<'a> BinaryCrossEntropy<'a>

pub const DEFAULT_WEIGHTS: Option<&'a Array> = None

Default value for the weights parameter.

pub const DEFAULT_INPUTS_ARE_LOGITS: bool = true

Default value for the with_logits parameter.

pub const DEFAULT_REDUCTION: LossReduction = LossReduction::None

Default value for the reduction parameter.

pub fn apply( &self, logits: impl AsRef<Array>, targets: impl AsRef<Array>, ) -> Result<Array, Exception>

Apply the binary cross entropy loss function on the given logits and targets.

Params

• logits: unnormalized predicted logits
• targets: binary target values in {0, 1}

Trait Implementations

impl<'a> Buildable for BinaryCrossEntropy<'a>

type Builder = BinaryCrossEntropyBuilder<'a>

The builder type for this buildable type

impl<'a> Builder<BinaryCrossEntropy<'a>> for BinaryCrossEntropyBuilder<'a>

type Error = Infallible

Error with building

fn build(self) -> Result<BinaryCrossEntropy<'a>, Self::Error>

Build the type

impl<'a> Clone for BinaryCrossEntropy<'a>

fn clone(&self) -> BinaryCrossEntropy<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BinaryCrossEntropy<'a>

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

Formats the value using the given formatter.