lmhdii commited on
Commit
9c9e52e
·
1 Parent(s): 4b8ad38

docs: clarify retriever.py usage

Browse files
Files changed (1) hide show
  1. src/retriever.py +8 -0
src/retriever.py CHANGED
@@ -1,6 +1,14 @@
1
  """
2
  Simple FAISS retriever for document search.
3
  Wraps FAISS vectorstore with a clean interface.
 
 
 
 
 
 
 
 
4
  """
5
 
6
  import os
 
1
  """
2
  Simple FAISS retriever for document search.
3
  Wraps FAISS vectorstore with a clean interface.
4
+
5
+ NOTE: This module is primarily used for CLI testing and debugging.
6
+ The main application (app.py) uses FAISS directly via LangChain's
7
+ RetrievalQA chain. This separation allows testing the retrieval
8
+ component independently without launching the full Gradio UI.
9
+
10
+ Usage:
11
+ python src/retriever.py # Interactive CLI search
12
  """
13
 
14
  import os