ClikaRT::nn::CosineSimilarity

class

Header: ClikaRT/nn/generated/distance.h
Inherits: ClikaRT::nn::Module

Cosine similarity of x1 and x2 along dim, with broadcasting. The module form of ClikaRT::ops::cosine_similarity, which documents the full contract (shapes, dtypes, errors); construct once, then call it like a function.

Member functions

CosineSimilarity(CosineSimilarityOptions)

explicit CosineSimilarity(CosineSimilarityOptions options = {})

Constructs the module from options (every default when omitted).

Declared in ClikaRT/nn/generated/distance.h, line 64

CosineSimilarity(int64_t, optional<double>)

explicit CosineSimilarity(std::int64_t dim, std::optional<double> eps = std::nullopt)

CosineSimilarity(dim, eps): the positional form of CosineSimilarityOptions(dim, eps).

Declared in ClikaRT/nn/generated/distance.h, line 68

forward()

Tensor forward(Tensor x1, Tensor x2) const

forward_impl, unwrapped: raises ClikaRT::Error on failure.

Declared in ClikaRT/nn/generated/distance.h, line 82

operator()()

Tensor operator()(Tensor x1, Tensor x2) const

Same as forward.

Declared in ClikaRT/nn/generated/distance.h, line 86

options()

const CosineSimilarityOptions& options() const

The settings this module was constructed with.

Declared in ClikaRT/nn/generated/distance.h, line 90