.. RAGoon documentation master file, created by
   sphinx-quickstart on Thu Aug  1 17:22:00 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.
RAGoon : High level library for batched embeddings generation, blazingly-fast web-based RAG and quantized indexes processing ⚡
=================================================================================================================================

RAGoon is a set of NLP utilities for multi-model embedding production, high-dimensional vector visualization, and aims to improve language model performance by providing contextually relevant information through search-based querying, web scraping and data augmentation techniques.

Quick install
-------------

The reference page for RAGoon is available on the official page of PyPI: `RAGoon <https://pypi.org/project/ragoon/>`_.

.. code-block:: python

   pip install ragoon

Citing this project
-------------------

If you use this code in your research, please use the following BibTeX entry.

.. code-block:: BibTeX

   @misc{louisbrulenaudet2024,
       author = {Louis Brulé Naudet},
       title = {RAGoon : High level library for batched embeddings generation, blazingly-fast web-based RAG and quantized indexes processing},
       howpublished = {\url{https://github.com/louisbrulenaudet/ragoon}},
       year = {2024}
   }

Feedback
--------

If you have any feedback, please reach out at `louisbrulenaudet@icloud.com <mailto:louisbrulenaudet@icloud.com>`_.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   installation
   tutorials


.. toctree::
   :hidden:
   :caption: 📖 Reference
   :maxdepth: 2

   modules

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

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