Struct BinaryCrossEntropyLoss 

pub struct BinaryCrossEntropyLoss<B>
where
    B: Backend,
{
    pub weights: Option<Tensor<B, 1>>,
    pub smoothing: Option<f32>,
    pub logits: bool,
}

Calculate the binary cross entropy loss from the input logits and the targets.

Should be created using BinaryCrossEntropyLossConfig

Fields

weights: Option<Tensor<B, 1>>

Weights for cross-entropy.

smoothing: Option<f32>

Label smoothing alpha.

logits: bool

Treat the inputs as logits

Implementations

impl<B> BinaryCrossEntropyLoss<B>

where B: Backend,

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

Compute the criterion on the input tensor.

Shapes

Binary:

• logits: [batch_size]
• targets: [batch_size]

Multi-label:

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

Trait Implementations

impl<B> AutodiffModule<B> for BinaryCrossEntropyLoss<B>

where B: Backend + AutodiffBackend, <B as AutodiffBackend>::InnerBackend: Backend,

type InnerModule = BinaryCrossEntropyLoss<<B as AutodiffBackend>::InnerBackend>

Inner module without auto-differentiation.

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

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

impl<B> Clone for BinaryCrossEntropyLoss<B>

where B: Backend,

fn clone(&self) -> BinaryCrossEntropyLoss<B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B> Debug for BinaryCrossEntropyLoss<B>

where B: Debug + Backend,

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

Formats the value using the given formatter.

impl<B> Display for BinaryCrossEntropyLoss<B>

where B: Backend,

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

Formats the value using the given formatter.

impl<B> Module<B> for BinaryCrossEntropyLoss<B>

where B: Backend,

type Record = BinaryCrossEntropyLossRecord<B>

Type to save and load the module.

fn load_record( self, record: <BinaryCrossEntropyLoss<B> as Module<B>>::Record, ) -> BinaryCrossEntropyLoss<B>

Load the module state from a record.

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

Convert the module into a record containing the state.

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules.

fn visit<Visitor>(&self, visitor: &mut Visitor)

where Visitor: ModuleVisitor<B>,

Visit each tensor parameter in the module with a visitor.

fn map<Mapper>(self, mapper: &mut Mapper) -> BinaryCrossEntropyLoss<B>

where Mapper: ModuleMapper<B>,

Map each tensor parameter in the module with a mapper.

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 to_device(self, device: &<B as Backend>::Device) -> BinaryCrossEntropyLoss<B>

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

fn fork(self, device: &<B as Backend>::Device) -> BinaryCrossEntropyLoss<B>

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

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 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(self, quantizer: &mut Quantizer) -> Self

Quantize the weights of the module.

impl<B> ModuleDisplay for BinaryCrossEntropyLoss<B>

where B: Backend,

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<B> ModuleDisplayDefault for BinaryCrossEntropyLoss<B>

where B: Backend,

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.