Merge branch 'ragsphere' into github_mirror

Author: Diepenbruck

.gitignore

@@ -28,3 +28,5 @@ db/elastic_data/**
 !db/elastic_data/README.md
 db/postgres_data
 resources/*.log
+
+public/

docs/demo/Text2Cypher.ipynb

@@ -16,18 +16,6 @@
     "**NOTE: The APOC core library must be installed in your Neo4j instance ([Installation](https://neo4j.com/docs/apoc/current/installation/))**"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0ff1a2b5-9659-4eae-921e-26720f5da069",
-   "metadata": {
-    "scrolled": true
-   },
-   "outputs": [],
-   "source": [
-    "%pip install -e .."
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": 2,
@@ -398,7 +386,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "rag-sphere",
    "language": "python",
    "name": "python3"
   },
@@ -412,7 +400,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.5"
+   "version": "3.11.14"
   }
  },
  "nbformat": 4,

docs/demo/Vector_GraphRAG.ipynb

@@ -16,18 +16,6 @@
     "**NOTE: The APOC core library must be installed in your Neo4j instance ([Installation](https://neo4j.com/docs/apoc/current/installation/))**"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "332de69e-83fc-49c3-9a08-a9362de413a3",
-   "metadata": {
-    "scrolled": true
-   },
-   "outputs": [],
-   "source": [
-    "%pip install -e .."
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": 2,

docs/demo/Vector_RAG.ipynb

@@ -8,18 +8,6 @@
     "### Preamble"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0ece83c1-b5f0-4cf0-94c5-e2452394f5f3",
-   "metadata": {
-    "scrolled": true
-   },
-   "outputs": [],
-   "source": [
-    "%pip install -e .."
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": 17,

docs/demo/index.md

@@ -3,11 +3,46 @@
 
 The following is a list of Jupyter notebooks that demonstrate how to use the included Retrieval-Augmented Generation techniques.
 
-- [Vector RAG Notebook](Vector_RAG.ipynb)
-- [Vector GraphRAG Notebook](Vector_GraphRAG.ipynb)
-- [Vector Cypher GraphRAG Notebook](Vector_Cypher_GraphRAG.ipynb)
-- [Hybrid GraphRAG Notebook](Hybrid_GraphRAG.ipynb)
-- [Hybrid Cypher GraphRAG Notebook](Hybrid_Cypher_GraphRAG.ipynb)
-- [Text2Cypher Notebook](Text2Cypher.ipynb)
-- [GARAG Notebook](GARAG.ipynb)
-- [Naive GraphRAG Notebook](Naive_GraphRAG.ipynb)
+<div class="nb-list">
+
+<div class="nb-row">
+  <a class="nb-link" href="Vector_RAG">Vector RAG Notebook</a>
+  <a class="nb-dl" href="https://github.com/DLR-SC/RAG-Sphere/blob/rag-sphere/docs/demo/Vector_RAG.ipynb" download>Download</a>
+</div>
+
+<div class="nb-row">
+  <a class="nb-link" href="Vector_GraphRAG">Vector GraphRAG Notebook</a>
+  <a class="nb-dl" href="https://github.com/DLR-SC/RAG-Sphere/blob/rag-sphere/docs/demo/Vector_GraphRAG.ipynb" download>Download</a>
+</div>
+
+<div class="nb-row">
+  <a class="nb-link" href="Vector_Cypher_GraphRAG">Vector Cypher GraphRAG Notebook</a>
+  <a class="nb-dl" href="https://github.com/DLR-SC/RAG-Sphere/blob/rag-sphere/docs/demo/Vector_Cypher_GraphRAG.ipynb" download>Download</a>
+</div>
+
+<div class="nb-row">
+  <a class="nb-link" href="Hybrid_GraphRAG">Hybrid GraphRAG Notebook</a>
+  <a class="nb-dl" href="https://github.com/DLR-SC/RAG-Sphere/blob/rag-sphere/docs/demo/Hybrid_GraphRAG.ipynb" download>Download</a>
+</div>
+
+<div class="nb-row">
+  <a class="nb-link" href="Hybrid_Cypher_GraphRAG">Hybrid Cypher GraphRAG Notebook</a>
+  <a class="nb-dl" href="https://github.com/DLR-SC/RAG-Sphere/blob/rag-sphere/docs/demo/Hybrid_Cypher_GraphRAG.ipynb" download>Download</a>
+</div>
+
+<div class="nb-row">
+  <a class="nb-link" href="Text2Cypher">Text2Cypher Notebook</a>
+  <a class="nb-dl" href="https://github.com/DLR-SC/RAG-Sphere/blob/rag-sphere/docs/demo/Text2Cypher.ipynb" download>Download</a>
+</div>
+
+<div class="nb-row">
+  <a class="nb-link" href="GARAG">GARAG Notebook</a>
+  <a class="nb-dl" href="https://github.com/DLR-SC/RAG-Sphere/blob/rag-sphere/docs/demo/GARAG.ipynb" download>Download</a>
+</div>
+
+<div class="nb-row">
+  <a class="nb-link" href="Naive_GraphRAG">Naive GraphRAG Notebook</a>
+  <a class="nb-dl" href="https://github.com/DLR-SC/RAG-Sphere/blob/rag-sphere/docs/demo/Naive_GraphRAG.ipynb" download>Download</a>
+</div>
+
+</div>

docs/overrides/home.html

@@ -96,10 +96,10 @@
         <div class="mdx-hero__content">
           <h1><span style="font-weight: bold;">RAGsphere</span>: A Unified Library of Retrieval-Augmented Generation Techniques with Implementations, Comparisons, and a Practical Selection Guide</h1>
           <h3>Empowering RAG Practitioners with Insights into Modern Techniques and Guidance for Choosing the Right Approach.</h3>
-          <a href="http://127.0.0.1:8000/getting-started/" class="md-button md-button--primary">
+          <a href="/getting-started/" class="md-button md-button--primary">
             Getting Started
           </a>
-          <a href="http://127.0.0.1:8000/#rag-techniques" class="md-button">
+          <a href="/#rag-techniques" class="md-button">
             Techniques
           </a>
         </div>

docs/stylesheets/custom.css

@@ -215,4 +215,34 @@ Causes a delay when opening search, not optimal */
 .md-main__inner > .md-typeset table {
   margin-left: auto;
   margin-right: auto;
-}
+}
+
+.nb-list {
+  margin-top: 1rem;
+}
+
+.nb-row {
+  display: flex;
+  gap: 1rem;
+  align-items: baseline;
+  padding: .25rem 0;
+}
+
+.nb-link {
+  flex: 1;
+  min-width: 0;
+}
+
+.nb-dl {
+  white-space: nowrap;
+  font-size: 0.9em;
+  padding: .15rem .5rem;
+  border: 1px solid currentColor;
+  border-radius: .4rem;
+  text-decoration: none;
+  opacity: .85;
+}
+
+.nb-dl:hover {
+  opacity: 1;
+}