+sgD~ddlmZddlmZddlmZddlmZddlm Z ddl m Z m Z m Z mZmZmZmZmZGdd eZy ) ) annotations)Enum)Callable)ndarray)Tensor)cos_sim dot_score euclidean_sim manhattan_simpairwise_cos_simpairwise_dot_scorepairwise_euclidean_simpairwise_manhattan_simcjeZdZdZdZdZdZdZdZe d dZ e d dZ e d dZ y ) SimilarityFunctiona Enum class for supported similarity functions. The following functions are supported: - ``SimilarityFunction.COSINE`` (``"cosine"``): Cosine similarity - ``SimilarityFunction.DOT_PRODUCT`` (``"dot"``, ``dot_product``): Dot product similarity - ``SimilarityFunction.EUCLIDEAN`` (``"euclidean"``): Euclidean distance - ``SimilarityFunction.MANHATTAN`` (``"manhattan"``): Manhattan distance cosinedot euclidean manhattanc(t|}|tjk(rtS|tjk(rtS|tj k(rt S|tjk(rtStd|dtjd)a Converts a similarity function name or enum value to the corresponding similarity function. Args: similarity_function (Union[str, SimilarityFunction]): The name or enum value of the similarity function. Returns: Callable[[Union[Tensor, ndarray], Union[Tensor, ndarray]], Tensor]: The corresponding similarity function. Raises: ValueError: If the provided function is not supported. Example: >>> similarity_fn = SimilarityFunction.to_similarity_fn("cosine") >>> similarity_scores = similarity_fn(embeddings1, embeddings2) >>> similarity_scores tensor([[0.3952, 0.0554], [0.0992, 0.1570]]) The provided function 4 is not supported. Use one of the supported values: .) rCOSINEr DOT_PRODUCTr MANHATTANr EUCLIDEANr ValueErrorpossible_valuessimilarity_functions ]/var/www/html/venv/lib/python3.12/site-packages/sentence_transformers/similarity_functions.pyto_similarity_fnz#SimilarityFunction.to_similarity_fn%s.11DE "4";"; ;N "4"@"@ @  "4">"> > "4">"> > $%8$99moAoQoQoSnTTU V  c(t|}|tjk(rtS|tjk(rtS|tj k(rt S|tjk(rtStd|dtjd)a Converts a similarity function into a pairwise similarity function. The pairwise similarity function returns the diagonal vector from the similarity matrix, i.e. it only computes the similarity(a[i], b[i]) for each i in the range of the input tensors, rather than computing the similarity between all pairs of a and b. Args: similarity_function (Union[str, SimilarityFunction]): The name or enum value of the similarity function. Returns: Callable[[Union[Tensor, ndarray], Union[Tensor, ndarray]], Tensor]: The pairwise similarity function. Raises: ValueError: If the provided similarity function is not supported. Example: >>> pairwise_fn = SimilarityFunction.to_similarity_pairwise_fn("cosine") >>> similarity_scores = pairwise_fn(embeddings1, embeddings2) >>> similarity_scores tensor([0.3952, 0.1570]) rrr) rrr rrrrrrrr r!s r#to_similarity_pairwise_fnz,SimilarityFunction.to_similarity_pairwise_fnKs411DE "4";"; ;# # "4"@"@ @% % "4">"> >) ) "4">"> >) )$%8$99moAoQoQoSnTTU V  r%cHtDcgc]}|jc}Scc}w)ad Returns a list of possible values for the SimilarityFunction enum. Returns: list: A list of possible values for the SimilarityFunction enum. Example: >>> possible_values = SimilarityFunction.possible_values() >>> possible_values ['cosine', 'dot', 'euclidean', 'manhattan'] )rvalue)ms r#r z"SimilarityFunction.possible_valuests"44A444sN)r"zstr | SimilarityFunctionreturnz6Callable[[Tensor | ndarray, Tensor | ndarray], Tensor])r+z list[str]) __name__ __module__ __qualname____doc__rrDOTrr staticmethodr$r'r r%r#rrs~FK CII# 5# ?# # J& 5& ?& & P 5 5r%rN) __future__renumrtypingrnumpyrtorchrutilr r r r r rrrrr2r%r#r9s1"   l5l5r%