a hD@sxddlmZddlmZddlmZddlmZddlm Z ddl m Z m Z m Z mZmZmZmZmZGdd d eZd S) ) annotations)Enum)Callable)ndarray)Tensor)cos_sim dot_score euclidean_sim manhattan_simpairwise_cos_simpairwise_dot_scorepairwise_euclidean_simpairwise_manhattan_simc@s^eZdZdZdZdZdZdZdZe dddd d Z e dddd d Z e d dddZ 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 ZcosinedotZ euclideanZ manhattanzstr | SimilarityFunctionz6Callable[[Tensor | ndarray, Tensor | ndarray], Tensor])similarity_functionreturncCs^t|}|tjkrtS|tjkr$tS|tjkr2tS|tjkr@tSt d|dt ddS)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: .N) rCOSINEr DOT_PRODUCTr MANHATTANr EUCLIDEANr ValueErrorpossible_valuesrrf/var/www/html/assistant/venv/lib/python3.9/site-packages/sentence_transformers/similarity_functions.pyto_similarity_fn%s    z#SimilarityFunction.to_similarity_fncCs^t|}|tjkrtS|tjkr$tS|tjkr2tS|tjkr@tSt d|dt ddS)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]) rrrN) rrr rr rrrrrrrrrrto_similarity_pairwise_fnKs    z,SimilarityFunction.to_similarity_pairwise_fnz list[str])rcCsddtDS)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'] cSsg|] }|jqSr)value).0mrrr z6SimilarityFunction.possible_values..)rrrrrrts z"SimilarityFunction.possible_valuesN) __name__ __module__ __qualname____doc__rrDOTrr staticmethodr r!rrrrrrs %(rN) __future__renumrtypingrnumpyrZtorchrutilrr r r r r rrrrrrrs     (