Struct CosineEmbeddingLossOptions

Page Contents

Struct Documentation

struct CosineEmbeddingLossOptions

Options for the CosineEmbeddingLoss module.


CosineEmbeddingLoss model(CosineEmbeddingLossOptions().margin(0.5));

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.

Should be a number from -1 to 1, 0 to 0.5 is suggested. Default: 0.0

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


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