model update

.gitattributes

@@ -32,3 +32,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+tokenizer.json filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,138 @@
+
+---
+license: cc-by-4.0
+metrics:
+- bleu4
+- meteor
+- rouge-l
+- bertscore
+- moverscore
+language: de
+datasets:
+- lmqg/qg_dequad
+pipeline_tag: text2text-generation
+tags:
+- question generation
+widget:
+- text: "Empfangs- und Sendeantenne sollen in ihrer Polarisation übereinstimmen, andernfalls <hl> wird die Signalübertragung stark gedämpft. <hl>"
+  example_title: "Question Generation Example 1" 
+- text: "das erste weltweit errichtete Hermann Brehmer <hl> 1855 <hl> im niederschlesischen ''Görbersdorf'' (heute Sokołowsko, Polen)."
+  example_title: "Question Generation Example 2" 
+- text: "Er muss Zyperngrieche sein und wird direkt für <hl> fünf Jahre <hl> gewählt (Art. 43 Abs. 1 der Verfassung) und verfügt über weitreichende Exekutivkompetenzen."
+  example_title: "Question Generation Example 3" 
+model-index:
+- name: vocabtrimmer/mt5-base-trimmed-de-15000-dequad-qg
+  results:
+  - task:
+      name: Text2text Generation
+      type: text2text-generation
+    dataset:
+      name: lmqg/qg_dequad
+      type: default
+      args: default
+    metrics:
+    - name: BLEU4 (Question Generation)
+      type: bleu4_question_generation
+      value: 0.35
+    - name: ROUGE-L (Question Generation)
+      type: rouge_l_question_generation
+      value: 8.49
+    - name: METEOR (Question Generation)
+      type: meteor_question_generation
+      value: 7.3
+    - name: BERTScore (Question Generation)
+      type: bertscore_question_generation
+      value: 71.98
+    - name: MoverScore (Question Generation)
+      type: moverscore_question_generation
+      value: 50.07
+---
+
+# Model Card of `vocabtrimmer/mt5-base-trimmed-de-15000-dequad-qg`
+This model is fine-tuned version of [vocabtrimmer/mt5-base-trimmed-de-15000](https://huggingface.co/vocabtrimmer/mt5-base-trimmed-de-15000) for question generation task on the [lmqg/qg_dequad](https://huggingface.co/datasets/lmqg/qg_dequad) (dataset_name: default) via [`lmqg`](https://github.com/asahi417/lm-question-generation).
+
+
+### Overview
+- **Language model:** [vocabtrimmer/mt5-base-trimmed-de-15000](https://huggingface.co/vocabtrimmer/mt5-base-trimmed-de-15000)   
+- **Language:** de  
+- **Training data:** [lmqg/qg_dequad](https://huggingface.co/datasets/lmqg/qg_dequad) (default)
+- **Online Demo:** [https://autoqg.net/](https://autoqg.net/)
+- **Repository:** [https://github.com/asahi417/lm-question-generation](https://github.com/asahi417/lm-question-generation)
+- **Paper:** [https://arxiv.org/abs/2210.03992](https://arxiv.org/abs/2210.03992)
+
+### Usage
+- With [`lmqg`](https://github.com/asahi417/lm-question-generation#lmqg-language-model-for-question-generation-)
+```python
+from lmqg import TransformersQG
+
+# initialize model
+model = TransformersQG(language="de", model="vocabtrimmer/mt5-base-trimmed-de-15000-dequad-qg")
+
+# model prediction
+questions = model.generate_q(list_context="das erste weltweit errichtete Hermann Brehmer 1855 im niederschlesischen ''Görbersdorf'' (heute Sokołowsko, Polen).", list_answer="1855")
+
+```
+
+- With `transformers`
+```python
+from transformers import pipeline
+
+pipe = pipeline("text2text-generation", "vocabtrimmer/mt5-base-trimmed-de-15000-dequad-qg")
+output = pipe("Empfangs- und Sendeantenne sollen in ihrer Polarisation übereinstimmen, andernfalls <hl> wird die Signalübertragung stark gedämpft. <hl>")
+
+```
+
+## Evaluation
+
+
+- ***Metric (Question Generation)***: [raw metric file](https://huggingface.co/vocabtrimmer/mt5-base-trimmed-de-15000-dequad-qg/raw/main/eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_dequad.default.json) 
+
+|            |   Score | Type    | Dataset                                                          |
+|:-----------|--------:|:--------|:-----------------------------------------------------------------|
+| BERTScore  |   71.98 | default | [lmqg/qg_dequad](https://huggingface.co/datasets/lmqg/qg_dequad) |
+| Bleu_1     |    8.9  | default | [lmqg/qg_dequad](https://huggingface.co/datasets/lmqg/qg_dequad) |
+| Bleu_2     |    3.03 | default | [lmqg/qg_dequad](https://huggingface.co/datasets/lmqg/qg_dequad) |
+| Bleu_3     |    0.94 | default | [lmqg/qg_dequad](https://huggingface.co/datasets/lmqg/qg_dequad) |
+| Bleu_4     |    0.35 | default | [lmqg/qg_dequad](https://huggingface.co/datasets/lmqg/qg_dequad) |
+| METEOR     |    7.3  | default | [lmqg/qg_dequad](https://huggingface.co/datasets/lmqg/qg_dequad) |
+| MoverScore |   50.07 | default | [lmqg/qg_dequad](https://huggingface.co/datasets/lmqg/qg_dequad) |
+| ROUGE_L    |    8.49 | default | [lmqg/qg_dequad](https://huggingface.co/datasets/lmqg/qg_dequad) |
+
+
+
+## Training hyperparameters
+
+The following hyperparameters were used during fine-tuning:
+ - dataset_path: lmqg/qg_dequad
+ - dataset_name: default
+ - input_types: paragraph_answer
+ - output_types: question
+ - prefix_types: None
+ - model: vocabtrimmer/mt5-base-trimmed-de-15000
+ - max_length: 512
+ - max_length_output: 32
+ - epoch: 8
+ - batch: 16
+ - lr: 0.0001
+ - fp16: False
+ - random_seed: 1
+ - gradient_accumulation_steps: 4
+ - label_smoothing: 0.15
+
+The full configuration can be found at [fine-tuning config file](https://huggingface.co/vocabtrimmer/mt5-base-trimmed-de-15000-dequad-qg/raw/main/trainer_config.json).
+
+## Citation
+```
+@inproceedings{ushio-etal-2022-generative,
+    title = "{G}enerative {L}anguage {M}odels for {P}aragraph-{L}evel {Q}uestion {G}eneration",
+    author = "Ushio, Asahi  and
+        Alva-Manchego, Fernando  and
+        Camacho-Collados, Jose",
+    booktitle = "Proceedings of the 2022 Conference on Empirical Methods in Natural Language Processing",
+    month = dec,
+    year = "2022",
+    address = "Abu Dhabi, U.A.E.",
+    publisher = "Association for Computational Linguistics",
+}
+
+```

added_tokens.json

@@ -0,0 +1,3 @@
+{
+  "<hl>": 15001
+}

config.json

@@ -0,0 +1,54 @@
+{
+  "_name_or_path": "lmqg_output/trimmed_qg/mt5-base-trimmed-de-15000-dequad-qg/model_mntyya/epoch_5",
+  "add_prefix": false,
+  "architectures": [
+    "MT5ForConditionalGeneration"
+  ],
+  "d_ff": 2048,
+  "d_kv": 64,
+  "d_model": 768,
+  "decoder_start_token_id": 0,
+  "dense_act_fn": "gelu_new",
+  "dropout_rate": 0.1,
+  "eos_token_id": 1,
+  "feed_forward_proj": "gated-gelu",
+  "initializer_factor": 1.0,
+  "is_encoder_decoder": true,
+  "is_gated_act": true,
+  "layer_norm_epsilon": 1e-06,
+  "model_type": "mt5",
+  "num_decoder_layers": 12,
+  "num_heads": 12,
+  "num_layers": 12,
+  "output_past": true,
+  "pad_token_id": 0,
+  "relative_attention_max_distance": 128,
+  "relative_attention_num_buckets": 32,
+  "tie_word_embeddings": false,
+  "tokenizer_class": "T5Tokenizer",
+  "torch_dtype": "float32",
+  "transformers_version": "4.26.1",
+  "use_cache": true,
+  "vocab_size": 15002,
+  "vocabtrimmer": {
+    "mining_config": {
+      "dataset": "vocabtrimmer/mc4_validation",
+      "dataset_column": "text",
+      "dataset_name": "de",
+      "dataset_split": "validation",
+      "language": "de",
+      "min_frequency": 2,
+      "target_vocab_size": 15000
+    },
+    "stats": {
+      "compression_rate_embedding": 5.9977130245649946,
+      "compression_rate_full": 37.992839576176756,
+      "parameter_size_embedding/raw": 384172032,
+      "parameter_size_embedding/trimmed": 23041536,
+      "parameter_size_full/raw": 582401280,
+      "parameter_size_full/trimmed": 221270784,
+      "vocab_size/raw": 250112,
+      "vocab_size/trimmed": 15001
+    }
+  }
+}

eval/metric.first.answer.paragraph_answer.question.lmqg_qg_dequad.default.json

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.09783254630637528, "Bleu_2": 0.0321753484253379, "Bleu_3": 0.010551743976625038, "Bleu_4": 0.0037600490747347133}, "test": {"Bleu_1": 0.08695676281159542, "Bleu_2": 0.02975011828031195, "Bleu_3": 0.00942209416474173, "Bleu_4": 0.0034731657688539586}}

eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_dequad.default.json

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.09840200807873312, "Bleu_2": 0.032290975226337726, "Bleu_3": 0.010396750175408564, "Bleu_4": 0.0037306777274880485, "METEOR": 0.08296885894507336, "ROUGE_L": 0.09491370894836597, "BERTScore": 0.7281995949856885, "MoverScore": 0.504635298774877}, "test": {"Bleu_1": 0.08899558584300545, "Bleu_2": 0.03034050996049314, "Bleu_3": 0.009422890681090553, "Bleu_4": 0.0035091954037878843, "METEOR": 0.07301731713582162, "ROUGE_L": 0.08491121486965128, "BERTScore": 0.7197697439243302, "MoverScore": 0.5006844601462255}}

generation_config.json

@@ -0,0 +1,7 @@
+{
+  "_from_model_config": true,
+  "decoder_start_token_id": 0,
+  "eos_token_id": 1,
+  "pad_token_id": 0,
+  "transformers_version": "4.26.1"
+}

pytorch_model.bin

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

special_tokens_map.json

@@ -0,0 +1,8 @@
+{
+  "additional_special_tokens": [
+    "<hl>"
+  ],
+  "eos_token": "</s>",
+  "pad_token": "<pad>",
+  "unk_token": "<unk>"
+}

spiece.model

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

tokenizer.json

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

tokenizer_config.json

@@ -0,0 +1,12 @@
+{
+  "additional_special_tokens": null,
+  "eos_token": "</s>",
+  "extra_ids": 0,
+  "model_max_length": 1000000000000000019884624838656,
+  "name_or_path": "lmqg_output/trimmed_qg/mt5-base-trimmed-de-15000-dequad-qg/model_mntyya/epoch_5",
+  "pad_token": "<pad>",
+  "sp_model_kwargs": {},
+  "special_tokens_map_file": "/home/patrick/.cache/torch/transformers/685ac0ca8568ec593a48b61b0a3c272beee9bc194a3c7241d15dcadb5f875e53.f76030f3ec1b96a8199b2593390c610e76ca8028ef3d24680000619ffb646276",
+  "tokenizer_class": "T5Tokenizer",
+  "unk_token": "<unk>"
+}

trainer_config.json

@@ -0,0 +1 @@
+{"dataset_path": "lmqg/qg_dequad", "dataset_name": "default", "input_types": "paragraph_answer", "output_types": "question", "prefix_types": null, "model": "vocabtrimmer/mt5-base-trimmed-de-15000", "max_length": 512, "max_length_output": 32, "epoch": 8, "batch": 16, "lr": 0.0001, "fp16": false, "random_seed": 1, "gradient_accumulation_steps": 4, "label_smoothing": 0.15}