Skip to main content

CrossEntropyLoss

Struct CrossEntropyLoss 

Source
pub struct CrossEntropyLoss {
    pub output_logits: bool,
    pub target_logits: bool,
}
Expand description

Calculate the cross-entropy loss from the output logits and the targets.

Unlike the full CrossEntropyLoss, this variant accepts floating-point targets (e.g. one-hot, soft label distributions, or un-normalized logits) rather than integer class indices, and omits padding, per-class weights, and label smoothing.

Should be created using CrossEntropyLossConfig.

Fields§

§output_logits: bool

Treat the outputs as logits.

§target_logits: bool

Treat the targets as logits.

Implementations§

Source§

impl CrossEntropyLoss

Source

pub fn forward<B: Backend>( &self, logits: Tensor<B, 2>, targets: Tensor<B, 2>, ) -> Tensor<B, 1>

Compute the criterion on the output tensor.

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

Trait Implementations§

Source§

impl<B: AutodiffBackend> AutodiffModule<B> for CrossEntropyLoss

Source§

type InnerModule = CrossEntropyLoss

Inner module without auto-differentiation.
Source§

fn valid(&self) -> Self::InnerModule

Returns the same module, but on the inner backend without auto-differentiation.
Source§

fn from_inner(module: Self::InnerModule) -> Self

Wraps an inner module back into an auto-diff module.
Source§

impl Clone for CrossEntropyLoss

Source§

fn clone(&self) -> CrossEntropyLoss

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CrossEntropyLoss

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for CrossEntropyLoss

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<B: Backend> Module<B> for CrossEntropyLoss

Source§

type Record = EmptyRecord

Type to save and load the module.
Source§

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

Visit each tensor parameter in the module with a visitor.
Source§

fn map<M: ModuleMapper<B>>(self, _mapper: &mut M) -> Self

Map each tensor parameter in the module with a mapper.
Source§

fn load_record(self, _record: Self::Record) -> Self

Load the module state from a record.
Source§

fn into_record(self) -> Self::Record

Convert the module into a record containing the state.
Source§

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

Move the module and all of its sub-modules to the given device. Read more
Source§

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

Fork the module and all of its sub-modules to the given device. Read more
Source§

fn collect_devices(&self, devices: Devices<B>) -> Devices<B>

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

fn devices(&self) -> Vec<<B as BackendTypes>::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. Read more
§

fn train<AB>(self) -> Self::TrainModule
where AB: AutodiffBackend<InnerBackend = B>, Self: HasAutodiffModule<AB>,

Move the module and all of its sub-modules to the autodiff backend. Read more
§

fn num_params(&self) -> usize

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

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

Quantize the weights of the module.
Source§

impl ModuleDisplay for CrossEntropyLoss

§

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

Formats the module with provided display settings. Read more
§

fn custom_settings(&self) -> Option<DisplaySettings>

Custom display settings for the module. Read more
§

fn custom_content(&self, _content: Content) -> Option<Content>

Custom attributes for the module. Read more
Source§

impl ModuleDisplayDefault for CrossEntropyLoss

Source§

fn content(&self, content: Content) -> Option<Content>

Attributes of the module used for display purposes. Read more
§

fn num_params(&self) -> usize

Gets the number of the parameters of the module.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.