Struct HingeEmbeddingLossOptions

Page Contents

Struct Documentation

struct torch::nn::HingeEmbeddingLossOptions

Options for the HingeEmbeddingLoss module.


HingeEmbeddingLoss model(HingeEmbeddingLossOptions().margin(4).reduction(torch::kNone));

Public Types

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

Public Functions

auto margin(const double &new_margin) -> decltype(*this)

Specifies the threshold for which the distance of a negative sample must reach in order to incur zero loss.

Default: 1

auto margin(double &&new_margin) -> decltype(*this)
const double &margin() const noexcept
double &margin() 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