Update sphinx documentation

arjbingly · Apr 18, 2024 · 837e179 · 837e179
1 parent 545280b
commit 837e179
Show file tree

Hide file tree

Showing 71 changed files with 254 additions and 166 deletions.
diff --git a/src/docs/_build/doctrees/environment.pickle b/src/docs/_build/doctrees/environment.pickle
diff --git a/src/docs/_build/doctrees/get_started.installation.doctree b/src/docs/_build/doctrees/get_started.installation.doctree
diff --git a/src/docs/_build/doctrees/get_started.vectordb.doctree b/src/docs/_build/doctrees/get_started.vectordb.doctree
diff --git a/src/docs/_build/doctrees/grag.components.doctree b/src/docs/_build/doctrees/grag.components.doctree
diff --git a/src/docs/_build/doctrees/grag.components.vectordb.doctree b/src/docs/_build/doctrees/grag.components.vectordb.doctree
diff --git a/src/docs/_build/doctrees/grag.rag.doctree b/src/docs/_build/doctrees/grag.rag.doctree
diff --git a/src/docs/_build/html/.buildinfo b/src/docs/_build/html/.buildinfo
@@ -1,4 +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: 4e9c7fafa68d58ea0265316a26496cf3
+config: 6b07e347145cdddb9512d0a4e5895210
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/src/docs/_build/html/_downloads/2ceb93416492b18edb9a519fe43e25d4/BasicRAG_stuff.ipynb b/src/docs/_build/html/_downloads/2ceb93416492b18edb9a519fe43e25d4/BasicRAG_stuff.ipynb
@@ -35,7 +35,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.8"
+      "version": "3.11.7"
     }
   },
   "nbformat": 4,

diff --git a/src/docs/_build/html/_downloads/398f6ce64b7837df7dca7d8498b83c89/retriever_app.ipynb b/src/docs/_build/html/_downloads/398f6ce64b7837df7dca7d8498b83c89/retriever_app.ipynb
@@ -35,7 +35,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.8"
+      "version": "3.11.7"
     }
   },
   "nbformat": 4,

diff --git a/src/docs/_build/html/_downloads/40ffe2716096f331549183db9c0ece72/Retriver-GUI_jupyter.zip b/src/docs/_build/html/_downloads/40ffe2716096f331549183db9c0ece72/Retriver-GUI_jupyter.zip
diff --git a/src/docs/_build/html/_downloads/7c6daaeaa6e5520da795fa975d498452/Retriver-GUI_python.zip b/src/docs/_build/html/_downloads/7c6daaeaa6e5520da795fa975d498452/Retriver-GUI_python.zip
diff --git a/...docs/_build/html/_downloads/a5ce84c5bef70acf41de351348bff58f/BasicRAG_FewShotPrompt.ipynb b/...docs/_build/html/_downloads/a5ce84c5bef70acf41de351348bff58f/BasicRAG_FewShotPrompt.ipynb
@@ -35,7 +35,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.8"
+      "version": "3.11.7"
     }
   },
   "nbformat": 4,

diff --git a/src/docs/_build/html/_downloads/bf688b7eeb7dcdadbda5c6db6eed9225/BasicRAG_CustomPrompt.ipynb b/src/docs/_build/html/_downloads/bf688b7eeb7dcdadbda5c6db6eed9225/BasicRAG_CustomPrompt.ipynb
@@ -35,7 +35,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.8"
+      "version": "3.11.7"
     }
   },
   "nbformat": 4,

diff --git a/src/docs/_build/html/_downloads/bf6c4ba115907c5ef1c944698d335d59/BasicRAG_refine.ipynb b/src/docs/_build/html/_downloads/bf6c4ba115907c5ef1c944698d335d59/BasicRAG_refine.ipynb
@@ -35,7 +35,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.8"
+      "version": "3.11.7"
     }
   },
   "nbformat": 4,

diff --git a/src/docs/_build/html/_downloads/c2aaa4bbe39e5912c7fc7f49997b431e/BasicRAG_ingest.ipynb b/src/docs/_build/html/_downloads/c2aaa4bbe39e5912c7fc7f49997b431e/BasicRAG_ingest.ipynb
@@ -35,7 +35,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.11.8"
+      "version": "3.11.7"
     }
   },
   "nbformat": 4,

diff --git a/src/docs/_build/html/_downloads/d30c8b1c6e4654b2ad3d2a98fac0be74/Basic-RAG_python.zip b/src/docs/_build/html/_downloads/d30c8b1c6e4654b2ad3d2a98fac0be74/Basic-RAG_python.zip
diff --git a/src/docs/_build/html/_downloads/f9939c7be8f2cbb228881fcceb9ea19d/Basic-RAG_jupyter.zip b/src/docs/_build/html/_downloads/f9939c7be8f2cbb228881fcceb9ea19d/Basic-RAG_jupyter.zip
diff --git a/src/docs/_build/html/_sources/get_started.installation.rst.txt b/src/docs/_build/html/_sources/get_started.installation.rst.txt
@@ -1,9 +1,10 @@
 Installation
 ===============
-*Since we are just in the development phase we have not published to pypi yet.*
+*Since we are in the development phase, we have not published to pypi yet.*
 
 * ``git clone`` the repository
 * ``pip install .`` from the repository
 * *For Developers*: ``pip install -e .``
 
-Moreover, further customization can be made on the config file, `src/config.ini`.
+Further customization can be made on the config file, `src/config.ini`.
+
diff --git a/src/docs/_build/html/_sources/get_started.vectordb.rst.txt b/src/docs/_build/html/_sources/get_started.vectordb.rst.txt
@@ -1,36 +1,45 @@
 Vector Stores
 ===============
 
-# Explain what a vector store is...
+Vector store or vector database is a type of database that stores data in high-dimensional vectors. 
+This is a crucial component of RAG, storing embeddings for both retrieval and generation processes.
 
 Supported Vector Stores
 ########################
 
 Currently supported vectorstores are:
 
 1. Chroma
-2. Deeplake
+2. DeepLake
 
 Chroma
 *******
 Since Chroma is a server-client based vector database, make sure to run the server.
 
-* To run Chroma locally, either use move to `src/scripts` then run `source run_chroma.sh` or refer to
-  `Running Chroma in ClientServer <https://docs.trychroma.com/usage-guide#running-chroma-in-clientserver-mode>`_.
+* To run Chroma locally, either:
+
+  - Move to `src/scripts` then run ``source run_chroma.sh`` OR
+
+  - Refer to `Running Chroma in ClientServer <https://docs.trychroma.com/usage-guide#running-chroma-in-clientserver-mode>`_.
   This by default runs on port 8000.
-* If Chroma is not run locally, change `host` and `port` under `chroma` in `src/config.ini`, or provide the arguments
+
+* If Chroma is not run locally, change ``host`` and ``port`` under ``chroma`` in `src/config.ini`, or provide the arguments
   explicitly.
 
+For non-supported vectorstores, (...)
 
 Embeddings
 ###########
 
-* By default, the embedding model is `instructor-xl`. Can be changed by changing `embedding_type` and `embedding_model`
+* By default, the embedding model is `instructor-xl`. Can be changed by changing ``embedding_type`` and ``embedding_model``
   in `src/config.ini` or providing the arguments explicitly.
 * Any huggingface embeddings can be used.
 
 Data Ingestion
 ###############
+
+For more details on data ingestion, refer to our `cookbook <https://github.com/arjbingly/Capstone_5/blob/main/cookbook/Basic-RAG/README.md>`_.
+
 ::
 
     client = DeepLakeClient() # Any vectordb client
@@ -41,3 +50,4 @@ Data Ingestion
 
 
     retriever.ingest(dir_path)
+
diff --git a/src/docs/_build/html/_sources/grag.components.vectordb.rst.txt b/src/docs/_build/html/_sources/grag.components.vectordb.rst.txt
@@ -28,7 +28,7 @@ Deeplake Client
    :undoc-members:
    :show-inheritance:
 
-Module contents
+Module Contents
 ---------------
 
 .. automodule:: grag.components.vectordb

diff --git a/src/docs/_build/html/_static/basic.css b/src/docs/_build/html/_static/basic.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/src/docs/_build/html/_static/doctools.js b/src/docs/_build/html/_static/doctools.js
@@ -4,7 +4,7 @@
  *
  * Base JavaScript utilities for all Sphinx HTML documentation.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/src/docs/_build/html/_static/language_data.js b/src/docs/_build/html/_static/language_data.js
@@ -5,15 +5,15 @@
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
 
 var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
 
 
-/* Non-minified version is copied as a separate JS file, is available */
+/* Non-minified version is copied as a separate JS file, if available */
 
 /**
  * Porter Stemmer

diff --git a/src/docs/_build/html/_static/pygments.css b/src/docs/_build/html/_static/pygments.css
@@ -17,7 +17,6 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
 .highlight .gd { color: #A00000 } /* Generic.Deleted */
 .highlight .ge { font-style: italic } /* Generic.Emph */
-.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .highlight .gr { color: #E40000 } /* Generic.Error */
 .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .highlight .gi { color: #008400 } /* Generic.Inserted */