Metrics
=======
A collection of metrics that aim to help discern model performance in Targeted Syntactic Evaluation.
Many of these are available through the GrewTSEvaluator and will automatically be calculated when called after providing a Minimal-Pair Dataset.
Alternatively, you may use them freely through this module.

.. autofunction:: grewtse.evaluators.compute_surprisal
   :noindex:

.. autofunction:: grewtse.evaluators.compute_average_surprisal
   :noindex:

.. autofunction:: grewtse.evaluators.compute_average_surprisal_difference
   :noindex:

.. autofunction:: grewtse.evaluators.compute_normalised_surprisal_difference
   :noindex:

.. autofunction:: grewtse.evaluators.compute_accuracy
   :noindex:

.. autofunction:: grewtse.evaluators.compute_entropy
   :noindex:

.. autofunction:: grewtse.evaluators.compute_entropy_based_certainty
   :noindex: