.. bartocsuggest documentation master file, created by
   sphinx-quickstart on Tue Apr 28 13:26:35 2020.

bartocsuggest documentation
=========================================

.. automodule:: bartocsuggest

.. toctree::
   :maxdepth: 2
   :caption: Contents:

Core functionality
------------------

.. autoclass:: bartocsuggest.Session
   :members:

.. autoclass:: bartocsuggest.Suggestion
   :members:

.. autoclass:: bartocsuggest.ScoreType
   :members:

.. autoclass:: bartocsuggest.Recall
   :members:

.. autoclass:: bartocsuggest.Average
   :members:

.. autoclass:: bartocsuggest.Coverage
   :members:

.. autoclass:: bartocsuggest.Sum
   :members:

Wrappers
--------

.. autoclass:: bartocsuggest.AnnifSession
   :members:

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`