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

.. automodule:: nanopq



Product Quantization (PQ)
-------------------------

.. autoclass:: nanopq.PQ
    :members:
    :undoc-members:


Distance Table
-------------------------

.. autoclass:: nanopq.DistanceTable
    :members:
    :undoc-members:


Optimized Product Quantization (OPQ)
------------------------------------

.. autoclass:: nanopq.OPQ
    :members:
    :undoc-members:


Convert Functions to/from Faiss
-------------------------------

.. autofunction:: nanopq.nanopq_to_faiss
.. autofunction:: nanopq.faiss_to_nanopq