Update README.md

README.md

@@ -8,14 +8,21 @@ tags:
 
 ---
 
-# {MODEL_NAME}
+# bowdpr_marco_ft
+
+This is a fine-tuned retriever on the MS-MARCO Passage Ranking Task (without distillation). We introduce a novel pre-training paradigm, Bag-of-Word Prediction, for dense retrieval. Please refer to our [paper](https://arxiv.org/abs/2401.11248) for detailed pre-training and fine-tuning settings. 
+
+Finetuning on MS-MARCO dataset involves a two-stage pipeline
+ - s1: BM25 negs
+ - s2: Mined negatives from s1
 
-This is a [sentence-transformers](https://www.SBERT.net) model: It maps sentences & paragraphs to a 768 dimensional dense vector space and can be used for tasks like clustering or semantic search.
 
 <!--- Describe your model here -->
 
 ## Usage (Sentence-Transformers)
 
+This is a [sentence-transformers](https://www.SBERT.net) model: It maps sentences & paragraphs to a 768 dimensional dense vector space and can be used for tasks like clustering or semantic search.
+
 Using this model becomes easy when you have [sentence-transformers](https://www.SBERT.net) installed:
 
 ```
@@ -28,7 +35,7 @@ Then you can use the model like this:
 from sentence_transformers import SentenceTransformer
 sentences = ["This is an example sentence", "Each sentence is converted"]
 
-model = SentenceTransformer('{MODEL_NAME}')
+model = SentenceTransformer('bowdpr/bowdpr_marco_ft')
 embeddings = model.encode(sentences)
 print(embeddings)
 ```
@@ -51,8 +58,8 @@ def cls_pooling(model_output, attention_mask):
 sentences = ['This is an example sentence', 'Each sentence is converted']
 
 # Load model from HuggingFace Hub
-tokenizer = AutoTokenizer.from_pretrained('{MODEL_NAME}')
-model = AutoModel.from_pretrained('{MODEL_NAME}')
+tokenizer = AutoTokenizer.from_pretrained('bowdpr/bowdpr_marco_ft')
+model = AutoModel.from_pretrained('bowdpr/bowdpr_marco_ft')
 
 # Tokenize sentences
 encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')
@@ -69,15 +76,6 @@ print(sentence_embeddings)
 ```
 
 
-
-## Evaluation Results
-
-<!--- Describe how your model was evaluated -->
-
-For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name={MODEL_NAME})
-
-
-
 ## Full Model Architecture
 ```
 SentenceTransformerforCL(