nreimers commited on
Commit
6d455fe
1 Parent(s): aba6343

Add new SentenceTransformer model.

Browse files
1_Pooling/config.json ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ {
2
+ "word_embedding_dimension": 768,
3
+ "pooling_mode_cls_token": false,
4
+ "pooling_mode_mean_tokens": true,
5
+ "pooling_mode_max_tokens": false,
6
+ "pooling_mode_mean_sqrt_len_tokens": false
7
+ }
README.md ADDED
@@ -0,0 +1,113 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ pipeline_tag: sentence-similarity
3
+ tags:
4
+ - sentence-transformers
5
+ - feature-extraction
6
+ - sentence-similarity
7
+ - transformers
8
+ - transformers
9
+ - transformers
10
+ - transformers
11
+ - transformers
12
+ - transformers
13
+ - transformers
14
+ - transformers
15
+ ---
16
+
17
+ # sentence-transformers/bert-base-nli-stsb-mean-tokens
18
+
19
+ 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.
20
+
21
+
22
+
23
+ ## Usage (Sentence-Transformers)
24
+
25
+ Using this model becomes easy when you have [sentence-transformers](https://www.SBERT.net) installed:
26
+
27
+ ```
28
+ pip install -U sentence-transformers
29
+ ```
30
+
31
+ Then you can use the model like this:
32
+
33
+ ```python
34
+ from sentence_transformers import SentenceTransformer
35
+ sentences = ["This is an example sentence", "Each sentence is converted"]
36
+
37
+ model = SentenceTransformer('sentence-transformers/bert-base-nli-stsb-mean-tokens')
38
+ embeddings = model.encode(sentences)
39
+ print(embeddings)
40
+ ```
41
+
42
+
43
+
44
+ ## Usage (HuggingFace Transformers)
45
+ Without [sentence-transformers](https://www.SBERT.net), you can use the model like this: First, you pass your input through the transformer model, then you have to apply the right pooling-operation on-top of the contextualized word embeddings.
46
+
47
+ ```python
48
+ from transformers import AutoTokenizer, AutoModel
49
+ import torch
50
+
51
+
52
+ #Mean Pooling - Take attention mask into account for correct averaging
53
+ def mean_pooling(model_output, attention_mask):
54
+ token_embeddings = model_output[0] #First element of model_output contains all token embeddings
55
+ input_mask_expanded = attention_mask.unsqueeze(-1).expand(token_embeddings.size()).float()
56
+ return torch.sum(token_embeddings * input_mask_expanded, 1) / torch.clamp(input_mask_expanded.sum(1), min=1e-9)
57
+
58
+
59
+ # Sentences we want sentence embeddings for
60
+ sentences = ['This is an example sentence', 'Each sentence is converted']
61
+
62
+ # Load model from HuggingFace Hub
63
+ tokenizer = AutoTokenizer.from_pretrained('sentence-transformers/bert-base-nli-stsb-mean-tokens')
64
+ model = AutoModel.from_pretrained('sentence-transformers/bert-base-nli-stsb-mean-tokens')
65
+
66
+ # Tokenize sentences
67
+ encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')
68
+
69
+ # Compute token embeddings
70
+ with torch.no_grad():
71
+ model_output = model(**encoded_input)
72
+
73
+ # Perform pooling. In this case, max pooling.
74
+ sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])
75
+
76
+ print("Sentence embeddings:")
77
+ print(sentence_embeddings)
78
+ ```
79
+
80
+
81
+
82
+ ## Evaluation Results
83
+
84
+
85
+
86
+ For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name=sentence-transformers/bert-base-nli-stsb-mean-tokens)
87
+
88
+
89
+
90
+ ## Full Model Architecture
91
+ ```
92
+ SentenceTransformer(
93
+ (0): Transformer({'max_seq_length': 128, 'do_lower_case': False}) with Transformer model: BertModel
94
+ (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False})
95
+ )
96
+ ```
97
+
98
+ ## Citing & Authors
99
+
100
+ This model was trained by [sentence-transformers](https://www.sbert.net/).
101
+
102
+ If you find this model helpful, feel free to cite our publication [Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks](https://arxiv.org/abs/1908.10084):
103
+ ```bibtex
104
+ @inproceedings{reimers-2019-sentence-bert,
105
+ title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
106
+ author = "Reimers, Nils and Gurevych, Iryna",
107
+ booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
108
+ month = "11",
109
+ year = "2019",
110
+ publisher = "Association for Computational Linguistics",
111
+ url = "http://arxiv.org/abs/1908.10084",
112
+ }
113
+ ```
config.json CHANGED
@@ -1,4 +1,5 @@
1
  {
 
2
  "architectures": [
3
  "BertModel"
4
  ],
@@ -15,6 +16,9 @@
15
  "num_attention_heads": 12,
16
  "num_hidden_layers": 12,
17
  "pad_token_id": 0,
 
 
18
  "type_vocab_size": 2,
 
19
  "vocab_size": 30522
20
- }
 
1
  {
2
+ "_name_or_path": "old_models/bert-base-nli-stsb-mean-tokens/0_BERT",
3
  "architectures": [
4
  "BertModel"
5
  ],
 
16
  "num_attention_heads": 12,
17
  "num_hidden_layers": 12,
18
  "pad_token_id": 0,
19
+ "position_embedding_type": "absolute",
20
+ "transformers_version": "4.7.0",
21
  "type_vocab_size": 2,
22
+ "use_cache": true,
23
  "vocab_size": 30522
24
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "2.0.0",
4
+ "transformers": "4.7.0",
5
+ "pytorch": "1.9.0+cu102"
6
+ }
7
+ }
modules.json ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ [
2
+ {
3
+ "idx": 0,
4
+ "name": "0",
5
+ "path": "",
6
+ "type": "sentence_transformers.models.Transformer"
7
+ },
8
+ {
9
+ "idx": 1,
10
+ "name": "1",
11
+ "path": "1_Pooling",
12
+ "type": "sentence_transformers.models.Pooling"
13
+ }
14
+ ]
pytorch_model.bin CHANGED
@@ -1,3 +1,3 @@
1
  version https://git-lfs.github.com/spec/v1
2
- oid sha256:d3231004174568f6eeb56a85679fb40e308511b8366ef5eec3f5b013f57de1c5
3
- size 438006864
 
1
  version https://git-lfs.github.com/spec/v1
2
+ oid sha256:30d78fa33795c0fb1c53d0b65c70866e44f6965d4d3fb2a07833a7a91e92a9f2
3
+ size 438007537
sentence_bert_config.json CHANGED
@@ -1,3 +1,4 @@
1
  {
2
- "max_seq_length": 128
 
3
  }
 
1
  {
2
+ "max_seq_length": 128,
3
+ "do_lower_case": false
4
  }
tokenizer.json ADDED
The diff for this file is too large to render. See raw diff
 
tokenizer_config.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"do_lower_case": true, "unk_token": "[UNK]", "sep_token": "[SEP]", "pad_token": "[PAD]", "cls_token": "[CLS]", "mask_token": "[MASK]", "tokenize_chinese_chars": true, "strip_accents": null, "special_tokens_map_file": "old_models/bert-base-nli-stsb-mean-tokens/0_BERT/special_tokens_map.json", "name_or_path": "old_models/bert-base-nli-stsb-mean-tokens/0_BERT", "do_basic_tokenize": true, "never_split": null}