
    ChD                    ~    S SK Jr  S SKJr  S SKJr  S SKJr  S SKJ	r	  SSK
JrJrJrJrJrJrJrJr   " S S	\5      rg
)    )annotations)Enum)Callable)ndarray)Tensor   )cos_sim	dot_scoreeuclidean_simmanhattan_simpairwise_cos_simpairwise_dot_scorepairwise_euclidean_simpairwise_manhattan_simc                  x    \ rS rSrSrSrSrSrSrSr	\
    SS j5       r\
    SS j5       r\
SS	 j5       rS
rg)SimilarityFunction   a  
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
cosinedot	euclidean	manhattanc                0   [        U 5      n U [         R                  :X  a  [        $ U [         R                  :X  a  [        $ U [         R
                  :X  a  [        $ U [         R                  :X  a  [        $ [        SU  S[         R                  5        S35      e)ay  
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: .)r   COSINEr	   DOT_PRODUCTr
   	MANHATTANr   	EUCLIDEANr   
ValueErrorpossible_valuessimilarity_functions    b/var/www/html/shao/venv/lib/python3.13/site-packages/sentence_transformers/similarity_functions.pyto_similarity_fn#SimilarityFunction.to_similarity_fn%   s    . 11DE"4";";;N"4"@"@@"4">">>  "4">">>  $%8$99m  oA  oQ  oQ  oS  nT  TU  V
 	
    c                0   [        U 5      n U [         R                  :X  a  [        $ U [         R                  :X  a  [        $ U [         R
                  :X  a  [        $ U [         R                  :X  a  [        $ [        SU  S[         R                  5        S35      e)aH  
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   r   r   )r   r   r   r   r   r   r   r   r   r    r!   r"   s    r$   to_similarity_pairwise_fn,SimilarityFunction.to_similarity_pairwise_fnK   s    4 11DE"4";";;##"4"@"@@%%"4">">>))"4">">>))$%8$99m  oA  oQ  oQ  oS  nT  TU  V
 	
r'   c                 J    [          V s/ sH  o R                  PM     sn $ s  sn f )a$  
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']
)r   value)ms    r$   r!   "SimilarityFunction.possible_valuest   s      "44!3A!3444s     N)r#   zstr | SimilarityFunctionreturnz6Callable[[Tensor | ndarray, Tensor | ndarray], Tensor])r0   z	list[str])__name__
__module____qualname____firstlineno____doc__r   r   DOTr   r   staticmethodr%   r)   r!   __static_attributes__r/   r'   r$   r   r      s~     FK
CII#
5#
	?#
 #
J &
5&
	?&
 &
P 5 5r'   r   N)
__future__r   enumr   typingr   numpyr   torchr   utilr	   r
   r   r   r   r   r   r   r   r/   r'   r$   <module>r?      s1    "    	 	 	l5 l5r'   