:mod:`capreolus.index`
======================

.. py:module:: capreolus.index


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   capreolus.index.Index
   capreolus.index.AnseriniIndex



.. data:: logger
   

   

.. data:: MAX_THREADS
   

   

.. py:class:: Index

   Bases: :class:`profane.ModuleBase`

   .. attribute:: module_type
      :annotation: = index

      

   .. attribute:: dependencies
      

      

   .. method:: get_index_path(self)


   .. method:: exists(self)


   .. method:: create_index(self)


   .. method:: get_doc(self, doc_id)


   .. method:: get_docs(self, doc_ids)



.. py:class:: AnseriniIndex

   Bases: :class:`capreolus.index.Index`

   .. attribute:: module_name
      :annotation: = anserini

      

   .. attribute:: config_spec
      

      

   .. method:: get_docs(self, doc_ids)


   .. method:: get_doc(self, docid)


   .. method:: get_df(self, term)


   .. method:: get_idf(self, term)

      BM25's IDF with a floor of 0


   .. method:: open(self)