Modified validation and training for linktransformer model

.gitattributes

@@ -35,3 +35,5 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
 pytorch_model.bin filter=lfs diff=lfs merge=lfs -text
 .git/lfs/objects/50/3c/503cf29c02ef5e01d945058baabbeba308c59511cca769786fda5a6ee595a66c filter=lfs diff=lfs merge=lfs -text
+model.safetensors filter=lfs diff=lfs merge=lfs -text
+.git/lfs/objects/bd/17/bd176b01380930c75109b551bb5b5e3635b0a881683fc9be2cd1f0b1fb7da29c filter=lfs diff=lfs merge=lfs -text

1_Pooling/config.json

@@ -3,5 +3,7 @@
   "pooling_mode_cls_token": true,
   "pooling_mode_mean_tokens": false,
   "pooling_mode_max_tokens": false,
-  "pooling_mode_mean_sqrt_len_tokens": false
+  "pooling_mode_mean_sqrt_len_tokens": false,
+  "pooling_mode_weightedmean_tokens": false,
+  "pooling_mode_lasttoken": false
 }

LT_training_config.json

@@ -1,12 +1,13 @@
 {
   "model_save_dir": "models",
   "model_save_name": "linkage_un_data_en_fine_coarse",
-  "opt_model_description": "This model was trained on a dataset prepared by linking product classifications from [UN stats](https://unstats.un.org/unsd/classifications/Econ). \n                                 This model is designed to link different products to their coarse product classification - trained on variation brought on by product level correspondance. It was trained for 100 epochs using other defaults that can be found in the repo's LinkTransformer config file - LT_training_config.json \n  ",
+  "opt_model_description": "This model was trained on a dataset prepared by linking product classifications from [UN stats](https://unstats.un.org/unsd/classifications/Econ). \n                                 This model is designed to link different products to their coarse product classification - trained on variation brought on by product level correspondance. It was trained for 70 epochs using other defaults that can be found in the repo's LinkTransformer config file - LT_training_config.json \n  ",
   "opt_model_lang": "en",
   "train_batch_size": 64,
-  "num_epochs": 100,
+  "num_epochs": 70,
   "warm_up_perc": 1,
-  "learning_rate": 2e-06,
+  "learning_rate": 2e-05,
+  "loss_type": "supcon",
   "val_perc": 0.2,
   "wandb_names": {
     "project": "linkage",
@@ -16,10 +17,11 @@
   },
   "add_pooling_layer": false,
   "large_val": true,
-  "eval_steps_perc": 0.1,
+  "eval_steps_perc": 0.5,
   "test_at_end": true,
   "save_val_test_pickles": true,
   "val_query_prop": 0.5,
+  "loss_params": {},
   "eval_type": "retrieval",
   "training_dataset": "dataframe",
   "base_model_path": "multi-qa-mpnet-base-dot-v1",

README.md

@@ -12,7 +12,7 @@ tags:
 
 # dell-research-harvard/lt-un-data-fine-coarse-en
 
-This is a [LinkTransformer](https://github.com/dell-research-harvard/linktransformer) model. At its core this model this is a sentence transformer model [sentence-transformers](https://www.SBERT.net) model- it just wraps around the class. 
+This is a [LinkTransformer](https://linktransformer.github.io/) model. At its core this model this is a sentence transformer model [sentence-transformers](https://www.SBERT.net) model- it just wraps around the class. 
 It is designed for quick and easy record linkage (entity-matching) through the LinkTransformer package. The tasks include clustering, deduplication, linking, aggregation and more.
 Notwithstanding that, it can be used for any sentence similarity task within the sentence-transformers framework as well. 
 It maps sentences & paragraphs to a 768 dimensional dense vector space and can be used for tasks like clustering or semantic search.
@@ -23,7 +23,7 @@ This model has been fine-tuned on the model : multi-qa-mpnet-base-dot-v1. It is
 
 
 This model was trained on a dataset prepared by linking product classifications from [UN stats](https://unstats.un.org/unsd/classifications/Econ). 
-                                 This model is designed to link different products to their coarse product classification - trained on variation brought on by product level correspondance. It was trained for 100 epochs using other defaults that can be found in the repo's LinkTransformer config file - LT_training_config.json 
+                                 This model is designed to link different products to their coarse product classification - trained on variation brought on by product level correspondance. It was trained for 70 epochs using other defaults that can be found in the repo's LinkTransformer config file - LT_training_config.json 
   
 
 ## Usage (LinkTransformer)
@@ -97,7 +97,7 @@ The model was trained with the parameters:
 
 **DataLoader**:
 
-`torch.utils.data.dataloader.DataLoader` of length 126 with parameters:
+`torch.utils.data.dataloader.DataLoader` of length 148 with parameters:
 ```
 {'batch_size': 64, 'sampler': 'torch.utils.data.dataloader._InfiniteConstantSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}
 ```
@@ -109,17 +109,17 @@ The model was trained with the parameters:
 Parameters of the fit()-Method:
 ```
 {
-    "epochs": 100,
-    "evaluation_steps": 1260,
+    "epochs": 70,
+    "evaluation_steps": 74,
     "evaluator": "sentence_transformers.evaluation.SequentialEvaluator.SequentialEvaluator",
     "max_grad_norm": 1,
     "optimizer_class": "<class 'torch.optim.adamw.AdamW'>",
     "optimizer_params": {
-        "lr": 2e-06
+        "lr": 2e-05
     },
     "scheduler": "WarmupLinear",
     "steps_per_epoch": null,
-    "warmup_steps": 12600,
+    "warmup_steps": 10360,
     "weight_decay": 0.01
 }
 ```
@@ -129,10 +129,20 @@ Parameters of the fit()-Method:
 
 LinkTransformer(
   (0): Transformer({'max_seq_length': 512, 'do_lower_case': False}) with Transformer model: MPNetModel 
-  (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': True, 'pooling_mode_mean_tokens': False, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False})
+  (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': True, 'pooling_mode_mean_tokens': False, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False})
 )
 ```
 
 ## Citing & Authors
 
-<!--- Describe where people can find more information -->
+```
+@misc{arora2023linktransformer,
+                  title={LinkTransformer: A Unified Package for Record Linkage with Transformer Language Models},
+                  author={Abhishek Arora and Melissa Dell},
+                  year={2023},
+                  eprint={2309.00789},
+                  archivePrefix={arXiv},
+                  primaryClass={cs.CL}
+                }
+
+```

config.json

@@ -1,5 +1,5 @@
 {
-  "_name_or_path": "models/linkage_un_data_en_fine_coarse/",
+  "_name_or_path": "models/linkage_un_data_en_fine_coarse",
   "architectures": [
     "MPNetModel"
   ],
@@ -19,6 +19,6 @@
   "pad_token_id": 1,
   "relative_attention_num_buckets": 32,
   "torch_dtype": "float32",
-  "transformers_version": "4.31.0",
+  "transformers_version": "4.35.1",
   "vocab_size": 30527
 }

model.safetensors

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

special_tokens_map.json

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

tokenizer_config.json

@@ -1,15 +1,72 @@
 {
+  "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>",
+  "max_length": 250,
   "model_max_length": 512,
+  "pad_to_multiple_of": null,
   "pad_token": "<pad>",
+  "pad_token_type_id": 0,
+  "padding_side": "right",
   "sep_token": "</s>",
+  "stride": 0,
   "strip_accents": null,
   "tokenize_chinese_chars": true,
   "tokenizer_class": "MPNetTokenizer",
+  "truncation_side": "right",
+  "truncation_strategy": "longest_first",
   "unk_token": "[UNK]"
 }