Expand code snippet for easier use

#1
by tomaarsen HF Staff - opened
Files changed (1) hide show
  1. README.md +10 -5
README.md CHANGED
@@ -23,11 +23,16 @@ with [R3-Rerank-0.6B](https://huggingface.co/tencent/R3-rerank-0.6b) for reranki
23
  ```python
24
  from sentence_transformers import SentenceTransformer
25
 
26
- model = SentenceTransformer("tencent/R3-embedding-0.6b", trust_remote_code=True)
27
- qv = model.encode(
28
- ["Instruct: Given a user request, retrieve the agent skill that solves it.\nQuery: I need to compose music"],
29
- normalize_embeddings=True,
30
- )
 
 
 
 
 
31
  ```
32
 
33
  ## Citation
 
23
  ```python
24
  from sentence_transformers import SentenceTransformer
25
 
26
+ model = SentenceTransformer("tencent/R3-embedding-0.6b")
27
+ query_embedding = model.encode_query("I need to compose music")
28
+ document_embeddings = model.encode_document([ # The format is "name | description | skill_md"
29
+ "music-composer | Composes original music | Creates music for various media formats ...",
30
+ "music-lyricist | Writes lyrics for songs | Creates lyrics for various music genres ...",
31
+ "music-editor | Edits and mixes music tracks | Provides audio editing and mixing services ...",
32
+ ])
33
+ similarities = model.similarity(query_embedding, document_embeddings)
34
+ print(similarities)
35
+ # tensor([[0.7410, 0.5510, 0.5028]])
36
  ```
37
 
38
  ## Citation