Spaces:
Sleeping
Sleeping
File size: 12,548 Bytes
1d1d310 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 |
"""
Build FAISS Index from Scratch
Creates faiss_index.pkl from your knowledge base and trained retriever model
Run this ONCE before starting the backend:
python build_faiss_index.py
Author: Banking RAG Chatbot
Date: October 2025
"""
# Add these lines at the very top (after docstring)
import os
os.environ['TF_CPP_MIN_LOG_LEVEL'] = '2' # Suppress TensorFlow info/warnings
os.environ['TF_ENABLE_ONEDNN_OPTS'] = '0' # Disable oneDNN messages
import warnings
warnings.filterwarnings('ignore') # Suppress all warnings
import os
import pickle
import json
import torch
import torch.nn as nn
import torch.nn.functional as F
import faiss
import numpy as np
from pathlib import Path
from transformers import AutoTokenizer, AutoModel
from typing import List
# ============================================================================
# CONFIGURATION - UPDATE THESE PATHS!
# ============================================================================
# Where is your knowledge base JSONL file?
KB_JSONL_FILE = "data/final_knowledge_base.jsonl"
# Where is your trained retriever model?
RETRIEVER_MODEL_PATH = "app/models/best_retriever_model.pth"
# Where to save the output FAISS pickle?
OUTPUT_PKL_FILE = "app/models/faiss_index.pkl"
# Device (auto-detect GPU/CPU)
DEVICE = "cuda" if torch.cuda.is_available() else "cpu"
# Batch size for encoding (reduce if you get OOM errors)
BATCH_SIZE = 32
# ============================================================================
# CUSTOM SENTENCE TRANSFORMER (Same as retriever.py)
# ============================================================================
class CustomSentenceTransformer(nn.Module):
"""
Custom SentenceTransformer - exact copy from retriever.py
Uses e5-base-v2 with mean pooling and L2 normalization
"""
def __init__(self, model_name: str = "intfloat/e5-base-v2"):
super().__init__()
print(f" Loading base model: {model_name}...")
self.encoder = AutoModel.from_pretrained(model_name)
self.tokenizer = AutoTokenizer.from_pretrained(model_name)
self.config = self.encoder.config
print(f" โ
Base model loaded")
def forward(self, input_ids, attention_mask):
"""Forward pass through BERT encoder"""
outputs = self.encoder(input_ids=input_ids, attention_mask=attention_mask)
# Mean pooling
token_embeddings = outputs.last_hidden_state
input_mask_expanded = attention_mask.unsqueeze(-1).expand(token_embeddings.size()).float()
embeddings = torch.sum(token_embeddings * input_mask_expanded, 1) / torch.clamp(
input_mask_expanded.sum(1), min=1e-9
)
# L2 normalize
embeddings = F.normalize(embeddings, p=2, dim=1)
return embeddings
def encode(self, sentences: List[str], batch_size: int = 32) -> np.ndarray:
"""Encode sentences - same as training"""
self.eval()
if isinstance(sentences, str):
sentences = [sentences]
# Add 'query: ' prefix for e5-base-v2
processed_sentences = [f"query: {s.strip()}" for s in sentences]
all_embeddings = []
with torch.no_grad():
for i in range(0, len(processed_sentences), batch_size):
batch_sentences = processed_sentences[i:i + batch_size]
# Tokenize
tokens = self.tokenizer(
batch_sentences,
truncation=True,
padding=True,
max_length=128,
return_tensors='pt'
).to(self.encoder.device)
# Get embeddings
embeddings = self.forward(tokens['input_ids'], tokens['attention_mask'])
all_embeddings.append(embeddings.cpu().numpy())
return np.vstack(all_embeddings)
# ============================================================================
# RETRIEVER MODEL (Wrapper)
# ============================================================================
class RetrieverModel:
"""Wrapper for trained retriever model"""
def __init__(self, model_path: str, device: str = "cpu"):
print(f"\n๐ค Loading retriever model...")
print(f" Device: {device}")
self.device = device
self.model = CustomSentenceTransformer("intfloat/e5-base-v2").to(device)
# Load trained weights
print(f" Loading weights from: {model_path}")
try:
state_dict = torch.load(model_path, map_location=device)
self.model.load_state_dict(state_dict)
print(f" โ
Trained weights loaded")
except Exception as e:
print(f" โ ๏ธ Warning: Could not load trained weights: {e}")
print(f" Using base e5-base-v2 model instead")
self.model.eval()
def encode_documents(self, documents: List[str], batch_size: int = 32) -> np.ndarray:
"""Encode documents"""
return self.model.encode(documents, batch_size=batch_size)
# ============================================================================
# MAIN: BUILD FAISS INDEX
# ============================================================================
def build_faiss_index():
"""Main function to build FAISS index from scratch"""
print("=" * 80)
print("๐๏ธ BUILDING FAISS INDEX FROM SCRATCH")
print("=" * 80)
# ========================================================================
# STEP 1: LOAD KNOWLEDGE BASE
# ========================================================================
print(f"\n๐ STEP 1: Loading knowledge base...")
print(f" File: {KB_JSONL_FILE}")
if not os.path.exists(KB_JSONL_FILE):
print(f" โ ERROR: File not found!")
print(f" Please copy your knowledge base to: {KB_JSONL_FILE}")
return False
kb_data = []
with open(KB_JSONL_FILE, 'r', encoding='utf-8') as f:
for line_num, line in enumerate(f, 1):
try:
kb_data.append(json.loads(line))
except json.JSONDecodeError as e:
print(f" โ ๏ธ Warning: Skipping invalid JSON on line {line_num}: {e}")
print(f" โ
Loaded {len(kb_data)} documents")
if len(kb_data) == 0:
print(f" โ ERROR: Knowledge base is empty!")
return False
# ========================================================================
# STEP 2: PREPARE DOCUMENTS FOR ENCODING
# ========================================================================
print(f"\n๐ STEP 2: Preparing documents for encoding...")
documents = []
for i, item in enumerate(kb_data):
# Combine instruction + response for embedding (same as training)
instruction = item.get('instruction', '')
response = item.get('response', '')
# Create combined text
if instruction and response:
text = f"{instruction} {response}"
elif instruction:
text = instruction
elif response:
text = response
else:
print(f" โ ๏ธ Warning: Document {i} has no content, using placeholder")
text = "empty document"
documents.append(text)
print(f" โ
Prepared {len(documents)} documents for encoding")
print(f" Average length: {sum(len(d) for d in documents) / len(documents):.1f} chars")
# ========================================================================
# STEP 3: LOAD RETRIEVER AND ENCODE DOCUMENTS
# ========================================================================
print(f"\n๐ฎ STEP 3: Encoding documents with trained retriever...")
if not os.path.exists(RETRIEVER_MODEL_PATH):
print(f" โ ERROR: Retriever model not found!")
print(f" Please copy your trained model to: {RETRIEVER_MODEL_PATH}")
return False
# Load retriever
retriever = RetrieverModel(RETRIEVER_MODEL_PATH, device=DEVICE)
# Encode all documents
print(f" Encoding {len(documents)} documents...")
print(f" Batch size: {BATCH_SIZE}")
print(f" This may take a few minutes... โ")
try:
embeddings = retriever.encode_documents(documents, batch_size=BATCH_SIZE)
print(f" โ
Encoded {embeddings.shape[0]} documents")
print(f" Embedding dimension: {embeddings.shape[1]}")
except Exception as e:
print(f" โ ERROR during encoding: {e}")
import traceback
traceback.print_exc()
return False
# ========================================================================
# STEP 4: BUILD FAISS INDEX
# ========================================================================
print(f"\n๐ STEP 4: Building FAISS index...")
dimension = embeddings.shape[1]
print(f" Dimension: {dimension}")
# Create FAISS index (Inner Product = Cosine similarity after normalization)
index = faiss.IndexFlatIP(dimension)
# Normalize embeddings for cosine similarity
print(f" Normalizing embeddings...")
faiss.normalize_L2(embeddings)
# Add to index
print(f" Adding {embeddings.shape[0]} vectors to FAISS index...")
index.add(embeddings.astype('float32'))
print(f" โ
FAISS index built successfully")
print(f" Total vectors: {index.ntotal}")
# ========================================================================
# STEP 5: SAVE AS PICKLE FILE
# ========================================================================
print(f"\n๐พ STEP 5: Saving as pickle file...")
# Create models directory if it doesn't exist
os.makedirs(os.path.dirname(OUTPUT_PKL_FILE), exist_ok=True)
# Save tuple of (index, kb_data)
print(f" Pickling (index, kb_data) tuple...")
try:
with open(OUTPUT_PKL_FILE, 'wb') as f:
pickle.dump((index, kb_data), f)
file_size_mb = Path(OUTPUT_PKL_FILE).stat().st_size / (1024 * 1024)
print(f" โ
Saved: {OUTPUT_PKL_FILE}")
print(f" File size: {file_size_mb:.2f} MB")
except Exception as e:
print(f" โ ERROR saving pickle: {e}")
return False
# ========================================================================
# STEP 6: VERIFY SAVED FILE
# ========================================================================
print(f"\nโ
STEP 6: Verifying saved file...")
try:
with open(OUTPUT_PKL_FILE, 'rb') as f:
loaded_index, loaded_kb = pickle.load(f)
print(f" โ
Verification successful")
print(f" Index vectors: {loaded_index.ntotal}")
print(f" KB documents: {len(loaded_kb)}")
if loaded_index.ntotal != len(loaded_kb):
print(f" โ ๏ธ WARNING: Size mismatch detected!")
except Exception as e:
print(f" โ ERROR verifying file: {e}")
return False
# ========================================================================
# SUCCESS!
# ========================================================================
print("\n" + "=" * 80)
print("๐ SUCCESS! FAISS INDEX BUILT AND SAVED")
print("=" * 80)
print(f"\n๐ Summary:")
print(f" Documents: {len(kb_data)}")
print(f" Vectors: {index.ntotal}")
print(f" Dimension: {dimension}")
print(f" File: {OUTPUT_PKL_FILE} ({file_size_mb:.2f} MB)")
print(f"\n๐ You can now start the backend:")
print(f" cd backend")
print(f" uvicorn app.main:app --reload")
print("=" * 80 + "\n")
return True
# ============================================================================
# RUN SCRIPT
# ============================================================================
if __name__ == "__main__":
success = build_faiss_index()
if not success:
print("\n" + "=" * 80)
print("โ FAILED TO BUILD FAISS INDEX")
print("=" * 80)
print("\nPlease check:")
print("1. Knowledge base file exists: data/final_knowledge_base.jsonl")
print("2. Retriever model exists: models/best_retriever_model.pth")
print("3. You have enough RAM (embeddings need ~1GB for 10k docs)")
print("=" * 80 + "\n")
exit(1)
|