API Reference
=============

Pipeline orchestration
----------------------

.. automodule:: lit2vec.pipeline
   :members:
   :undoc-members:
   :show-inheritance:

Corpus preparation
------------------

.. automodule:: lit2vec.prepare.litsync
   :members:
   :undoc-members:
   :show-inheritance:

Embeddings
----------

.. automodule:: lit2vec.vectordb.create_embeddings
   :members:
   :undoc-members:
   :show-inheritance:

FAISS index
-----------

.. automodule:: lit2vec.vectordb.create_faiss_index
   :members:
   :undoc-members:
   :show-inheritance:

Annoy index
-----------

.. automodule:: lit2vec.vectordb.create_annoy_index
   :members:
   :undoc-members:
   :show-inheritance:

BM25 index
----------

.. automodule:: lit2vec.bm25_index.create_index
   :members:
   :undoc-members:
   :show-inheritance:

Metadata databases
------------------

.. automodule:: lit2vec.metadatadb.create_metadata_sqllite
   :members:
   :undoc-members:
   :show-inheritance:

Verification (proctor)
----------------------

.. automodule:: lit2vec.proctor
   :members:
   :undoc-members:
   :show-inheritance:

Utilities
---------

.. automodule:: lit2vec.utils
   :members:
   :undoc-members:
   :show-inheritance:

.. toctree::
   :maxdepth: 1
   :hidden: