model update

README.md

@@ -0,0 +1,268 @@
+---
+datasets:
+- relbert/nell_relational_similarity
+model-index:
+- name: relbert/relbert-roberta-base-nce-a-nell
+  results:
+  - task:
+      name: Relation Mapping
+      type: sorting-task
+    dataset:
+      name: Relation Mapping
+      args: relbert/relation_mapping
+      type: relation-mapping
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.7451388888888889
+  - task:
+      name: Analogy Questions (SAT full)
+      type: multiple-choice-qa
+    dataset:
+      name: SAT full
+      args: relbert/analogy_questions
+      type: analogy-questions
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.3983957219251337
+  - task:
+      name: Analogy Questions (SAT)
+      type: multiple-choice-qa
+    dataset:
+      name: SAT
+      args: relbert/analogy_questions
+      type: analogy-questions
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.4065281899109792
+  - task:
+      name: Analogy Questions (BATS)
+      type: multiple-choice-qa
+    dataset:
+      name: BATS
+      args: relbert/analogy_questions
+      type: analogy-questions
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.3924402445803224
+  - task:
+      name: Analogy Questions (Google)
+      type: multiple-choice-qa
+    dataset:
+      name: Google
+      args: relbert/analogy_questions
+      type: analogy-questions
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.632
+  - task:
+      name: Analogy Questions (U2)
+      type: multiple-choice-qa
+    dataset:
+      name: U2
+      args: relbert/analogy_questions
+      type: analogy-questions
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.39473684210526316
+  - task:
+      name: Analogy Questions (U4)
+      type: multiple-choice-qa
+    dataset:
+      name: U4
+      args: relbert/analogy_questions
+      type: analogy-questions
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.4212962962962963
+  - task:
+      name: Analogy Questions (ConceptNet Analogy)
+      type: multiple-choice-qa
+    dataset:
+      name: ConceptNet Analogy
+      args: relbert/analogy_questions
+      type: analogy-questions
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.10318791946308725
+  - task:
+      name: Analogy Questions (TREX Analogy)
+      type: multiple-choice-qa
+    dataset:
+      name: TREX Analogy
+      args: relbert/analogy_questions
+      type: analogy-questions
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.639344262295082
+  - task:
+      name: Analogy Questions (NELL-ONE Analogy)
+      type: multiple-choice-qa
+    dataset:
+      name: NELL-ONE Analogy
+      args: relbert/analogy_questions
+      type: analogy-questions
+    metrics:
+    - name: Accuracy
+      type: accuracy
+      value: 0.8
+  - task:
+      name: Lexical Relation Classification (BLESS)
+      type: classification
+    dataset:
+      name: BLESS
+      args: relbert/lexical_relation_classification
+      type: relation-classification
+    metrics:
+    - name: F1
+      type: f1
+      value: 0.8987494349856864
+    - name: F1 (macro)
+      type: f1_macro
+      value: 0.890050406980326
+  - task:
+      name: Lexical Relation Classification (CogALexV)
+      type: classification
+    dataset:
+      name: CogALexV
+      args: relbert/lexical_relation_classification
+      type: relation-classification
+    metrics:
+    - name: F1
+      type: f1
+      value: 0.8011737089201879
+    - name: F1 (macro)
+      type: f1_macro
+      value: 0.5692353291338583
+  - task:
+      name: Lexical Relation Classification (EVALution)
+      type: classification
+    dataset:
+      name: BLESS
+      args: relbert/lexical_relation_classification
+      type: relation-classification
+    metrics:
+    - name: F1
+      type: f1
+      value: 0.6105092091007583
+    - name: F1 (macro)
+      type: f1_macro
+      value: 0.5995431523479036
+  - task:
+      name: Lexical Relation Classification (K&H+N)
+      type: classification
+    dataset:
+      name: K&H+N
+      args: relbert/lexical_relation_classification
+      type: relation-classification
+    metrics:
+    - name: F1
+      type: f1
+      value: 0.9476942338457258
+    - name: F1 (macro)
+      type: f1_macro
+      value: 0.856425065439868
+  - task:
+      name: Lexical Relation Classification (ROOT09)
+      type: classification
+    dataset:
+      name: ROOT09
+      args: relbert/lexical_relation_classification
+      type: relation-classification
+    metrics:
+    - name: F1
+      type: f1
+      value: 0.8824819805703541
+    - name: F1 (macro)
+      type: f1_macro
+      value: 0.8824104543652189
+
+---
+# relbert/relbert-roberta-base-nce-a-nell
+
+RelBERT based on [roberta-base](https://huggingface.co/roberta-base) fine-tuned on [relbert/nell_relational_similarity](https://huggingface.co/datasets/relbert/nell_relational_similarity) (see the [`relbert`](https://github.com/asahi417/relbert) for more detail of fine-tuning).
+This model achieves the following results on the relation understanding tasks:
+- Analogy Question ([dataset](https://huggingface.co/datasets/relbert/analogy_questions), [full result](https://huggingface.co/relbert/relbert-roberta-base-nce-a-nell/raw/main/analogy.forward.json)):
+    - Accuracy on SAT (full): 0.3983957219251337 
+    - Accuracy on SAT: 0.4065281899109792
+    - Accuracy on BATS: 0.3924402445803224
+    - Accuracy on U2: 0.39473684210526316
+    - Accuracy on U4: 0.4212962962962963
+    - Accuracy on Google: 0.632
+    - Accuracy on ConceptNet Analogy: 0.10318791946308725
+    - Accuracy on T-Rex Analogy: 0.639344262295082
+    - Accuracy on NELL-ONE Analogy: 0.8
+- Lexical Relation Classification ([dataset](https://huggingface.co/datasets/relbert/lexical_relation_classification), [full result](https://huggingface.co/relbert/relbert-roberta-base-nce-a-nell/raw/main/classification.json)):
+    - Micro F1 score on BLESS: 0.8987494349856864
+    - Micro F1 score on CogALexV: 0.8011737089201879
+    - Micro F1 score on EVALution: 0.6105092091007583
+    - Micro F1 score on K&H+N: 0.9476942338457258
+    - Micro F1 score on ROOT09: 0.8824819805703541
+- Relation Mapping ([dataset](https://huggingface.co/datasets/relbert/relation_mapping), [full result](https://huggingface.co/relbert/relbert-roberta-base-nce-a-nell/raw/main/relation_mapping.json)):
+    - Accuracy on Relation Mapping: 0.7451388888888889 
+
+
+### Usage
+This model can be used through the [relbert library](https://github.com/asahi417/relbert). Install the library via pip   
+```shell
+pip install relbert
+```
+and activate model as below.
+```python
+from relbert import RelBERT
+model = RelBERT("relbert/relbert-roberta-base-nce-a-nell")
+vector = model.get_embedding(['Tokyo', 'Japan'])  # shape of (n_dim, )
+```
+
+### Training hyperparameters
+
+ - model: roberta-base
+ - max_length: 64
+ - epoch: 5
+ - batch: 16
+ - random_seed: 0
+ - lr: 5e-06
+ - lr_warmup: 10
+ - aggregation_mode: average_no_mask
+ - data: relbert/nell_relational_similarity
+ - data_name: None
+ - exclude_relation: None
+ - split: train
+ - split_valid: validation
+ - loss_function: nce
+ - classification_loss: False
+ - loss_function_config: {'temperature': 0.05, 'num_negative': 300, 'num_positive': 30}
+ - augment_negative_by_positive: True
+
+See the full configuration at [config file](https://huggingface.co/relbert/relbert-roberta-base-nce-a-nell/raw/main/finetuning_config.json).
+
+### Reference
+If you use any resource from RelBERT, please consider to cite our [paper](https://aclanthology.org/2021.emnlp-main.712/).
+
+```
+
+@inproceedings{ushio-etal-2021-distilling,
+    title = "Distilling Relation Embeddings from Pretrained Language Models",
+    author = "Ushio, Asahi  and
+      Camacho-Collados, Jose  and
+      Schockaert, Steven",
+    booktitle = "Proceedings of the 2021 Conference on Empirical Methods in Natural Language Processing",
+    month = nov,
+    year = "2021",
+    address = "Online and Punta Cana, Dominican Republic",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2021.emnlp-main.712",
+    doi = "10.18653/v1/2021.emnlp-main.712",
+    pages = "9044--9062",
+    abstract = "Pre-trained language models have been found to capture a surprisingly rich amount of lexical knowledge, ranging from commonsense properties of everyday concepts to detailed factual knowledge about named entities. Among others, this makes it possible to distill high-quality word vectors from pre-trained language models. However, it is currently unclear to what extent it is possible to distill relation embeddings, i.e. vectors that characterize the relationship between two words. Such relation embeddings are appealing because they can, in principle, encode relational knowledge in a more fine-grained way than is possible with knowledge graphs. To obtain relation embeddings from a pre-trained language model, we encode word pairs using a (manually or automatically generated) prompt, and we fine-tune the language model such that relationally similar word pairs yield similar output vectors. We find that the resulting relation embeddings are highly competitive on analogy (unsupervised) and relation classification (supervised) benchmarks, even without any task-specific fine-tuning. Source code to reproduce our experimental results and the model checkpoints are available in the following repository: https://github.com/asahi417/relbert",
+}
+
+```

analogy.bidirection.json

@@ -0,0 +1 @@
+{"scan/test": 0.17141089108910892, "sat_full/test": 0.4144385026737968, "sat/test": 0.4332344213649852, "u2/test": 0.3991228070175439, "u4/test": 0.42592592592592593, "google/test": 0.642, "bats/test": 0.3807670928293496, "t_rex_relational_similarity/test": 0.6775956284153005, "conceptnet_relational_similarity/test": 0.13506711409395974, "nell_relational_similarity/test": 0.8333333333333334, "scan/validation": 0.19101123595505617, "sat/validation": 0.24324324324324326, "u2/validation": 0.375, "u4/validation": 0.4375, "google/validation": 0.7, "bats/validation": 0.4271356783919598, "semeval2012_relational_similarity/validation": 0.4936708860759494, "t_rex_relational_similarity/validation": 0.23790322580645162, "conceptnet_relational_similarity/validation": 0.09982014388489209, "nell_relational_similarity/validation": 0.7375}

analogy.forward.json

@@ -0,0 +1 @@
+{"nell_relational_similarity/validation": 0.67, "scan/test": 0.16584158415841585, "sat_full/test": 0.3983957219251337, "sat/test": 0.4065281899109792, "u2/test": 0.39473684210526316, "u4/test": 0.4212962962962963, "google/test": 0.632, "bats/test": 0.3924402445803224, "t_rex_relational_similarity/test": 0.639344262295082, "conceptnet_relational_similarity/test": 0.10318791946308725, "nell_relational_similarity/test": 0.8, "scan/validation": 0.15730337078651685, "sat/validation": 0.32432432432432434, "u2/validation": 0.375, "u4/validation": 0.3541666666666667, "google/validation": 0.62, "bats/validation": 0.4371859296482412, "semeval2012_relational_similarity/validation": 0.5189873417721519, "t_rex_relational_similarity/validation": 0.2439516129032258, "conceptnet_relational_similarity/validation": 0.09802158273381295}

analogy.reverse.json

@@ -0,0 +1 @@
+{"scan/test": 0.16027227722772278, "sat_full/test": 0.3850267379679144, "sat/test": 0.40059347181008903, "u2/test": 0.42105263157894735, "u4/test": 0.4398148148148148, "google/test": 0.634, "bats/test": 0.3841022790439133, "t_rex_relational_similarity/test": 0.639344262295082, "conceptnet_relational_similarity/test": 0.11912751677852348, "nell_relational_similarity/test": 0.805, "scan/validation": 0.1853932584269663, "sat/validation": 0.24324324324324326, "u2/validation": 0.3333333333333333, "u4/validation": 0.4375, "google/validation": 0.68, "bats/validation": 0.44221105527638194, "semeval2012_relational_similarity/validation": 0.46835443037974683, "t_rex_relational_similarity/validation": 0.21370967741935484, "conceptnet_relational_similarity/validation": 0.08003597122302158, "nell_relational_similarity/validation": 0.7125}

classification.json

@@ -0,0 +1 @@
+{"lexical_relation_classification/BLESS": {"classifier_config": {"activation": "relu", "alpha": 0.0001, "batch_size": "auto", "beta_1": 0.9, "beta_2": 0.999, "early_stopping": false, "epsilon": 1e-08, "hidden_layer_sizes": [100], "learning_rate": "constant", "learning_rate_init": 0.001, "max_fun": 15000, "max_iter": 200, "momentum": 0.9, "n_iter_no_change": 10, "nesterovs_momentum": true, "power_t": 0.5, "random_state": 0, "shuffle": true, "solver": "adam", "tol": 0.0001, "validation_fraction": 0.1, "verbose": false, "warm_start": false}, "test/accuracy": 0.8987494349856863, "test/f1_macro": 0.890050406980326, "test/f1_micro": 0.8987494349856864, "test/p_macro": 0.8875116515535861, "test/p_micro": 0.8987494349856863, "test/r_macro": 0.8938613731964725, "test/r_micro": 0.8987494349856863}, "lexical_relation_classification/CogALexV": {"classifier_config": {"activation": "relu", "alpha": 0.0001, "batch_size": "auto", "beta_1": 0.9, "beta_2": 0.999, "early_stopping": false, "epsilon": 1e-08, "hidden_layer_sizes": [100], "learning_rate": "constant", "learning_rate_init": 0.001, "max_fun": 15000, "max_iter": 200, "momentum": 0.9, "n_iter_no_change": 10, "nesterovs_momentum": true, "power_t": 0.5, "random_state": 0, "shuffle": true, "solver": "adam", "tol": 0.0001, "validation_fraction": 0.1, "verbose": false, "warm_start": false}, "test/accuracy": 0.8011737089201878, "test/f1_macro": 0.5692353291338583, "test/f1_micro": 0.8011737089201879, "test/p_macro": 0.5940718935233757, "test/p_micro": 0.8011737089201878, "test/r_macro": 0.5503942431001262, "test/r_micro": 0.8011737089201878}, "lexical_relation_classification/EVALution": {"classifier_config": {"activation": "relu", "alpha": 0.0001, "batch_size": "auto", "beta_1": 0.9, "beta_2": 0.999, "early_stopping": false, "epsilon": 1e-08, "hidden_layer_sizes": [100], "learning_rate": "constant", "learning_rate_init": 0.001, "max_fun": 15000, "max_iter": 200, "momentum": 0.9, "n_iter_no_change": 10, "nesterovs_momentum": true, "power_t": 0.5, "random_state": 0, "shuffle": true, "solver": "adam", "tol": 0.0001, "validation_fraction": 0.1, "verbose": false, "warm_start": false}, "test/accuracy": 0.6105092091007583, "test/f1_macro": 0.5995431523479036, "test/f1_micro": 0.6105092091007583, "test/p_macro": 0.6286715552108619, "test/p_micro": 0.6105092091007583, "test/r_macro": 0.5829130332128429, "test/r_micro": 0.6105092091007583}, "lexical_relation_classification/K&H+N": {"classifier_config": {"activation": "relu", "alpha": 0.0001, "batch_size": "auto", "beta_1": 0.9, "beta_2": 0.999, "early_stopping": false, "epsilon": 1e-08, "hidden_layer_sizes": [100], "learning_rate": "constant", "learning_rate_init": 0.001, "max_fun": 15000, "max_iter": 200, "momentum": 0.9, "n_iter_no_change": 10, "nesterovs_momentum": true, "power_t": 0.5, "random_state": 0, "shuffle": true, "solver": "adam", "tol": 0.0001, "validation_fraction": 0.1, "verbose": false, "warm_start": false}, "test/accuracy": 0.9476942338457258, "test/f1_macro": 0.856425065439868, "test/f1_micro": 0.9476942338457258, "test/p_macro": 0.8544397340559369, "test/p_micro": 0.9476942338457258, "test/r_macro": 0.8586886722866884, "test/r_micro": 0.9476942338457258}, "lexical_relation_classification/ROOT09": {"classifier_config": {"activation": "relu", "alpha": 0.0001, "batch_size": "auto", "beta_1": 0.9, "beta_2": 0.999, "early_stopping": false, "epsilon": 1e-08, "hidden_layer_sizes": [100], "learning_rate": "constant", "learning_rate_init": 0.001, "max_fun": 15000, "max_iter": 200, "momentum": 0.9, "n_iter_no_change": 10, "nesterovs_momentum": true, "power_t": 0.5, "random_state": 0, "shuffle": true, "solver": "adam", "tol": 0.0001, "validation_fraction": 0.1, "verbose": false, "warm_start": false}, "test/accuracy": 0.8824819805703541, "test/f1_macro": 0.8824104543652189, "test/f1_micro": 0.8824819805703541, "test/p_macro": 0.8759737931202952, "test/p_micro": 0.8824819805703541, "test/r_macro": 0.8905194302279558, "test/r_micro": 0.8824819805703541}}

config.json

@@ -0,0 +1,31 @@
+{
+  "_name_or_path": "roberta-base",
+  "architectures": [
+    "RobertaModel"
+  ],
+  "attention_probs_dropout_prob": 0.1,
+  "bos_token_id": 0,
+  "classifier_dropout": null,
+  "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": "roberta",
+  "num_attention_heads": 12,
+  "num_hidden_layers": 12,
+  "pad_token_id": 1,
+  "position_embedding_type": "absolute",
+  "relbert_config": {
+    "aggregation_mode": "average_no_mask",
+    "template": "Today, I finally discovered the relation between <subj> and <obj> : <subj> is the <mask> of <obj>"
+  },
+  "torch_dtype": "float32",
+  "transformers_version": "4.26.1",
+  "type_vocab_size": 1,
+  "use_cache": true,
+  "vocab_size": 50265
+}

finetuning_config.json

@@ -0,0 +1,24 @@
+{
+  "template": "Today, I finally discovered the relation between <subj> and <obj> : <subj> is the <mask> of <obj>",
+  "model": "roberta-base",
+  "max_length": 64,
+  "epoch": 5,
+  "batch": 16,
+  "random_seed": 0,
+  "lr": 5e-06,
+  "lr_warmup": 10,
+  "aggregation_mode": "average_no_mask",
+  "data": "relbert/nell_relational_similarity",
+  "data_name": null,
+  "exclude_relation": null,
+  "split": "train",
+  "split_valid": "validation",
+  "loss_function": "nce",
+  "classification_loss": false,
+  "loss_function_config": {
+    "temperature": 0.05,
+    "num_negative": 300,
+    "num_positive": 30
+  },
+  "augment_negative_by_positive": true
+}

pytorch_model.bin

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

special_tokens_map.json

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

tokenizer_config.json

@@ -0,0 +1,16 @@
+{
+  "add_prefix_space": false,
+  "bos_token": "<s>",
+  "cls_token": "<s>",
+  "eos_token": "</s>",
+  "errors": "replace",
+  "mask_token": "<mask>",
+  "model_max_length": 512,
+  "name_or_path": "roberta-base",
+  "pad_token": "<pad>",
+  "sep_token": "</s>",
+  "special_tokens_map_file": null,
+  "tokenizer_class": "RobertaTokenizer",
+  "trim_offsets": true,
+  "unk_token": "<unk>"
+}