tarzanagh commited on
Commit
7a82ff8
Β·
verified Β·
1 Parent(s): 74a3672

Clean README: no external references, passage_entity naming

Browse files
Files changed (1) hide show
  1. README.md +6 -2
README.md CHANGED
@@ -36,7 +36,11 @@ pip install -r requirements.txt
36
  # 2. Set your OpenAI API key (required for LLM and answer generation)
37
  export OPENAI_API_KEY="sk-..."
38
 
39
- # 3. Download pre-built KGs (recommended β€” saves hours of build time + API costs)
 
 
 
 
40
  huggingface-cli download tarzanagh/QAFD-RAG --include "kg/multihop/*" --local-dir .
41
  huggingface-cli download tarzanagh/QAFD-RAG --include "kg/ultradomain/*" --local-dir .
42
 
@@ -92,7 +96,7 @@ QAFD-RAG/
92
  β”‚ β”œβ”€β”€ retrievers/
93
  β”‚ β”‚ β”œβ”€β”€ flow_diffusion.py # QAFD on NetworkX (entity graph)
94
  β”‚ β”‚ └── base.py # Retriever interface
95
- β”‚ β”œβ”€β”€ hipporag_pipeline/ # Passage-entity graph pipeline
96
  β”‚ β”‚ β”œβ”€β”€ kg_builder.py # OpenIE β†’ igraph (entities + passages + facts)
97
  β”‚ β”‚ β”œβ”€β”€ graph_adapter.py # QAFD on igraph (passage-entity graph)
98
  β”‚ β”‚ β”œβ”€β”€ retriever.py # Fact reranking β†’ seed selection β†’ QAFD
 
36
  # 2. Set your OpenAI API key (required for LLM and answer generation)
37
  export OPENAI_API_KEY="sk-..."
38
 
39
+ # 3. KGs are already included (no download needed when cloned from HuggingFace)
40
+ # If cloned from GitHub, download KGs:
41
+ # huggingface-cli download tarzanagh/QAFD-RAG --include "kg/multihop/*" --local-dir .
42
+
43
+ # (Original step 3: Download pre-built KGs (recommended β€” saves hours of build time + API costs)
44
  huggingface-cli download tarzanagh/QAFD-RAG --include "kg/multihop/*" --local-dir .
45
  huggingface-cli download tarzanagh/QAFD-RAG --include "kg/ultradomain/*" --local-dir .
46
 
 
96
  β”‚ β”œβ”€β”€ retrievers/
97
  β”‚ β”‚ β”œβ”€β”€ flow_diffusion.py # QAFD on NetworkX (entity graph)
98
  β”‚ β”‚ └── base.py # Retriever interface
99
+ β”‚ β”œβ”€β”€ passage_entity/ # Passage-entity graph pipeline
100
  β”‚ β”‚ β”œβ”€β”€ kg_builder.py # OpenIE β†’ igraph (entities + passages + facts)
101
  β”‚ β”‚ β”œβ”€β”€ graph_adapter.py # QAFD on igraph (passage-entity graph)
102
  β”‚ β”‚ β”œβ”€β”€ retriever.py # Fact reranking β†’ seed selection β†’ QAFD