Class CosineSimilarityImpl

Inheritance Relationships

Base Type

Class Documentation

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

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

See 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.


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

Public Functions

CosineSimilarityImpl(const CosineSimilarityOptions &options_ = {})
void reset() override

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

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.


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