.. graphgrove documentation master file, created by
   sphinx-quickstart on Mon Oct  4 14:13:47 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to graphgrove's documentation!
======================================

A framework for building (and incrementally growing) graph-based data structures used in hierarchical or DAG-structured clustering and nearest neighbor search.

Links
=====

`Github Project <https://github.com/nmonath/graphgrove>`_

`Project Home <../index.html>`_

Package Classes
===============

.. autoclass:: graphgrove.covertree.Node
   :members:

.. autoclass:: graphgrove.covertree.NNS_L2
   :members:

.. autoclass:: graphgrove.covertree.MIPS
   :members:

.. autoclass:: graphgrove.covertree.MCSS
   :members:

.. autoclass:: graphgrove.graph_builder.Index
   :members:

.. autoclass:: graphgrove.graph_builder.Cosine_CoverTree
   :members:

.. autoclass:: graphgrove.graph_builder.Cosine_SGTree
   :members:

.. autoclass:: graphgrove.graph_builder.Cosine_SGTreeBeam
   :members:

.. autoclass:: graphgrove.graph_builder.Cosine_FaissFlat
   :members:

.. autoclass:: graphgrove.graph_builder.Cosine_FaissHNSW
   :members:

.. autoclass:: graphgrove.llama.LLAMA
   :members:

.. autoclass:: graphgrove.scc.Node
   :members:

.. autoclass:: graphgrove.scc.Level
   :members:

.. autoclass:: graphgrove.scc.SCC
   :members:

.. autoclass:: graphgrove.sgtree.Node
   :members:

.. autoclass:: graphgrove.sgtree.NNS_L2
   :members:

.. autoclass:: graphgrove.sgtree.MIPS
   :members:

.. autoclass:: graphgrove.sgtree.MCSS
   :members:

.. autoclass:: graphgrove.vec_scc.Cosine_SCC
   :members:


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

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