Sentence Similarity
sentence-transformers
PyTorch
Transformers
English
t5
text-embedding
embeddings
information-retrieval
beir
text-classification
language-model
text-clustering
text-semantic-similarity
text-evaluation
prompt-retrieval
text-reranking
feature-extraction
English
Sentence Similarity
natural_questions
ms_marco
fever
hotpot_qa
mteb
Eval Results
text-generation-inference
Commit
·
6bbadc0
1
Parent(s):
88f06d6
Update README.md
Browse files
README.md
CHANGED
|
@@ -13,7 +13,9 @@ tags:
|
|
| 13 |
We introduce **Instructor**👨🏫, an instruction-finetuned text embedding model that can generate text embeddings tailored to any task (e.g., classification, retrieval, clustering, text evaluation, etc.) and domains (e.g., science, finance, etc.) ***by simply providing the task instruction, without any finetuning***. Instructor👨 achieves sota on 70 diverse embedding tasks!
|
| 14 |
The model is easy to use with `sentence-transformer` library.
|
| 15 |
|
| 16 |
-
|
|
|
|
|
|
|
| 17 |
## Installation
|
| 18 |
```bash
|
| 19 |
git clone https://github.com/HKUNLP/instructor-embedding
|
|
@@ -32,8 +34,9 @@ embeddings = model.encode([[instruction,sentence,0]])
|
|
| 32 |
print(embeddings)
|
| 33 |
```
|
| 34 |
|
| 35 |
-
|
| 36 |
-
|
|
|
|
| 37 |
## Calculate embeddings for your customized texts
|
| 38 |
If you want to calculate customized embeddings for specific sentences, you may follow the unified template to write instructions:
|
| 39 |
|
|
|
|
| 13 |
We introduce **Instructor**👨🏫, an instruction-finetuned text embedding model that can generate text embeddings tailored to any task (e.g., classification, retrieval, clustering, text evaluation, etc.) and domains (e.g., science, finance, etc.) ***by simply providing the task instruction, without any finetuning***. Instructor👨 achieves sota on 70 diverse embedding tasks!
|
| 14 |
The model is easy to use with `sentence-transformer` library.
|
| 15 |
|
| 16 |
+
## Quick start
|
| 17 |
+
<hr />
|
| 18 |
+
|
| 19 |
## Installation
|
| 20 |
```bash
|
| 21 |
git clone https://github.com/HKUNLP/instructor-embedding
|
|
|
|
| 34 |
print(embeddings)
|
| 35 |
```
|
| 36 |
|
| 37 |
+
## Use cases
|
| 38 |
+
<hr />
|
| 39 |
+
|
| 40 |
## Calculate embeddings for your customized texts
|
| 41 |
If you want to calculate customized embeddings for specific sentences, you may follow the unified template to write instructions:
|
| 42 |
|