initial_commit

1 files changed, 16 insertions, 0 deletions

diff --git a/readme b/readme
new file mode 100644
index 0000000..8e37e85
--- /dev/null
+++ b/readme
@@ -0,0 +1,16 @@
+#Installation: (pytorch higher version should work as well, the gpu i have is a bit old)
+python3 -m venv venv && source venv/bin/activate
+pip install -r requirements.txt --extra-index-url https://download.pytorch.org/whl/cu121
+
+#Usage:
+./search.py "your research question"
+./search.py --test  # sanity check to test llm workability
+./search.py "what does mcdonalds serve?"
+./search.py "is new york one of the locations of the sept 11 attacks?"
+./search.py "strawberries. what colour are they?"
+
+#Documentation:
+This program uses two research tools:
+        - local document(in ./documents) search using an embedding model + ChromaDB for semantic retrieval
+        - web search using duckduckgo
+A local llm orchestrates the research loop, deciding when enough information has been gathered, then provides a final concise summary.