.. _api.benchmark:

=========
Benchmark
=========

.. currentmodule:: ferret

Constructor
-----------

.. autosummary::
   :toctree: api/

   Benchmark

Explaining
----------

.. autosummary::
   :toctree: api/

   Benchmark.explain


Benchmarking Explanations
-------------------------

.. autosummary::
   :toctree: api/

   Benchmark.evaluate_explanation
   Benchmark.evaluate_explanations


Visualization
-------------

.. autosummary::
   :toctree: api/

   Benchmark.show_table
   Benchmark.show_evaluation_table
   Benchmark.get_dataframe
   Benchmark.show_samples_evaluation_table


Datasets Interface
------------------

.. autosummary::
   :toctree: api/

   Benchmark.load_dataset
   Benchmark.evaluate_samples


Inference
---------

.. autosummary::
   :toctree: api/

   Benchmark.score