API reference
=============

.. currentmodule:: themisim

Everything below is importable directly from the top-level ``themisim`` package.

Querying
--------

.. autosummary::
   :toctree: generated
   :nosignatures:

   query
   resolve_global_id
   SearchEngine
   Hit

Exporting results
-----------------

.. autosummary::
   :toctree: generated
   :nosignatures:

   hits_to_dataframe
   results_csv_filename

Building an index
-----------------

.. autosummary::
   :toctree: generated
   :nosignatures:

   download_archive
   build_index
   fetch_weights

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

.. autosummary::
   :toctree: generated
   :nosignatures:

   visualize_results