summaryrefslogtreecommitdiff
path: root/readme
blob: 8e37e851195b04108ed2f161a7f51bd609ea3f07 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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.