Class CosineSimilarityImpl

• Defined in File distance.h

Inheritance Relationships

Base Type

• public torch::nn::Cloneable< CosineSimilarityImpl > (Template Class Cloneable)

Class Documentation

class CosineSimilarityImpl : public torch::nn::Cloneable<CosineSimilarityImpl>

Returns the cosine similarity between :math:x_1 and :math:x_2, computed along dim.

See https://pytorch.org/docs/main/nn.html#torch.nn.CosineSimilarity to learn about the exact behavior of this module.

See the documentation for torch::nn::CosineSimilarityOptions class to learn what constructor arguments are supported for this module.

Example:

CosineSimilarity model(CosineSimilarityOptions().dim(0).eps(0.5));

Public Functions

explicit CosineSimilarityImpl(const CosineSimilarityOptions &options_ = {})

virtual void reset() override

reset() must perform initialization of all members with reference semantics, most importantly parameters, buffers and submodules.

virtual void pretty_print(std::ostream &stream) const override

Pretty prints the CosineSimilarity module into the given stream.

Tensor forward(const Tensor &input1, const Tensor &input2)

Public Members

CosineSimilarityOptions options

The options with which this Module was constructed.