angle_emb.evaluation
====================

.. py:module:: angle_emb.evaluation


Classes
-------

.. autoapisummary::

   angle_emb.evaluation.CorrelationEvaluator


Module Contents
---------------

.. py:class:: CorrelationEvaluator(text1: List[str], text2: List[str], labels: List[float], batch_size: int = 32)

   Bases: :py:obj:`object`


   .. py:attribute:: text1


   .. py:attribute:: text2


   .. py:attribute:: labels


   .. py:attribute:: batch_size
      :value: 32



   .. py:method:: __call__(model: angle_emb.base.AngleBase, show_progress: bool = True, **kwargs) -> dict

      Evaluate the model on the given dataset.

      :param model: AnglE, the model to evaluate.
      :param show_progress: bool, whether to show a progress bar during evaluation.
      :param kwargs: Additional keyword arguments to pass to the `encode` method of the model.

      :return: dict, The evaluation results.



   .. py:method:: list_all_metrics() -> List[str]

      Get a list of all the metrics that can be computed by this evaluator.

      :return: List[str], A list of all the metrics that can be computed by this evaluator.