Skip to content

Regression metrics

CosineSimilarity

Bases: MeanMetricWrapper

Computes the cosine similarity between the labels and predictions.

Formula:

metric = (sum(l2_norm(y_true) * l2_norm(y_pred))+1) / 2

The formula is similar to the classic cosine similarity used in deep learning, but scaled to [0.0, 1.0] and adjusted to have a reward that tend towards 1.0 if the two objects are similar (and 0.0 otherwise).

Parameters:

Name Type Description Default
embedding_model EmbeddingModel

The embedding model to use to compute the cosine similarity.

 None
axis int

(Optional) Defaults to -1. The dimension along which the cosine similarity is computed.

 -1
name str

(Optional) string name of the metric instance.

 'cosine_similarity'
in_mask list

(Optional) list of keys to keep to compute the metric.

 None
out_mask list

(Optional) list of keys to remove to compute the metric.

 None
Source code in synalinks/src/metrics/regression_metrics.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
@synalinks_export("synalinks.metrics.CosineSimilarity")
class CosineSimilarity(MeanMetricWrapper):
    """Computes the cosine similarity between the labels and predictions.

    Formula:

    ```python
    metric = (sum(l2_norm(y_true) * l2_norm(y_pred))+1) / 2
    ```

    The formula is similar to the classic cosine similarity used in deep learning,
    but scaled to [0.0, 1.0] and adjusted to have a reward that tend
    towards 1.0 if the two objects are similar (and 0.0 otherwise).

    Args:
        embedding_model (EmbeddingModel): The embedding model to use to compute the
            cosine similarity.
        axis (int): (Optional) Defaults to `-1`. The dimension along which the cosine
            similarity is computed.
        name (str): (Optional) string name of the metric instance.
        in_mask (list): (Optional) list of keys to keep to compute the metric.
        out_mask (list): (Optional) list of keys to remove to compute the metric.
    """

    def __init__(
        self,
        name="cosine_similarity",
        axis=-1,
        embedding_model=None,
        in_mask=None,
        out_mask=None,
    ):
        super().__init__(
            fn=cosine_similarity,
            name=name,
            in_mask=in_mask,
            out_mask=out_mask,
        )
        self.axis = axis
        self.embedding_model = embedding_model
        self._fn_kwargs = {"axis": axis, "embedding_model": embedding_model}

    def get_config(self):
        config = {
            "axis": self.axis,
            "name": self.name,
            "in_mask": self.in_mask,
            "out_mask": self.out_mask,
        }
        embedding_model_config = {
            "embedding_model": serialization_lib.serialize_synalinks_object(
                self.embedding_model
            )
        }
        return {**embedding_model_config, **config}

    @classmethod
    def from_config(cls, config):
        embedding_model = serialization_lib.deserialize_synalinks_object(
            config.pop("embedding_model")
        )
        return cls(embedding_model=embedding_model, **config)