SpirinEgor bulatovv commited on
Commit
e844647
1 Parent(s): 65d4316

Изменить README.md согласно новому конфигу (#1)

Browse files

- Update README.md (0e0d7c47ff286dab7005a665f9bb934e3d31a2bf)


Co-authored-by: Albert Fazlyev <[email protected]>

Files changed (1) hide show
  1. README.md +12 -9
README.md CHANGED
@@ -46,17 +46,20 @@ Then you can use the model like this:
46
  ```python
47
  from sentence_transformers import SentenceTransformer
48
 
49
- # Each input text should start with "query: " or "passage: ".
50
- # For tasks other than retrieval, you can simply use the "query: " prefix.
51
- input_texts = [
52
- "query: Когда был спущен на воду первый миноносец «Спокойный»?",
53
- "query: Есть ли нефть в Удмуртии?",
54
- "passage: Спокойный (эсминец)\nЗачислен в списки ВМФ СССР 19 августа 1952 года.",
55
- "passage: Нефтепоисковые работы в Удмуртии были начаты сразу после Второй мировой войны в 1945 году и продолжаются по сей день. Добыча нефти началась в 1967 году."
56
  ]
57
 
58
  model = SentenceTransformer("deepvk/USER-base")
59
- embeddings = model.encode(input_texts, normalize_embeddings=True)
 
 
 
60
  ```
61
 
62
  However, you can use model directly with [`transformers`](https://huggingface.co/docs/transformers/en/index)
@@ -75,7 +78,7 @@ def average_pool(
75
  )
76
  return last_hidden.sum(dim=1) / attention_mask.sum(dim=1)[..., None]
77
 
78
- # Each input text should start with "query: " or "passage: ".
79
  # For tasks other than retrieval, you can simply use the "query: " prefix.
80
  input_texts = [
81
  "query: Когда был спущен на воду первый миноносец «Спокойный»?",
 
46
  ```python
47
  from sentence_transformers import SentenceTransformer
48
 
49
+ queries = [
50
+ "Когда был спущен на воду первый миноносец «Спокойный»?",
51
+ "Есть ли нефть в Удмуртии?"
52
+ ]
53
+ passages = [
54
+ "Спокойный (эсминец)\nЗачислен в списки ВМФ СССР 19 августа 1952 года.",
55
+ "Нефтепоисковые работы в Удмуртии были начаты сразу после Второй мировой войны в 1945 году и продолжаются по сей день. Добыча нефти началась в 1967 году."
56
  ]
57
 
58
  model = SentenceTransformer("deepvk/USER-base")
59
+ # Prompt should be specified according to the task (either 'query' or 'passage').
60
+ passage_embeddings = model.encode(passages, normalize_embeddings=True, prompt_name='passage')
61
+ # For tasks other than retrieval, you can simply use the `query` prompt, which is set by default.
62
+ query_embeddings = model.encode(queries, normalize_embeddings=True)
63
  ```
64
 
65
  However, you can use model directly with [`transformers`](https://huggingface.co/docs/transformers/en/index)
 
78
  )
79
  return last_hidden.sum(dim=1) / attention_mask.sum(dim=1)[..., None]
80
 
81
+ # You should manually add prompts when using the model directly. Each input text should start with "query: " or "passage: ".
82
  # For tasks other than retrieval, you can simply use the "query: " prefix.
83
  input_texts = [
84
  "query: Когда был спущен на воду первый миноносец «Спокойный»?",