Update README.md

louislefevre · Mar 27, 2021 · d448998 · d448998
1 parent f70fa83
commit d448998
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -27,3 +27,15 @@ The program can be initialised by running *start.py*, which accepts parameters i
 - The `-p` parameter is optional and generates a PNG file which displays term frequencies in graph 
   format.
 - By default, this file will be saved to the local directory as *term-frequencies.png*.
+
+### Examples
+#### BM25 Model
+`start.py dataset/candidate_passages_top1000.tsv bm25`  
+
+#### Vector Space Model
+`start.py dataset/candidate_passages_top1000.tsv vs`  
+
+#### Query Likehood Model
+`start.py dataset/candidate_passages_top1000.tsv lm -s laplace`  
+`start.py dataset/candidate_passages_top1000.tsv lm -s lidstone`  
+`start.py dataset/candidate_passages_top1000.tsv lm -s dirichlet`