summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGustaf Rydholm <gustaf.rydholm@gmail.com>2024-04-13 13:21:44 +0200
committerGustaf Rydholm <gustaf.rydholm@gmail.com>2024-04-13 13:21:44 +0200
commita96b270805eba2b6d8c40d1fa2ee0d35c73cba0e (patch)
treefd2a663eda2b4ccb021adcd7fb5b4e6d89180f95 /README.md
parent4968ed48ed1adb267b910b28fdda0db115ba1b19 (diff)
Add upload script
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.md b/README.md
index c478830..3fd5569 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
# Retrieval Augmented Generation
-RAG with ollama (and optionally cohere) and qdrant. This is basically a glorified
-ctrl+f.
+RAG with ollama (and optionally cohere) and qdrant. This is basically a glorified
+(bloated) `ctrl+f`.
## Usage
@@ -65,7 +65,9 @@ Get an API from their website.
#### 6.1 Prerequisites
-##### 6.2 Python Environment
+Both databases needs to be running as well as ollama.
+
+##### 6.1.1 Python Environment
Activate the poetry shell:
@@ -91,7 +93,11 @@ streamlit run rag/ui.py
#### 6.5 Upload Multiple Documents
-tbc
+To upload an entire directory (and subdirectories) of pdfs, simply run:
+
+```sh
+python rag/upload.py -d <PATH-TO-DIR-WITH-PDFS>
+```
### Notes