siddlmZddlmZmZmZddlmZddlm Z ddl m Z m Z m Z mZmZmZmZmZGddeZd S) )Enum)CallableListUnion)ndarray)Tensor)cos_sim dot_score euclidean_sim manhattan_simpairwise_cos_simpairwise_dot_scorepairwise_euclidean_simpairwise_manhattan_simc eZdZdZdZdZdZdZdZe de e dfde e e efe e efge ffdZe de e dfde e e efe e efge ffd Ze dee fd Zd S) 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_functionreturncLt|}|tjkrtS|tjkrtS|tjkrt S|tjkrtStd |t )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]]) OThe provided function {} is not supported. Use one of the supported values: {}.) rCOSINEr DOT_PRODUCTr MANHATTANr EUCLIDEANr ValueErrorformatpossible_valuesrs ]/var/www/icac/venv/lib/python3.11/site-packages/sentence_transformers/similarity_functions.pyto_similarity_fnz#SimilarityFunction.to_similarity_fn#s.11DEE "4"; ; ;N "4"@ @ @  "4"> > > "4"> > >  ] d d#%7%G%G%I%I     cLt|}|tjkrtS|tjkrtS|tjkrt S|tjkrtStd |t )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]) r) rrrrrrrrrr r!r"r#s r$to_similarity_pairwise_fnz,SimilarityFunction.to_similarity_pairwise_fnKs411DEE "4"; ; ;# # "4"@ @ @% % "4"> > >) ) "4"> > >) ) ] d d#%7%G%G%I%I     r&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_valuesvs54!34444r&N)__name__ __module__ __qualname____doc__rrDOTrr staticmethodrstrrrrr%r(rr"r+r&r$rrsFK CII% "3(<#<=% 5)5+ABFJ K% % % \% N( "3(<#<=( 5)5+ABFJ K( ( ( \( T 5T#Y 5 5 5\ 5 5 5r&rN)enumrtypingrrrnumpyrtorchrutilr r r r rrrrrr+r&r$r<s((((((((((                    p5p5p5p5p5p5p5p5p5p5r&