flambe.nn.distance.cosine

Module Contents

class flambe.nn.distance.cosine.CosineDistance(eps: float = 1e-08)[source]

Bases: flambe.nn.distance.DistanceModule

Implement a CosineDistance object.

forward(self, mat_1: Tensor, mat_2: Tensor)[source]

Returns the cosine distance between each element in mat_1 and each element in mat_2.

Parameters:
  • mat_1 (torch.Tensor) – matrix of shape (n_1, n_features)
  • mat_2 (torch.Tensor) – matrix of shape (n_2, n_features)
Returns:

dist – distance matrix of shape (n_1, n_2)

Return type:

torch.Tensor

class flambe.nn.distance.cosine.CosineMean[source]

Bases: flambe.nn.distance.MeanModule

Implement a CosineMean object.

forward(self, data: Tensor)[source]

Performs a forward pass through the network.

Parameters:data (torch.Tensor) – The input data, as a float tensor
Returns:The encoded output, as a float tensor
Return type:torch.Tensor