Add new SentenceTransformer model.

1_Pooling/config.json

@@ -0,0 +1,7 @@
+{
+  "word_embedding_dimension": 384,
+  "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,24 +1,42 @@
-# Sentence Embedding Model for MS MARCO Passage Retrieval
+---
+pipeline_tag: sentence-similarity
+tags:
+- sentence-transformers
+- feature-extraction
+- sentence-similarity
+- transformers
+---
 
+# sentence-transformers/msmarco-MiniLM-L-12-v3
 
-This a `distilroberta-base` model from the [sentence-transformers](https://github.com/UKPLab/sentence-transformers)-repository. It was trained on the [MS MARCO Passage Retrieval dataset](https://github.com/microsoft/MSMARCO-Passage-Ranking): Given a search query, it finds the relevant passages.
+This is a [sentence-transformers](https://www.SBERT.net) model: It maps sentences & paragraphs to a 384 dimensional dense vector space and can be used for tasks like clustering or semantic search.
 
-You can use this model for semantic search. Details can be found on: [SBERT.net - Semantic Search](https://www.sbert.net/examples/applications/semantic-search/README.html).
 
-This model was optimized to be used with **cosine-similarity** as similarity function between queries and documents.
 
+## Usage (Sentence-Transformers)
+
+Using this model becomes easy when you have [sentence-transformers](https://www.SBERT.net) installed:
+
+```
+pip install -U sentence-transformers
+```
 
-## Training
+Then you can use the model like this:
+
+```python
+from sentence_transformers import SentenceTransformer
+sentences = ["This is an example sentence", "Each sentence is converted"]
 
-Details about the training of the models can be found here: [SBERT.net - MS MARCO](https://www.sbert.net/examples/training/ms_marco/README.html)
+model = SentenceTransformer('sentence-transformers/msmarco-MiniLM-L-12-v3')
+embeddings = model.encode(sentences)
+print(embeddings)
+```
 
-## Performance
 
-For performance details, see: [SBERT.net - Pre-Trained Models - MS MARCO](https://www.sbert.net/docs/pretrained-models/msmarco-v3.html)
 
-## Usage (HuggingFace Models Repository)
+## 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
@@ -28,67 +46,54 @@ 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)
 
-# Queries we want embeddings for
-queries = ['What is the capital of France?', 'How many people live in New York City?']
 
-# Passages that provide answers
-passages = ['Paris is the capital of France', 'New York City is the most populous city in the United States, with an estimated 8,336,817 people living in the city, according to U.S. Census estimates dating July 1, 2019']
+# Sentences we want sentence embeddings for
+sentences = ['This is an example sentence', 'Each sentence is converted']
 
-#Load AutoModel from huggingface model repository
-tokenizer = AutoTokenizer.from_pretrained("model_name")
-model = AutoModel.from_pretrained("model_name")
+# Load model from HuggingFace Hub
+tokenizer = AutoTokenizer.from_pretrained('sentence-transformers/msmarco-MiniLM-L-12-v3')
+model = AutoModel.from_pretrained('sentence-transformers/msmarco-MiniLM-L-12-v3')
 
-def compute_embeddings(sentences):
-	#Tokenize sentences
-	encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')
+# Tokenize sentences
+encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')
 
-	#Compute query embeddings
-	with torch.no_grad():
-		model_output = model(**encoded_input)
+# Compute token embeddings
+with torch.no_grad():
+    model_output = model(**encoded_input)
 
-	#Perform pooling. In this case, mean pooling
-	return mean_pooling(model_output, encoded_input['attention_mask'])
+# Perform pooling. In this case, max pooling.
+sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])
 
-query_embeddings = compute_embeddings(queries)
-passage_embeddings = compute_embeddings(passages)
+print("Sentence embeddings:")
+print(sentence_embeddings)
 ```
 
-## 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')
 
-# Queries we want embeddings for
-queries = ['What is the capital of France?', 'How many people live in New York City?']
+## Evaluation Results
 
-# Passages that provide answers
-passages = ['Paris is the capital of France', 'New York City is the most populous city in the United States, with an estimated 8,336,817 people living in the city, according to U.S. Census estimates dating July 1, 2019']
 
-query_embeddings = model.encode(queries)
-passage_embeddings = model.encode(passages)
-```
 
-## Changes in v3
-The models from v2 have been used for find for all training queries similar passages. An [MS MARCO Cross-Encoder](ce-msmarco.md) based on the electra-base-model has been then used to classify if these retrieved passages answer the question.
+For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name=sentence-transformers/msmarco-MiniLM-L-12-v3)
+
 
-If they received a low score by the cross-encoder, we saved them as hard negatives: They got a high score from the bi-encoder, but a low-score from the (better) cross-encoder.
 
-We then trained the v2 models with these new hard negatives.
+## Full Model Architecture
+```
+SentenceTransformer(
+  (0): Transformer({'max_seq_length': 512, 'do_lower_case': False}) with Transformer model: BertModel 
+  (1): Pooling({'word_embedding_dimension': 384, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False})
+)
+```
 
 ## Citing & Authors
+
+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",

config.json

@@ -1,5 +1,5 @@
 {
-  "_name_or_path": "../output/microsoft_MiniLM-L12-H384-uncased-mined_hard_neg-mean-pooling-no_identifier-epoch10-batchsize70-2021-04-05_07-37-55/0_Transformer",
+  "_name_or_path": "old_models/msmarco-MiniLM-L-12-v3/0_Transformer",
   "architectures": [
     "BertModel"
   ],
@@ -17,7 +17,7 @@
   "num_hidden_layers": 12,
   "pad_token_id": 0,
   "position_embedding_type": "absolute",
-  "transformers_version": "4.4.2",
+  "transformers_version": "4.7.0",
   "type_vocab_size": 2,
   "use_cache": true,
   "vocab_size": 30522

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:57555aab9e3b37aa1e185d6e4534fe279867ec793aebf9e5176294dcb2519114
-size 133526519
+oid sha256:b17442e1b4a5db687084be01f47d35f683f35ffadbfe26ca42622fec51d013a8
+size 133518577

tokenizer_config.json

@@ -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, "model_max_length": 512, "name_or_path": "microsoft/MiniLM-L12-H384-uncased", "do_basic_tokenize": true, "never_split": null}
+{"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, "model_max_length": 512, "name_or_path": "old_models/msmarco-MiniLM-L-12-v3/0_Transformer", "do_basic_tokenize": true, "never_split": null, "special_tokens_map_file": "old_models/msmarco-MiniLM-L-12-v3/0_Transformer/special_tokens_map.json"}