Struct HingeEmbeddingLossOptions

• Defined in File loss.h

Struct Documentation

struct HingeEmbeddingLossOptions

Options for the HingeEmbeddingLoss module.

Example:

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

Public Types

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

Public Functions

inline 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

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

inline const double &margin() const noexcept

inline double &margin() noexcept

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

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

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

inline const reduction_t &reduction() const noexcept

inline reduction_t &reduction() noexcept