Upload folder using huggingface_hub

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,3 +1,126 @@
 ---
-license: agpl-3.0
+pipeline_tag: sentence-similarity
+tags:
+- sentence-transformers
+- feature-extraction
+- sentence-similarity
+- transformers
+
 ---
+
+# {MODEL_NAME}
+
+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.
+
+<!--- Describe your model here -->
+
+## 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('{MODEL_NAME}')
+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.
+
+```python
+from transformers import AutoTokenizer, AutoModel
+import torch
+
+
+#Mean Pooling - Take attention mask into account for correct averaging
+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()
+    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']
+
+# Load model from HuggingFace Hub
+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')
+
+# Compute token embeddings
+with torch.no_grad():
+    model_output = model(**encoded_input)
+
+# Perform pooling. In this case, mean pooling.
+sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])
+
+print("Sentence embeddings:")
+print(sentence_embeddings)
+```
+
+
+
+## Evaluation Results
+
+<!--- Describe how your model was evaluated -->
+
+For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name={MODEL_NAME})
+
+
+## Training
+The model was trained with the parameters:
+
+**DataLoader**:
+
+`torch.utils.data.dataloader.DataLoader` of length 16082 with parameters:
+```
+{'batch_size': 24, 'sampler': 'torch.utils.data.sampler.RandomSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}
+```
+
+**Loss**:
+
+`sentence_transformers.losses.CosineSimilarityLoss.CosineSimilarityLoss` 
+
+Parameters of the fit()-Method:
+```
+{
+    "epochs": 5,
+    "evaluation_steps": 2000,
+    "evaluator": "sentence_transformers.evaluation.EmbeddingSimilarityEvaluator.EmbeddingSimilarityEvaluator",
+    "max_grad_norm": 1,
+    "optimizer_class": "<class 'torch.optim.adamw.AdamW'>",
+    "optimizer_params": {
+        "lr": 2e-05
+    },
+    "scheduler": "WarmupLinear",
+    "steps_per_epoch": null,
+    "warmup_steps": 100,
+    "weight_decay": 0.01
+}
+```
+
+
+## Full Model Architecture
+```
+SentenceTransformer(
+  (0): Transformer({'max_seq_length': 256, 'do_lower_case': False}) with Transformer model: MPNetModel 
+  (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
+
+<!--- Describe where people can find more information -->

config.json

@@ -0,0 +1,24 @@
+{
+  "_name_or_path": "microsoft/mpnet-base",
+  "architectures": [
+    "MPNetModel"
+  ],
+  "attention_probs_dropout_prob": 0.1,
+  "bos_token_id": 0,
+  "eos_token_id": 2,
+  "hidden_act": "gelu",
+  "hidden_dropout_prob": 0.1,
+  "hidden_size": 768,
+  "initializer_range": 0.02,
+  "intermediate_size": 3072,
+  "layer_norm_eps": 1e-05,
+  "max_position_embeddings": 514,
+  "model_type": "mpnet",
+  "num_attention_heads": 12,
+  "num_hidden_layers": 12,
+  "pad_token_id": 1,
+  "relative_attention_num_buckets": 32,
+  "torch_dtype": "float32",
+  "transformers_version": "4.35.2",
+  "vocab_size": 30527
+}

config_sentence_transformers.json

@@ -0,0 +1,7 @@
+{
+  "__version__": {
+    "sentence_transformers": "2.2.2",
+    "transformers": "4.35.2",
+    "pytorch": "2.1.1+cu118"
+  }
+}

eval/similarity_evaluation_results.csv

@@ -0,0 +1,46 @@
+epoch,steps,cosine_pearson,cosine_spearman,euclidean_pearson,euclidean_spearman,manhattan_pearson,manhattan_spearman,dot_pearson,dot_spearman
+0,2000,0.5112725797696669,0.5079868037535843,0.48407236798428055,0.4888687201381017,0.4835558201917416,0.48885871046717744,0.5145130445495018,0.5110862693283496
+0,4000,0.6111641357112114,0.6064641321000418,0.5847972484391026,0.5884899560079203,0.5830138084208017,0.5874336656750055,0.6134437127585878,0.6099162221787197
+0,6000,0.6579722120081701,0.6563783279464613,0.6276196935734649,0.6391973308484455,0.6264648475003323,0.6383539032144969,0.6563447061022429,0.6577615125374133
+0,8000,0.6978412971860155,0.6946973866807362,0.6657953105465442,0.674151098489152,0.6634713423748253,0.6709172930480223,0.6989396300286976,0.6983819641273818
+0,10000,0.71664126625434,0.716561126793274,0.6833448007845064,0.705144248042718,0.6807636725890266,0.6997964306348234,0.7133170005452343,0.714783250468296
+0,12000,0.7447759343821916,0.7437559609542774,0.7057193238976673,0.7218290856032596,0.705497095738836,0.7204414623025513,0.7420934145344666,0.7452860937305911
+0,14000,0.74915674561808,0.749484574409083,0.708469028768564,0.7295175744167467,0.708862755332043,0.7294867420532651,0.7471797393236392,0.7512694531694221
+0,16000,0.7707121365174059,0.771329106264553,0.7294723575753942,0.7488274869183182,0.7288860458749342,0.7471076951125543,0.7701621878183128,0.7744463370749671
+0,-1,0.7673140859747135,0.7667790984570396,0.7263377249282992,0.7456929312078262,0.7253748518648819,0.7434909313501022,0.7655486588557363,0.7686533666157107
+1,2000,0.7819429938266307,0.78094704409873,0.7416114293224294,0.7595531767831939,0.7421616332537951,0.7592690310441832,0.7808248411660548,0.782697255624755
+1,4000,0.7882986608457935,0.7868252544880076,0.7467243268522838,0.7645963169916876,0.7466242729955777,0.764125914046692,0.7866295591608243,0.7883454930504136
+1,6000,0.8002238821079108,0.7982344505789355,0.7634717460588625,0.7829702832791225,0.7624982949030922,0.7807306940679162,0.7980618888927581,0.7984140644466148
+1,8000,0.8070599201833404,0.8071643755565566,0.7643932383599533,0.7887840170851298,0.7635462817966631,0.7866299670484965,0.8049820389033089,0.807796628000849
+1,10000,0.8123730342226898,0.81204642594481,0.7724022056326567,0.7968143140466736,0.771142252372132,0.7933508069884749,0.8116375114831246,0.8125024701901095
+1,12000,0.8171761556472309,0.8191539356024743,0.7721963563242908,0.7988008804957016,0.771338536586359,0.7967986160515254,0.8167556722295175,0.8211600422619921
+1,14000,0.8217200888451738,0.8229779612489727,0.7737227776076485,0.8001481560538273,0.7733634963086969,0.7984669782070695,0.8199149290350003,0.8243445697613914
+1,16000,0.8265222758832693,0.8285146250871479,0.7813682048404436,0.8108495176264491,0.78090914547678,0.8091313952280513,0.8251643004911461,0.829006408560849
+1,-1,0.8262303306713485,0.8282679607936951,0.7790294533575797,0.805921674845624,0.7794735365266164,0.8060717099219609,0.8239888333820669,0.8286823805230532
+2,2000,0.8286784496459367,0.8310504737694457,0.7819573759907552,0.812093169166234,0.7816215080149245,0.8101384623231614,0.8274909327134539,0.8317846237617296
+2,4000,0.835616205220834,0.8360943474053417,0.7894847068354555,0.8169915674633668,0.7896787390309352,0.8160661613056649,0.8336247110613197,0.8357800613366163
+2,6000,0.8398343497156494,0.8399175926927265,0.7950891950547772,0.8212798700074329,0.7954691838435125,0.8205536777256416,0.8375575531504742,0.8396359868478035
+2,8000,0.8438018637837216,0.8438270986496463,0.795149045551288,0.8203054496547696,0.7958467395245419,0.820601422312527,0.8410070432782604,0.8436613413744672
+2,10000,0.8468480597007373,0.8476039194230917,0.8001936746003268,0.8268160795644668,0.8004946384225324,0.8264367841395094,0.8443737172866908,0.8477115853297948
+2,12000,0.8502813607854378,0.8509179756799067,0.80550666725913,0.831197929706751,0.8051254121677959,0.8298668456970126,0.8476986276978584,0.850567279598252
+2,14000,0.8539073568193281,0.8553464729662648,0.8087714992065229,0.8371078647164694,0.8088870793702209,0.8361343456763813,0.8528162190230996,0.8556900064846321
+2,16000,0.8544573177596062,0.8580720727688758,0.8037740803189763,0.8373612490337308,0.8039765512515591,0.8362046535013997,0.8535004359962781,0.8582169400534592
+2,-1,0.8564469620604049,0.8583573088500128,0.8092963756732118,0.8394582862307234,0.8095295258357031,0.8383808437647896,0.8537510545413085,0.8576369640121451
+3,2000,0.858335492426398,0.8598730511158054,0.8109701818577197,0.8388938096664709,0.8115046245911267,0.8388572580320608,0.857496614165324,0.8603503131250824
+3,4000,0.8585720362404455,0.8608787200229299,0.8094691553741892,0.8406964015823338,0.8100279877484762,0.8401941017763299,0.8560533825031614,0.8599173187451638
+3,6000,0.8625065340034024,0.8643877033313818,0.8147635598777612,0.8439370969066217,0.815024717502594,0.8432979741313638,0.8610900947663982,0.8640921848075493
+3,8000,0.8636424980300432,0.865122090592666,0.8173109962050679,0.845700575720838,0.8182284738793051,0.8459612367985541,0.8613495822247048,0.8641951639601717
+3,10000,0.8650135805176045,0.8673640283370629,0.816476323494592,0.8466196160872734,0.8169465400233672,0.8462270727279998,0.8634553032248831,0.8670114328838054
+3,12000,0.8660554514616089,0.8675529876534124,0.820467698385613,0.8491929868057942,0.8206915904174914,0.848456541205093,0.8637250810237758,0.8665606617213012
+3,14000,0.869624306329827,0.8718296409176024,0.8209503097190902,0.8506831769725806,0.8219506623807201,0.8510081930208988,0.8674419506031797,0.8709930565184041
+3,16000,0.8704396511213788,0.8735845147650085,0.8213771401822823,0.8531587401746457,0.821977454760251,0.8527795805352297,0.8698618513314226,0.8733708916919545
+3,-1,0.8700336133151265,0.8726758833679342,0.8204336806274579,0.8520600699024211,0.8215392375394879,0.8524818449200231,0.8686024548768527,0.8720263802394267
+4,2000,0.87206925200801,0.8739807045524346,0.8261164267655331,0.8544884307137518,0.8271211846423038,0.8547683535320902,0.8705259947562897,0.8734331721011405
+4,4000,0.8729561300627455,0.8755517209603371,0.8236263307824584,0.8544608040818665,0.8243894920098801,0.8546285432975391,0.8718757908696867,0.8752564718789628
+4,6000,0.8733050986710387,0.8763342021631335,0.8229918605011646,0.8544769984685667,0.8241693828088917,0.8550171857019131,0.872459812828531,0.8762565503867752
+4,8000,0.8747918752753512,0.8776918490177567,0.8266396911478837,0.8576142866877868,0.8273975347484257,0.8575592743630189,0.8737816762278383,0.8772673195672135
+4,10000,0.8756954383154001,0.8785020324188557,0.826701497021203,0.8580297266019579,0.8275847946482253,0.8580523517597078,0.8740733998601564,0.8777094913541181
+4,12000,0.8766918428682116,0.8791700693786121,0.8287402810383075,0.8591466484870882,0.8295960716735256,0.8592141541249873,0.8749246498622072,0.8780804557469476
+4,14000,0.877598616280475,0.8800782071546932,0.829796344766758,0.8600729219172725,0.8306199404272812,0.8601873712190522,0.8759751366450554,0.8789839862502832
+4,16000,0.8776365492614989,0.8802169350974743,0.8292031255117502,0.8601198002110558,0.830114079320727,0.8603507576377725,0.8759709022137859,0.8791947439523577
+4,-1,0.8776310070951263,0.8802108509348683,0.8291788384293556,0.860103499714235,0.8300926509841282,0.8603385907137475,0.8759596196632796,0.8791872747352656

model.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:72d7dcc200ac484762759f559d2d6baf469f915f66a051a706478cd8e302eaa4
+size 437967672

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"
+  }
+]

sentence_bert_config.json

@@ -0,0 +1,4 @@
+{
+  "max_seq_length": 256,
+  "do_lower_case": false
+}

special_tokens_map.json

@@ -0,0 +1,51 @@
+{
+  "bos_token": {
+    "content": "<s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "cls_token": {
+    "content": "<s>",
+    "lstrip": false,
+    "normalized": true,
+    "rstrip": false,
+    "single_word": false
+  },
+  "eos_token": {
+    "content": "</s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "mask_token": {
+    "content": "<mask>",
+    "lstrip": true,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "pad_token": {
+    "content": "<pad>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "sep_token": {
+    "content": "</s>",
+    "lstrip": false,
+    "normalized": true,
+    "rstrip": false,
+    "single_word": false
+  },
+  "unk_token": {
+    "content": "[UNK]",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  }
+}

tokenizer_config.json

@@ -0,0 +1,65 @@
+{
+  "added_tokens_decoder": {
+    "0": {
+      "content": "<s>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "1": {
+      "content": "<pad>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "2": {
+      "content": "</s>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "3": {
+      "content": "<unk>",
+      "lstrip": false,
+      "normalized": true,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "104": {
+      "content": "[UNK]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "30526": {
+      "content": "<mask>",
+      "lstrip": true,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    }
+  },
+  "bos_token": "<s>",
+  "clean_up_tokenization_spaces": true,
+  "cls_token": "<s>",
+  "do_lower_case": true,
+  "eos_token": "</s>",
+  "mask_token": "<mask>",
+  "model_max_length": 512,
+  "pad_token": "<pad>",
+  "sep_token": "</s>",
+  "strip_accents": null,
+  "tokenize_chinese_chars": true,
+  "tokenizer_class": "MPNetTokenizer",
+  "unk_token": "[UNK]"
+}