README.md

metadata

datasets:
  - relbert/semeval2012_relational_similarity_v6
model-index:
  - name: relbert/relbert-roberta-base-semeval2012-v6-average-prompt-c-triplet-0
    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: None
      - 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: None
      - 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: None
      - 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: None
      - 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: None
      - 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: None
      - 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: None
      - 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: None
          - name: F1 (macro)
            type: f1_macro
            value: None
      - 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: None
          - name: F1 (macro)
            type: f1_macro
            value: None
      - 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: None
          - name: F1 (macro)
            type: f1_macro
            value: None
      - 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: None
          - name: F1 (macro)
            type: f1_macro
            value: None
      - 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: None
          - name: F1 (macro)
            type: f1_macro
            value: None

relbert/relbert-roberta-base-semeval2012-v6-average-prompt-c-triplet-0

RelBERT fine-tuned from roberta-base on
relbert/semeval2012_relational_similarity_v6. Fine-tuning is done via RelBERT library (see the repository for more detail). It achieves the following results on the relation understanding tasks:

• Analogy Question (dataset, full result):
  • Accuracy on SAT (full): None
  • Accuracy on SAT: None
  • Accuracy on BATS: None
  • Accuracy on U2: None
  • Accuracy on U4: None
  • Accuracy on Google: None
• Lexical Relation Classification (dataset, full result):
  • Micro F1 score on BLESS: None
  • Micro F1 score on CogALexV: None
  • Micro F1 score on EVALution: None
  • Micro F1 score on K&H+N: None
  • Micro F1 score on ROOT09: None
• Relation Mapping (dataset, full result):
  • Accuracy on Relation Mapping: None

Usage

This model can be used through the relbert library. Install the library via pip

pip install relbert

and activate model as below.

from relbert import RelBERT
model = RelBERT("relbert/relbert-roberta-base-semeval2012-v6-average-prompt-c-triplet-0")
vector = model.get_embedding(['Tokyo', 'Japan'])  # shape of (1024, )

Training hyperparameters

The following hyperparameters were used during training:

• model: roberta-base
• max_length: 64
• mode: average
• data: relbert/semeval2012_relational_similarity_v6
• split: train
• split_eval: validation
• template_mode: manual
• template: Today, I finally discovered the relation between and :
• loss_function: triplet
• classification_loss: False
• temperature_nce_constant: 0.05
• temperature_nce_rank: {'min': 0.01, 'max': 0.05, 'type': 'linear'}
• epoch: 8
• batch: 128
• lr: 5e-06
• lr_decay: False
• lr_warmup: 1
• weight_decay: 0
• random_seed: 0
• exclude_relation: None
• n_sample: 320
• gradient_accumulation: 8
• relation_level: None

The full configuration can be found at fine-tuning parameter file.

Reference

If you use any resource from RelBERT, please consider to cite our paper.

@inproceedings{ushio-etal-2021-distilling-relation-embeddings,
    title = "{D}istilling {R}elation {E}mbeddings from {P}re-trained {L}anguage {M}odels",
    author = "Ushio, Asahi  and
      Schockaert, Steven  and
      Camacho-Collados, Jose",
    booktitle = "EMNLP 2021",
    year = "2021",
    address = "Online",
    publisher = "Association for Computational Linguistics",
}