[ci skip] iter afd6d8c

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 4b4ab3244d11a3f679134e15f8391ed7
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/about.rst.txt

@@ -0,0 +1,4 @@
+About us
+========
+
+This is a Sunday afternoon project.

_sources/auto_examples/index.rst.txt

@@ -0,0 +1,9 @@
+:orphan:
+
+.. _general_examples:
+
+Examples
+--------
+
+One day, I will write some examples. Right now, something is located in the `/scripts`
+folder.

_sources/index.rst.txt

@@ -0,0 +1,108 @@
+.. project-template documentation master file, created by
+   sphinx-quickstart on Mon Jan 18 14:44:12 2016.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+:notoc:
+
+#######################################
+sklearn-doc-rag-based-llm documentation
+#######################################
+
+**Date**: |today| **Version**: |version|
+
+**Useful links**:
+`Source Repository <https://github.com/glemaitre/sklearn-doc-rag-based-llm>`__ |
+`Issues & Ideas <https://github.com/glemaitre/sklearn-doc-rag-based-llm/issues>`__ |
+
+This is the documentation for the `sklearn-doc-rag-based-llm` project.
+The idea is to provide a set of tools to build a RAG-based LLM to answer questions
+about the scikit-learn library.
+
+.. raw:: html
+
+    <div class="container">
+        <div class="row">
+            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
+                <div class="card text-center intro-card shadow">
+                <div class="card-body flex-fill">
+                    <i class="fas fa-download fa-7x"></i>
+                    <h5 class="card-title">Getting started</h5>
+                    <p class="card-text">Check out the getting started guides to install <em>rag_based_llm</em>.
+                    Some extra information to get started with a new contribution is also provided.</p>
+
+.. container:: custom-button
+
+    :ref:`To the installation guideline<getting_started>`
+
+.. raw:: html
+
+                </div>
+                </div>
+            </div>
+            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
+                <div class="card text-center intro-card shadow">
+                <div class="card-body flex-fill">
+                    <i class="fas fa-book fa-7x"></i>
+                    <h5 class="card-title">User guide</h5>
+                    <p class="card-text">The user guide provides in-depth information on the
+                    key concepts of the RAG-based LLM with useful background information and explanation.</p>
+
+.. container:: custom-button
+
+    :ref:`To the user guide<user_guide>`
+
+.. raw:: html
+
+                </div>
+                </div>
+            </div>
+            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
+                <div class="card text-center intro-card shadow">
+                <div class="card-body flex-fill">
+                    <i class="fas fa-code fa-7x"></i>
+                    <h5 class="card-title">API reference</h5>
+                    <p class="card-text">The reference guide contains a detailed description of
+                    the available tools.</p>
+
+.. container:: custom-button
+
+    :ref:`To the reference guide<api>`
+
+.. raw:: html
+
+                </div>
+                </div>
+            </div>
+            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
+                <div class="card text-center intro-card shadow">
+                <div class="card-body flex-fill">
+                    <i class="fas fa-chart-bar fa-7x"></i>
+                    <h5 class="card-title">Examples</h5>
+                    <p class="card-text">The gallery of examples is a good place to see RAG-based LLM in action.
+                    Select an example and dive in.</p>
+
+.. container:: custom-button
+
+    :ref:`To the gallery of examples<general_examples>`
+
+.. raw:: html
+
+                </div>
+                </div>
+            </div>
+        </div>
+    </div>
+
+
+.. toctree::
+    :maxdepth: 3
+    :hidden:
+    :titlesonly:
+
+    install
+    user_guide
+    references/index
+    auto_examples/index
+    whats_new
+    about

_sources/install.rst.txt

@@ -0,0 +1,20 @@
+.. _getting_started:
+
+###############
+Getting Started
+###############
+
+Since this is a Sunday afternoon project, there is not yet a way to install the
+package. An easy and dirty way is to add the package into your path for the moment::
+
+  import sys
+
+  path_to_package = "/path/to/rag_based_llm"
+  sys.path.append(path_to_package)
+
+You can check the file `requirements.txt` for the required packages. We also provide
+a `environment.yml` file for conda users. You might want to check which version of
+some libraries you are installing to take profit of the GPU acceleration.
+
+We did not commit the folder "/models" to the repository but the script `scripts/exp.py`
+expect the LLM model to be in this folder.

_sources/references/embedding.rst.txt

@@ -0,0 +1,16 @@
+.. _embedding_ref:
+
+Embedding
+=========
+
+.. automodule:: rag_based_llm.embedding
+   :no-members:
+   :no-inherited-members:
+
+.. currentmodule:: rag_based_llm.embedding
+
+.. autosummary::
+   :toctree: generated/
+   :template: class.rst
+
+    SentenceTransformer

_sources/references/generated/rag_based_llm.embedding.SentenceTransformer.rst.txt

@@ -0,0 +1,44 @@
+SentenceTransformer
+=========================================================
+
+.. currentmodule:: rag_based_llm.embedding
+
+.. autoclass:: SentenceTransformer
+
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+
+
+        ~SentenceTransformer.fit
+
+
+        ~SentenceTransformer.fit_transform
+
+
+        ~SentenceTransformer.get_metadata_routing
+
+
+        ~SentenceTransformer.get_params
+
+
+        ~SentenceTransformer.set_output
+
+
+        ~SentenceTransformer.set_params
+
+
+        ~SentenceTransformer.transform
+
+
+
+
+.. include:: rag_based_llm.embedding.SentenceTransformer.examples
+
+.. raw:: html
+
+    <div style='clear:both'></div>

_sources/references/generated/rag_based_llm.prompt.QueryAgent.rst.txt

@@ -0,0 +1,23 @@
+QueryAgent
+=============================================
+
+.. currentmodule:: rag_based_llm.prompt
+
+.. autoclass:: QueryAgent
+
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+
+
+
+
+.. include:: rag_based_llm.prompt.QueryAgent.examples
+
+.. raw:: html
+
+    <div style='clear:both'></div>

_sources/references/generated/rag_based_llm.retrieval.BM25Retriever.rst.txt

@@ -0,0 +1,38 @@
+BM25Retriever
+===================================================
+
+.. currentmodule:: rag_based_llm.retrieval
+
+.. autoclass:: BM25Retriever
+
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+
+
+        ~BM25Retriever.fit
+
+
+        ~BM25Retriever.get_metadata_routing
+
+
+        ~BM25Retriever.get_params
+
+
+        ~BM25Retriever.query
+
+
+        ~BM25Retriever.set_params
+
+
+
+
+.. include:: rag_based_llm.retrieval.BM25Retriever.examples
+
+.. raw:: html
+
+    <div style='clear:both'></div>

_sources/references/generated/rag_based_llm.retrieval.RetrieverReranker.rst.txt

@@ -0,0 +1,38 @@
+RetrieverReranker
+=======================================================
+
+.. currentmodule:: rag_based_llm.retrieval
+
+.. autoclass:: RetrieverReranker
+
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+
+
+        ~RetrieverReranker.fit
+
+
+        ~RetrieverReranker.get_metadata_routing
+
+
+        ~RetrieverReranker.get_params
+
+
+        ~RetrieverReranker.query
+
+
+        ~RetrieverReranker.set_params
+
+
+
+
+.. include:: rag_based_llm.retrieval.RetrieverReranker.examples
+
+.. raw:: html
+
+    <div style='clear:both'></div>

_sources/references/generated/rag_based_llm.retrieval.SemanticRetriever.rst.txt

@@ -0,0 +1,38 @@
+SemanticRetriever
+=======================================================
+
+.. currentmodule:: rag_based_llm.retrieval
+
+.. autoclass:: SemanticRetriever
+
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+
+
+        ~SemanticRetriever.fit
+
+
+        ~SemanticRetriever.get_metadata_routing
+
+
+        ~SemanticRetriever.get_params
+
+
+        ~SemanticRetriever.query
+
+
+        ~SemanticRetriever.set_params
+
+
+
+
+.. include:: rag_based_llm.retrieval.SemanticRetriever.examples
+
+.. raw:: html
+
+    <div style='clear:both'></div>