o
    sÒh§  ã                   @   st   d dl mZ d dlmZmZmZ d dlmZ d dlm	Z	 ddl
mZmZmZmZmZmZmZmZ G dd„ deƒZd	S )
é    )ÚEnum)ÚCallableÚListÚUnion)Úndarray)ÚTensoré   )Úcos_simÚ	dot_scoreÚeuclidean_simÚmanhattan_simÚpairwise_cos_simÚpairwise_dot_scoreÚpairwise_euclidean_simÚpairwise_manhattan_simc                	   @   s®   e Zd ZdZdZdZdZdZdZe	de
ed f dee
eef e
eef gef fdd	„ƒZe	de
ed f dee
eef e
eef gef fd
d„ƒZe	dee fdd„ƒZd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
    ÚcosineÚdotÚ	euclideanÚ	manhattanÚsimilarity_functionÚreturnc                 C   óT   t | ƒ} | t jkrtS | t jkrtS | t jkrtS | t jkr tS t	d 
| 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: {}.)r   ÚCOSINEr	   ÚDOT_PRODUCTr
   Ú	MANHATTANr   Ú	EUCLIDEANr   Ú
ValueErrorÚformatÚpossible_values©r   © r"   úh/var/www/html/alpaca_bot/venv/lib/python3.10/site-packages/sentence_transformers/similarity_functions.pyÚto_similarity_fn#   s   



ÿÿz#SimilarityFunction.to_similarity_fnc                 C   r   )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   )r   r   r   r   r   r   r   r   r   r   r   r    r!   r"   r"   r#   Úto_similarity_pairwise_fnK   s   



ÿÿz,SimilarityFunction.to_similarity_pairwise_fnc                   C   s   dd„ t D ƒS )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']
        c                 S   s   g | ]}|j ‘qS r"   )Úvalue)Ú.0Úmr"   r"   r#   Ú
<listcomp>ƒ   s    z6SimilarityFunction.possible_values.<locals>.<listcomp>)r   r"   r"   r"   r#   r    v   s   z"SimilarityFunction.possible_valuesN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   r   ÚDOTr   r   Ústaticmethodr   Ústrr   r   r   r$   r%   r   r    r"   r"   r"   r#   r      s*    	
ÿþ'
ÿþ*r   N)Úenumr   Útypingr   r   r   Únumpyr   Útorchr   Úutilr	   r
   r   r   r   r   r   r   r   r"   r"   r"   r#   Ú<module>   s    (