|
8 | 8 |
|
9 | 9 | It supports Git repositories, web URLs, and file types like Markdown, PDFs, and HTML. Designed for local runs, containers, or OpenShift/Kubernetes jobs. |
10 | 10 |
|
| 11 | +- [📚 vector-embedder](#-vector-embedder) |
| 12 | + - [⚙️ Features](#️-features) |
| 13 | + - [🚀 Quick Start](#-quick-start) |
| 14 | + - [1. Configuration](#1-configuration) |
| 15 | + - [2. Run Locally](#2-run-locally) |
| 16 | + - [3. Or Run in a Container](#3-or-run-in-a-container) |
| 17 | + - [🧪 Dry Run Mode](#-dry-run-mode) |
| 18 | + - [📦 Dependency Management \& Updates](#-dependency-management--updates) |
| 19 | + - [🔧 Installing `pip-tools`](#-installing-pip-tools) |
| 20 | + - [➕ Adding / Updating a Package](#-adding--updating-a-package) |
| 21 | + - [🗂️ Project Layout](#️-project-layout) |
| 22 | + - [🧪 Local DB Testing](#-local-db-testing) |
| 23 | + - [PGVector (PostgreSQL)](#pgvector-postgresql) |
| 24 | + - [Elasticsearch](#elasticsearch) |
| 25 | + - [Redis (RediSearch)](#redis-redisearch) |
| 26 | + - [Qdrant](#qdrant) |
| 27 | + - [🙌 Acknowledgments](#-acknowledgments) |
| 28 | + |
11 | 29 | --- |
12 | 30 |
|
13 | 31 | ## ⚙️ Features |
@@ -101,6 +119,43 @@ Run it: |
101 | 119 |
|
102 | 120 | --- |
103 | 121 |
|
| 122 | +## 📦 Dependency Management & Updates |
| 123 | + |
| 124 | +This project keeps *two* dependency files under version control: |
| 125 | + |
| 126 | +| File | Purpose | Edited by | |
| 127 | +|------|---------|-----------| |
| 128 | +| **`requirements.in`** | Short, human-readable list of *top-level* libraries (no pins) | You | |
| 129 | +| **`requirements.txt`** | Fully-resolved, **pinned** lock file—including hashes—for exact, reproducible builds | `pip-compile` | |
| 130 | + |
| 131 | +### 🔧 Installing `pip-tools` |
| 132 | + |
| 133 | +```bash |
| 134 | +python -m pip install --upgrade pip-tools |
| 135 | +```` |
| 136 | + |
| 137 | +### ➕ Adding / Updating a Package |
| 138 | + |
| 139 | +1. **Edit `requirements.in`** |
| 140 | + |
| 141 | + ```diff |
| 142 | + - sentence-transformers |
| 143 | + + sentence-transformers>=4.1 |
| 144 | + + llama-index |
| 145 | + ``` |
| 146 | +2. **Re-lock** the environment |
| 147 | + |
| 148 | + ```bash |
| 149 | + pip-compile --upgrade |
| 150 | + ``` |
| 151 | +3. **Synchronise** your virtual-env |
| 152 | + |
| 153 | + ```bash |
| 154 | + pip-sync |
| 155 | + ``` |
| 156 | + |
| 157 | +--- |
| 158 | + |
104 | 159 | ## 🗂️ Project Layout |
105 | 160 |
|
106 | 161 | ``` |
|
0 commit comments