Geralt-Targaryen commited on
Commit
1284bb8
·
verified ·
1 Parent(s): 9f39efe

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +16 -0
README.md CHANGED
@@ -183,6 +183,22 @@ print(similarity)
183
  # dtype=torch.bfloat16, grad_fn=<MmBackward0>)
184
  ```
185
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
186
  ## Intermediate Checkpoints
187
 
188
  To facilitate future research, we release intermediate checkpoints in the `intermediate_checkpoints` branch.
 
183
  # dtype=torch.bfloat16, grad_fn=<MmBackward0>)
184
  ```
185
 
186
+ ### Prompts
187
+
188
+ The model supports custom instructions in the following format:
189
+
190
+ ```text
191
+ Instruct: your_instruction
192
+ Query:
193
+ ```
194
+
195
+ In general, for retrieval and reranking tasks:
196
+
197
+ - use the prompt for queries
198
+ - do not prepend the prompt to documents/passages
199
+
200
+ For symmetric tasks such as STS, clustering, and bitext mining, you can encode the documents either with or without prompts. The model is trained to support both scenarios.
201
+
202
  ## Intermediate Checkpoints
203
 
204
  To facilitate future research, we release intermediate checkpoints in the `intermediate_checkpoints` branch.