readme: 
  ---
  license: cc-by-4.0
  metrics:
  - bleu4
  - meteor
  - rouge-l
  - bertscore
  - moverscore
  language: en
  datasets:
  - lmqg/qg_squadshifts
  pipeline_tag: text2text-generation
  tags:
  - question generation
  widget:
  - text: "<hl> Beyonce <hl> further expanded her acting career, starring as blues singer Etta James in the 2008 musical biopic, Cadillac Records."
    example_title: "Question Generation Example 1" 
  - text: "Beyonce further expanded her acting career, starring as blues singer <hl> Etta James <hl> in the 2008 musical biopic, Cadillac Records."
    example_title: "Question Generation Example 2" 
  - text: "Beyonce further expanded her acting career, starring as blues singer Etta James in the 2008 musical biopic,  <hl> Cadillac Records <hl> ."
    example_title: "Question Generation Example 3" 
  model-index:
  - name: lmqg/bart-large-squadshifts-new_wiki-qg
    results:
    - task:
        name: Text2text Generation
        type: text2text-generation
      dataset:
        name: lmqg/qg_squadshifts
        type: new_wiki
        args: new_wiki
      metrics:
      - name: BLEU4 (Question Generation)
        type: bleu4_question_generation
        value: 12.12
      - name: ROUGE-L (Question Generation)
        type: rouge_l_question_generation
        value: 29.94
      - name: METEOR (Question Generation)
        type: meteor_question_generation
        value: 27.12
      - name: BERTScore (Question Generation)
        type: bertscore_question_generation
        value: 93.39
      - name: MoverScore (Question Generation)
        type: moverscore_question_generation
        value: 66.22
  ---
  
  # Model Card of `lmqg/bart-large-squadshifts-new_wiki-qg`
  This model is fine-tuned version of [lmqg/bart-large-squad](https://huggingface.co/lmqg/bart-large-squad) for question generation task on the [lmqg/qg_squadshifts](https://huggingface.co/datasets/lmqg/qg_squadshifts) (dataset_name: new_wiki) via [`lmqg`](https://github.com/asahi417/lm-question-generation).
  
  
  ### Overview
  - **Language model:** [lmqg/bart-large-squad](https://huggingface.co/lmqg/bart-large-squad)   
  - **Language:** en  
  - **Training data:** [lmqg/qg_squadshifts](https://huggingface.co/datasets/lmqg/qg_squadshifts) (new_wiki)
  - **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="en", model="lmqg/bart-large-squadshifts-new_wiki-qg")
  
  # model prediction
  questions = model.generate_q(list_context="William Turner was an English painter who specialised in watercolour landscapes", list_answer="William Turner")
  
  ```
  
  - With `transformers`
  ```python
  from transformers import pipeline
  
  pipe = pipeline("text2text-generation", "lmqg/bart-large-squadshifts-new_wiki-qg")
  output = pipe("<hl> Beyonce <hl> further expanded her acting career, starring as blues singer Etta James in the 2008 musical biopic, Cadillac Records.")
  
  ```
  
  ## Evaluation
  
  
  - ***Metric (Question Generation)***: [raw metric file](https://huggingface.co/lmqg/bart-large-squadshifts-new_wiki-qg/raw/main/eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_squadshifts.new_wiki.json) 
  
  |            |   Score | Type     | Dataset                                                                    |
  |:-----------|--------:|:---------|:---------------------------------------------------------------------------|
  | BERTScore  |   93.39 | new_wiki | [lmqg/qg_squadshifts](https://huggingface.co/datasets/lmqg/qg_squadshifts) |
  | Bleu_1     |   31.2  | new_wiki | [lmqg/qg_squadshifts](https://huggingface.co/datasets/lmqg/qg_squadshifts) |
  | Bleu_2     |   21.73 | new_wiki | [lmqg/qg_squadshifts](https://huggingface.co/datasets/lmqg/qg_squadshifts) |
  | Bleu_3     |   15.95 | new_wiki | [lmqg/qg_squadshifts](https://huggingface.co/datasets/lmqg/qg_squadshifts) |
  | Bleu_4     |   12.12 | new_wiki | [lmqg/qg_squadshifts](https://huggingface.co/datasets/lmqg/qg_squadshifts) |
  | METEOR     |   27.12 | new_wiki | [lmqg/qg_squadshifts](https://huggingface.co/datasets/lmqg/qg_squadshifts) |
  | MoverScore |   66.22 | new_wiki | [lmqg/qg_squadshifts](https://huggingface.co/datasets/lmqg/qg_squadshifts) |
  | ROUGE_L    |   29.94 | new_wiki | [lmqg/qg_squadshifts](https://huggingface.co/datasets/lmqg/qg_squadshifts) |
  
  
  
  ## Training hyperparameters
  
  The following hyperparameters were used during fine-tuning:
   - dataset_path: lmqg/qg_squadshifts
   - dataset_name: new_wiki
   - input_types: ['paragraph_answer']
   - output_types: ['question']
   - prefix_types: None
   - model: lmqg/bart-large-squad
   - max_length: 512
   - max_length_output: 32
   - epoch: 2
   - batch: 32
   - lr: 5e-05
   - fp16: False
   - random_seed: 1
   - gradient_accumulation_steps: 2
   - label_smoothing: 0.15