Commit ·
c69b8a2
1
Parent(s): 8c67043
docs: document HF_DEPLOYMENT flag in environment setup
Browse files
README.md
CHANGED
|
@@ -70,7 +70,10 @@ Fully containerized for "Run Anywhere" capability.
|
|
| 70 |
|
| 71 |
### Option A: Local Python
|
| 72 |
1. **Install**: `pip install -r requirements.txt`
|
| 73 |
-
2. **Environment**: Create `.env`
|
|
|
|
|
|
|
|
|
|
| 74 |
3. **Run Service**:
|
| 75 |
```bash
|
| 76 |
uvicorn main:app --reload
|
|
|
|
| 70 |
|
| 71 |
### Option A: Local Python
|
| 72 |
1. **Install**: `pip install -r requirements.txt`
|
| 73 |
+
2. **Environment**: Create `.env` containing your API keys and configuration:
|
| 74 |
+
* `GEMINI_API_KEY`: Google Gemini API access.
|
| 75 |
+
* `TAVILY_API_KEY`: Tavily search engine access.
|
| 76 |
+
* `HF_DEPLOYMENT`: Set to `true` to enable lazy-loading performance mode (essential for free CPU hosting tiers, defers model downloads, and disables the heavy CrossEncoder reranker).
|
| 77 |
3. **Run Service**:
|
| 78 |
```bash
|
| 79 |
uvicorn main:app --reload
|