Add new SentenceTransformer model.

1_Pooling/config.json

@@ -0,0 +1,7 @@
+{
+  "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
+}

README.md

@@ -1,16 +1,42 @@
 ---
+pipeline_tag: sentence-similarity
 tags:
 - sentence-transformers
 - feature-extraction
+- sentence-similarity
+- transformers
 ---
-# Sentence Embeddings Models trained on Paraphrases
-This model is from the [sentence-transformers](https://github.com/UKPLab/sentence-transformers)-repository. It was trained on millions of paraphrase sentences. Further details on SBERT can be found in the paper:  [Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks](https://arxiv.org/abs/1908.10084)
 
-This model is the multilingual version of distilroberta-base-paraphrase-v1, trained on parallel data for 50+ languages.
+# sentence-transformers/paraphrase-xlm-r-multilingual-v1
 
-## Usage (HuggingFace Models Repository)
+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.
+
+
+
+## Usage (Sentence-Transformers)
+
+Using this model becomes easy when you have [sentence-transformers](https://www.SBERT.net) installed:
+
+```
+pip install -U sentence-transformers
+```
+
+Then you can use the model like this:
+
+```python
+from sentence_transformers import SentenceTransformer
+sentences = ["This is an example sentence", "Each sentence is converted"]
+
+model = SentenceTransformer('sentence-transformers/paraphrase-xlm-r-multilingual-v1')
+embeddings = model.encode(sentences)
+print(embeddings)
+```
+
+
+
+## Usage (HuggingFace Transformers)
+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.
 
-You can use the model directly from the model repository to compute sentence embeddings:
 ```python
 from transformers import AutoTokenizer, AutoModel
 import torch
@@ -20,62 +46,61 @@ import torch
 def mean_pooling(model_output, attention_mask):
     token_embeddings = model_output[0] #First element of model_output contains all token embeddings
     input_mask_expanded = attention_mask.unsqueeze(-1).expand(token_embeddings.size()).float()
-    sum_embeddings = torch.sum(token_embeddings * input_mask_expanded, 1)
-    sum_mask = torch.clamp(input_mask_expanded.sum(1), min=1e-9)
-    return sum_embeddings / sum_mask
+    return torch.sum(token_embeddings * input_mask_expanded, 1) / torch.clamp(input_mask_expanded.sum(1), min=1e-9)
 
 
+# Sentences we want sentence embeddings for
+sentences = ['This is an example sentence', 'Each sentence is converted']
 
-#Sentences we want sentence embeddings for
-sentences = ['This framework generates embeddings for each input sentence',
-             'Sentences are passed as a list of string.',
-             'The quick brown fox jumps over the lazy dog.']
+# Load model from HuggingFace Hub
+tokenizer = AutoTokenizer.from_pretrained('sentence-transformers/paraphrase-xlm-r-multilingual-v1')
+model = AutoModel.from_pretrained('sentence-transformers/paraphrase-xlm-r-multilingual-v1')
 
-#Load AutoModel from huggingface model repository
-tokenizer = AutoTokenizer.from_pretrained("model_name")
-model = AutoModel.from_pretrained("model_name")
+# Tokenize sentences
+encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')
 
-#Tokenize sentences
-encoded_input = tokenizer(sentences, padding=True, truncation=True, max_length=128, return_tensors='pt')
-
-#Compute token embeddings
+# Compute token embeddings
 with torch.no_grad():
     model_output = model(**encoded_input)
 
-#Perform pooling. In this case, mean pooling
+# Perform pooling. In this case, max pooling.
 sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])
-```
-
-## Usage (Sentence-Transformers)
-Using this model becomes more convenient when you have [sentence-transformers](https://github.com/UKPLab/sentence-transformers) installed:
-```
-pip install -U sentence-transformers
-```
-
-Then you can use the model like this:
-```python
-from sentence_transformers import SentenceTransformer
-model = SentenceTransformer('model_name')
-sentences = ['This framework generates embeddings for each input sentence',
-    'Sentences are passed as a list of string.', 
-    'The quick brown fox jumps over the lazy dog.']
-sentence_embeddings = model.encode(sentences)
 
 print("Sentence embeddings:")
 print(sentence_embeddings)
 ```
 
 
+
+## Evaluation Results
+
+
+
+For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name=sentence-transformers/paraphrase-xlm-r-multilingual-v1)
+
+
+
+## Full Model Architecture
+```
+SentenceTransformer(
+  (0): Transformer({'max_seq_length': 128, 'do_lower_case': False}) with Transformer model: XLMRobertaModel 
+  (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})
+)
+```
+
 ## Citing & Authors
-If you find this model helpful, feel free to cite our publication [Making Monolingual Sentence Embeddings Multilingual using Knowledge Distillation](https://arxiv.org/abs/2004.09813):
-``` 
-@inproceedings{reimers-2020-multilingual-sentence-bert,
-    title = "Making Monolingual Sentence Embeddings Multilingual using Knowledge Distillation",
+
+This model was trained by [sentence-transformers](https://www.sbert.net/). 
+        
+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):
+```bibtex 
+@inproceedings{reimers-2019-sentence-bert,
+    title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
     author = "Reimers, Nils and Gurevych, Iryna",
-    booktitle = "Proceedings of the 2020 Conference on Empirical Methods in Natural Language Processing",
+    booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
     month = "11",
-    year = "2020",
+    year = "2019",
     publisher = "Association for Computational Linguistics",
-    url = "https://arxiv.org/abs/2004.09813",
+    url = "http://arxiv.org/abs/1908.10084",
 }
 ```

config.json

@@ -1,4 +1,5 @@
 {
+  "_name_or_path": "old_models/paraphrase-xlm-r-multilingual-v1/0_Transformer",
   "architectures": [
     "XLMRobertaModel"
   ],
@@ -18,6 +19,9 @@
   "num_hidden_layers": 12,
   "output_past": true,
   "pad_token_id": 1,
+  "position_embedding_type": "absolute",
+  "transformers_version": "4.7.0",
   "type_vocab_size": 1,
+  "use_cache": true,
   "vocab_size": 250002
 }

config_sentence_transformers.json

@@ -0,0 +1,7 @@
+{
+  "__version__": {
+    "sentence_transformers": "2.0.0",
+    "transformers": "4.7.0",
+    "pytorch": "1.9.0+cu102"
+  }
+}

modules.json

@@ -0,0 +1,14 @@
+[
+  {
+    "idx": 0,
+    "name": "0",
+    "path": "",
+    "type": "sentence_transformers.models.Transformer"
+  },
+  {
+    "idx": 1,
+    "name": "1",
+    "path": "1_Pooling",
+    "type": "sentence_transformers.models.Pooling"
+  }
+]

pytorch_model.bin

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:1a0145d0622caa7b0cb061f69ae55b3faa1afd35cdb0a348cfd6b7a0212da40f
-size 1112256686
+oid sha256:224f40dde228eb17d15e7d26caa90f35806def427cd2e48e6f892fb62d64c6fb
+size 1112253233

sentence_bert_config.json

@@ -1,3 +1,4 @@
 {
-  "max_seq_length": 128
+  "max_seq_length": 128,
+  "do_lower_case": false
 }

tokenizer_config.json

@@ -1 +1 @@
-{"model_max_length": 512, "special_tokens_map_file": "input_models/johngiorgi-declutr-small-all-paraphrase-multilingual/0_Transformer/special_tokens_map.json", "full_tokenizer_file": null}
+{"bos_token": "<s>", "eos_token": "</s>", "sep_token": "</s>", "cls_token": "<s>", "unk_token": "<unk>", "pad_token": "<pad>", "mask_token": {"content": "<mask>", "single_word": false, "lstrip": true, "rstrip": false, "normalized": true, "__type": "AddedToken"}, "model_max_length": 512, "special_tokens_map_file": "input_models/johngiorgi-declutr-small-all-paraphrase-multilingual/0_Transformer/special_tokens_map.json", "full_tokenizer_file": null, "name_or_path": "old_models/paraphrase-xlm-r-multilingual-v1/0_Transformer", "sp_model_kwargs": {}}