Add api key information
Browse files
README.md
CHANGED
|
@@ -28,7 +28,14 @@ DEMO: https://huggingface.co/spaces/Kadi-IAM/LISA
|
|
| 28 |
pip install -r requirements.txt
|
| 29 |
```
|
| 30 |
|
| 31 |
-
3. Set
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 32 |
Populate the knowledge base with relevant documents or research papers. Ensure that documents are in a format (pdf or xml) compatible with the RAG pipeline. By default documents should be located at `data/documents`. After running the following comand, some caches files are saved into `data/db`. ATTENTION: pickle is used to save these caches, be careful with potential security risks.
|
| 33 |
```bash
|
| 34 |
python preprocess_documents.py
|
|
|
|
| 28 |
pip install -r requirements.txt
|
| 29 |
```
|
| 30 |
|
| 31 |
+
3. Set enviroment variables (Huggingface for downloading model weights, Tavily for web search and Groq for LLMs):
|
| 32 |
+
```bash
|
| 33 |
+
export HUGGINGFACEHUB_API_TOKEN=your_api_key_here
|
| 34 |
+
export TAVILY_API_KEY=your_api_key_here
|
| 35 |
+
export GROQ_API_KEY=your_api_key_here
|
| 36 |
+
```
|
| 37 |
+
|
| 38 |
+
4. Set Up the Knowledge Base
|
| 39 |
Populate the knowledge base with relevant documents or research papers. Ensure that documents are in a format (pdf or xml) compatible with the RAG pipeline. By default documents should be located at `data/documents`. After running the following comand, some caches files are saved into `data/db`. ATTENTION: pickle is used to save these caches, be careful with potential security risks.
|
| 40 |
```bash
|
| 41 |
python preprocess_documents.py
|