docs

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Astra Clelia Bertelli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,24 +1,130 @@
-# qdurllm
+<h1 align="center">qdurllm</h1>
+<h2 align="center">Search your favorite websites and chat with them, on your desktop🌐</h2>
 
-**qdurllm** is a local search engine that lets you search through different URLs, retrieve and chat with their content, powered by Qdrant, Langchain, llama.cpp and Gradio.
 
-## Quickstart
+<div align="center">
+    <img src="https://img.shields.io/github/languages/top/AstraBert/qdurllm" alt="GitHub top language">
+   <img src="https://img.shields.io/github/commit-activity/t/AstraBert/qdurllm" alt="GitHub commit activity">
+   <img src="https://img.shields.io/badge/qdurllm-stable_beta-green" alt="Static Badge">
+   <img src="https://img.shields.io/badge/Release-v0.0.0b-purple" alt="Static Badge">
+   <img src="https://img.shields.io/docker/image-size/astrabert/local-search-application
+   " alt="Docker image size">
+   <img src="https://img.shields.io/badge/Supported_platforms-Windows/macOS/Linux-brown" alt="Static Badge">
+   <div>
+        <img src="./imgs/qdurllm.png" alt="Flowchart" align="center">
+        <p><i>Flowchart for everything-ai</i></p>
+   </div>
+</div>
 
-### Installation
+**qdurllm** (**Qd**rant **URL**s and **L**arge **L**anguage **M**odels) is a local search engine that lets you select and upload URL content to a vector database: after that, you can search, retrieve and chat with this content.
+
+This is provisioned through a multi-container Docker application, leveraging Qdrant, Langchain, llama.cpp, quantized Gemma and Gradio.
+
+## Requirements
+
+The only requirement is to have `docker` and `docker-compose`.
+
+If you don't have them, make sure to install them [here](https://docs.docker.com/get-docker/).
+
+## Installation
+
+You can install the application by cloning the GitHub repository
 
 ```bash
 git clone https://github.com/AstraBert/qdurllm.git
 cd qdurllm
 ```
 
-### Run it!
+Or you can simply paste the following text into a `compose.yaml` file:
+
+```yaml
+networks:
+  mynet:
+    driver: bridge
+services:
+  local-search-application:
+    image: astrabert/local-search-application
+    networks:
+      - mynet
+    ports:
+      - "7860:7860"
+  qdrant:
+    image: qdrant/qdrant
+    ports:
+      - "6333:6333"
+    volumes:
+      - "./qdrant_storage:/qdrant/storage"
+    networks:
+      - mynet
+  llama_server:
+    image: astrabert/llama.cpp-gemma
+    ports:
+      - "8000:8000"
+    networks:
+      - mynet
+```
+
+Placing the file in whatever directory you want in your file system.
+
+Prior to running the application, you can optionally pull all the needed images from Docker hub:
+
+```bash
+docker pull qdrant/qdrant
+docker pull astrabert/llama.cpp-gemma
+docker pull astrabert/local-search-application
+```
+
+## How does it work?
+
+When launched (see [Usage](#usage)), the application runs three containers:
+
+- `qdrant`(port 6333): serves as vector database provider for semantic search-based retrieval
+- `llama.cpp-gemma`(port 8000): this is an implementation of a [quantized Gemma model](https://huggingface.co/lmstudio-ai/gemma-2b-it-GGUF) provided by LMStudio and Google, served with `llama.cpp` server. This works for text-generation scopes, enriching the search experience of the user.
+- `local-search-application`(port 7860): a Gradio tabbed interface with:
+    + The possibility to upload one or multiple contents by specifying the URL (thanks to Langchain)
+    + The possibility to chat with the uploaded URLs thanks to `llama.cpp-gemma`
+    + The possibility to perform a direct search that leverages double-layered retrieval with `all-MiniLM-L6-v2` (that identifies the 10 best matches) and `sentence-t5-base` (that re-encodes the 10 best matches and extracts the best hit from them) - this is the same RAG implementation used in combination with `llama.cpp-gemma`.
+
+> _The overall computational burden is light enough to make the application run not only GPUless, but also with low RAM availability (>=8GB, although it can take up to 10 mins for Gemma to respond on 8GB RAM)._ 
+
+## Usage
+
+### Run it
+
+You can make the application work with the following - really simple - command, which has to be run within the same directory where you stored your `compose.yaml` file:
 
 ```bash
 docker compose up -d
 ```
 
-You'll find the application running at `http://localhost:7860` or `http://0.0.0.0:7860`
+If you've already pulled all the images, you'll find the application running at `http://localhost:7860` or `http://0.0.0.0:7860` in less than a minute. 
+
+If you have not pulled the images, you'll have to wait that their installation is complete before actually using the application.
+
+### Use it
+
+Once the app is loaded, you'll find a first tab in which you can write the URLs whose content you want to interact with:
+
+![upload_URLs](./imgs/tutorial1.png)
+
+Now that your URLs are uploaded, you can either chat with their content through `llama.cpp-gemma`:
+
+![chat_with_URLs](./imgs/tutorial2.png)
+
+> _Note that you can also set parameters like maximum output tokens, temperature, repetition penalty and generation seed_
+
+Or you can use double-layered-retrieval semantic search to query your URL content(s) directly:
+
+![direct_search](./imgs/tutorial3.png)
+
+## License and rights of usage
+
+The software is (and will always be) open-source, provided under [MIT license](./LICENSE).
+
+Anyone can use, modify and redistribute any portion of it, as long as the author, [Astra Clelia Bertelli](https://astrabert.vercel.app) is cited.
+
+## Contributions and funding
 
-## Flowchart
+Contribution are always more than welcome! Feel free to flag issues, open PRs or [contact the author](mailto:[email protected]) to suggest any changes, request features or improve the code.
 
-![Flowchart](imgs/qdurllm.png)
+If you found the application useful, please consider [funding it](https://github.com/sponsors/AstraBert) in order to allow improvements!

application/Dockerfile

@@ -1,10 +1,12 @@
-FROM astrabert/local-search-application:latest
+FROM python:3.10.14-slim-bookworm
 
 WORKDIR /app
 
-RUN mkdir -p /app/scripts
+ADD . /app/
 
-ADD ./scripts/*.py /app/scripts/
+RUN python3 -m pip cache purge
+RUN python3 -m pip install --no-cache-dir -r requirements.txt
+RUN python3 -m nltk.downloader all
 
 EXPOSE 7860
 

application/requirements.txt

@@ -3,6 +3,7 @@ qdrant_client==1.9.0
 nltk==3.8.1
 spacy==3.7.2
 sentence_transformers==3.0.0
+psutil
 unstructured
 langchain
 langchain_core