Xlordo commited on
Commit
461dfcb
Β·
verified Β·
1 Parent(s): bf736ad

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -9
README.md CHANGED
@@ -4,12 +4,12 @@ emoji: πŸ”
4
  colorFrom: blue
5
  colorTo: green
6
  sdk: gradio
7
- sdk_version: 5.44.1
8
  app_file: app.py
9
  pinned: false
10
  ---
11
 
12
- # SBERT + FAISS Semantic Search
13
 
14
  This Hugging Face Space hosts a **semantic search system** built with:
15
 
@@ -22,7 +22,7 @@ This Hugging Face Space hosts a **semantic search system** built with:
22
 
23
  ## πŸ”Ή Features
24
  - Enter a **query** to retrieve the **Top-10 most similar passages**.
25
- - Optionally provide **ground truth relevant passages** (one per line) to compute **IR metrics**:
26
  - Precision@10
27
  - Recall@10
28
  - F1-score
@@ -33,11 +33,10 @@ This Hugging Face Space hosts a **semantic search system** built with:
33
 
34
  ## πŸ”Ή How to Use
35
  1. Type a query into the input box.
36
- 2. (Optional) Paste one or more relevant passages into the second box, each on a new line.
37
- 3. Press **Submit**.
38
- 4. View:
39
- - **Top-10 retrieved passages** with FAISS similarity scores
40
- - **Evaluation metrics** if ground truth passages were provided
41
 
42
  ---
43
 
@@ -58,4 +57,4 @@ If you use this system in research, please cite:
58
  ---
59
 
60
  ## πŸ”Ή Author
61
- Built for a research project on **user-centered evaluation of semantic search systems**.
 
4
  colorFrom: blue
5
  colorTo: green
6
  sdk: gradio
7
+ sdk_version: "4.31.5"
8
  app_file: app.py
9
  pinned: false
10
  ---
11
 
12
+ # SBERT + FAISS Semantic Search + Evaluation Metrics
13
 
14
  This Hugging Face Space hosts a **semantic search system** built with:
15
 
 
22
 
23
  ## πŸ”Ή Features
24
  - Enter a **query** to retrieve the **Top-10 most similar passages**.
25
+ - Computes **true IR metrics** when the query matches one in MS MARCO validation set:
26
  - Precision@10
27
  - Recall@10
28
  - F1-score
 
33
 
34
  ## πŸ”Ή How to Use
35
  1. Type a query into the input box.
36
+ 2. Press **Submit**.
37
+ 3. View:
38
+ - **Top-10 retrieved passages** with similarity scores
39
+ - **Evaluation metrics** if the query exists in the validation set
 
40
 
41
  ---
42
 
 
57
  ---
58
 
59
  ## πŸ”Ή Author
60
+ Built for a research project on **user-centered evaluation of semantic search systems**.