NgDddlmZddlmZddlmZddlmZddlm Z ddl m Z m Z m Z mZmZmZmZmZGdd eZd S) ) annotations)Enum)Callable)ndarray)Tensor)cos_sim dot_score euclidean_sim manhattan_simpairwise_cos_simpairwise_dot_scorepairwise_euclidean_simpairwise_manhattan_simcneZdZdZdZdZdZdZdZe dd Z e dd Z e dd Z dS)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 manhattansimilarity_functionstr | SimilarityFunctionreturn6Callable[[Tensor | ndarray, Tensor | ndarray], Tensor]c2t|}|tjkrtS|tjkrtS|tjkrt S|tjkrtStd|dt d)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_valuesrs f/var/www/html/ai-engine/env/lib/python3.11/site-packages/sentence_transformers/similarity_functions.pyto_similarity_fnz#SimilarityFunction.to_similarity_fn%s.11DEE "4"; ; ;N "4"@ @ @  "4"> > > "4"> > >  V%8 V VoAoQoQoSoS V V V   c2t|}|tjkrtS|tjkrtS|tjkrt S|tjkrtStd|dt d)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 r rr!rr"rr#r$r%s r&to_similarity_pairwise_fnz,SimilarityFunction.to_similarity_pairwise_fnKs411DEE "4"; ; ;# # "4"@ @ @% % "4"> > >) ) "4"> > >) ) V%8 V VoAoQoQoSoS V V V   r( list[str]c$dtDS)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'] cg|] }|j S)value).0ms r& z6SimilarityFunction.possible_values..s444A444r()rr.r(r&r$z"SimilarityFunction.possible_valuests54!34444r(N)rrrr)rr+) __name__ __module__ __qualname____doc__rr DOTr"r! staticmethodr'r*r$r.r(r&rrsFK CII# # # \# J& & & \& P 5 5 5\ 5 5 5r(rN) __future__renumrtypingrnumpyrtorchrutilr r r r r rrrrr.r(r&r?s""""""                    l5l5l5l5l5l5l5l5l5l5r(