Python API
=================

Quake Index and Configuration
--------------------------
.. autoclass:: quake.QuakeIndex
   :members:
   :undoc-members:

.. autoclass:: quake.SearchParams
    :members:
    :undoc-members:

.. autoclass:: quake.IndexBuildParams
    :members:
    :undoc-members:

.. autoclass:: quake.MaintenancePolicyParams
    :members:
    :undoc-members:

.. autoclass:: quake.SearchResult
    :members:
    :undoc-members:

.. autoclass:: quake.MaintenanceTimingInfo
    :members:
    :undoc-members:

.. autoclass:: quake.SearchTimingInfo
    :members:
    :undoc-members:

.. autoclass:: quake.BuildTimingInfo
    :members:
    :undoc-members:

.. autoclass:: quake.ModifyTimingInfo
    :members:
    :undoc-members:

Workload Generation and Evaluation
----------------------------------
.. automodule:: quake.workload_generator
   :members:
   :undoc-members:
   :show-inheritance:

Built-in Datasets
--------
.. automodule:: quake.datasets.ann_datasets
   :members:
   :undoc-members:
   :show-inheritance:

Index Wrappers
--------------
.. automodule:: quake.index_wrappers.quake
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: quake.index_wrappers.faiss_ivf
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: quake.index_wrappers.faiss_hnsw
   :members:
   :undoc-members:
   :show-inheritance: