Struct NLLLossOptions

Page Contents

Struct Documentation

struct torch::nn::NLLLossOptions

Options for the NLLLoss module.


NLLLoss model(NLLLossOptions().ignore_index(-100).reduction(torch::kMean));

Public Types

typedef c10::variant<enumtype::kNone, enumtype::kMean, enumtype::kSum> reduction_t

Public Functions

auto weight(const Tensor &new_weight) -> decltype(*this)

A manual rescaling weight given to each class.

If given, it has to be a Tensor of size C. Otherwise, it is treated as if having all ones.

auto weight(Tensor &&new_weight) -> decltype(*this)
const Tensor &weight() const noexcept
Tensor &weight() noexcept
auto ignore_index(const int64_t &new_ignore_index) -> decltype(*this)

Specifies a target value that is ignored and does not contribute to the input gradient.

auto ignore_index(int64_t &&new_ignore_index) -> decltype(*this)
const int64_t &ignore_index() const noexcept
int64_t &ignore_index() noexcept
auto reduction(const reduction_t &new_reduction) -> decltype(*this)

Specifies the reduction to apply to the output. Default: Mean.

auto reduction(reduction_t &&new_reduction) -> decltype(*this)
const reduction_t &reduction() const noexcept
reduction_t &reduction() noexcept


Access comprehensive developer documentation for PyTorch

View Docs


Get in-depth tutorials for beginners and advanced developers

View Tutorials


Find development resources and get your questions answered

View Resources