readme: ---
  language:
   - zh
  
  tags:
   - question-answering
   - text-generation
  
  pipeline-tag:
   - text-generation
  
  metrics:
   - RougeL
   - BLEU-4
   - F1
   - EM
   - Contain Answer Rate
   
  widget:
  - text: "question:美国建筑师是怎样创造维多利亚哥特式建筑的?"
    context: "knowledge:底特律圣保罗座堂(Cathedral Church of St. Paul)是美国圣公会密歇根教区的主教座堂,位于底特律伍德沃德大道4800号,毗邻韦恩州立大学校园。圣保罗堂区成立于1824年,是密歇根第一个新教堂会。现存建筑由著名教堂设计师拉尔夫·克拉姆(Ralph Adams Cram),始建于1907年,至今钟楼尚未完成。教堂完全用石灰岩和中世纪建筑技术建造,没有支持的钢铁上层建筑。建设拥有交错骨,大片花窗玻璃,雕饰窗格,哥特式建筑的楷模,包括Pewabic 陶瓷中心。在1912年成为教区的主教座堂。圣保罗座堂是20世纪初后期哥特复兴建筑的最佳实例之一。19世纪中叶的美国建筑师输入并重新阐释了英国哥特复兴风格,基于中世纪主教座堂的视觉丰富的细节。美国建筑师将哥特元素与简单的建筑规划相结合,创造了美国建筑风格“维多利亚哥特式”(Victorian Gothic)。兴建于1876年的堡垒街长老会教堂就是早期维多利亚哥特式建筑的杰出例证。answer:<extra_id_0>" 
    example_title: "将哥特元素与简单的建筑规划相结合"
  
  
  licence: apache-2.0
  ---
  # Randeng-T5-784M-QA-Chinese
  T5 for Chinese Question Answering
  - Github: [finetune and predict codes in Fengshenbang-LM](https://github.com/IDEA-CCNL/Fengshenbang-LM/tree/main/fengshen/examples/qa_t5)
  - Docs: [Fengshenbang-Docs](https://fengshenbang-doc.readthedocs.io/)
  
  
  ## 简介 Brief Introduction
  This T5-Large model, is the first pretrained generative question answering model for Chinese in huggingface. It was pretrained on the Wudao 180G corpus, and finetuned on Chinese SQuAD and CMRC2018 dataset. It can produce a fluent and accurate answer given a passage and question.
  
  这是huggingface上首个中文的生成式问答模型。它基于T5-Large结构，使用悟道180G语料在[封神框架](https://github.com/IDEA-CCNL/Fengshenbang-LM/tree/main/fengshen)进行预训练，在翻译的中文SQuAD和CMRC2018两个阅读理解数据集上进行微调。输入一篇文章和一个问题，可以生成准确流畅的回答。
  
  ## 模型类别 Model Taxonomy
  
  |  需求 Demand  | 任务 Task       | 系列 Series      | 模型 Model    | 参数 Parameter | 额外 Extra |
  |  :----:  | :----:  | :----:  | :----:  | :----:  | :----:  |
  | 通用 General | 自然语言转换 NLT | 燃灯 Randeng | T5 |      784M      |     中文生成式问答 -Chinese Generative Question Answering   |
  
  ## 模型表现 Performance 
    
   CMRC 2018 dev (Original span prediction task, we cast it as a generative QA task)
  
   CMRC 2018的测试集上的效果（原始任务是一个起始和结束预测问题，这里作为一个生成回答的问题）
    
     | model | Contain Answer Rate| RougeL | BLEU-4 |F1 | EM | 
     |-------|----|----|--------------------|--------|--------|
     | Ours | 76.0 | 82.7 |61.1|77.9 |57.1|
     |MacBERT-Large(SOTA)|-|-|-|88.9|70.0|
     
     Our model enjoys a high level of generation quality and accuracy, with 76% of generated answers containing the ground truth. The high RougeL and BLEU-4 reveal the overlap between generated results and ground truth. Our model has a lower EM because it generates complete sentences while golden answers are segmentations of sentences. 
     P.S.The SOTA model only predicts the start and end tag as an extractive MRC task. 
  
     我们的模型有着极高的生成质量和准确率，76%的回答包含了正确答案(Contain Answer Rate)。RougeL和BLEU-4反映了模型预测结果和标准答案重合的程度。我们的模型EM值较低，因为生成的大部分为完整的句子，而标准答案通常是句子片段。
     P.S. SOTA模型只需预测起始和结束位置，这种抽取式阅读理解任务比生成式的简单很多。
  
  ## 样例 Cases
  
  Here are random picked samples:
  <img src="https://huggingface.co/IDEA-CCNL/Randeng-T5-784M-QA-Chinese/resolve/main/cases_t5_cmrc.png" div align=middle />
  
  *pred:* in picture are generated results,*target* indicates groud truth.
  
  If the picture fails to display, you can find the picture in Files and versions. 
  
  ## 使用 Usage
  ```python
  import numpy as np
  from transformers import T5Tokenizer,MT5ForConditionalGeneration
  
  pretrain_path = 'IDEA-CCNL/Randeng-T5-784M-QA-Chinese'
  tokenizer=T5Tokenizer.from_pretrained(pretrain_path)
  model=MT5ForConditionalGeneration.from_pretrained(pretrain_path)
  
  sample={"context":"在柏林,胡格诺派教徒创建了两个新的社区:多罗西恩斯塔特和弗里德里希斯塔特。到1700年,这个城市五分之一的人口讲法语。柏林胡格诺派在他们的教堂服务中保留了将近一个世纪的法语。他们最终决定改用德语,以抗议1806-1807年拿破仑占领普鲁士。他们的许多后代都有显赫的地位。成立了几个教会,如弗雷德里夏(丹麦)、柏林、斯德哥尔摩、汉堡、法兰克福、赫尔辛基和埃姆登的教会。","question":"除了多罗西恩斯塔特,柏林还有哪个新的社区?","idx":1}
  plain_text='question:'+sample['question']+'knowledge:'+sample['context'][:self.max_knowledge_length]
  
  res_prefix=tokenizer.encode('answer',add_special_token=False)
  res_prefix.append(tokenizer.convert_tokens_to_ids('<extra_id_0>')
  res_prefix.append(EOS_TOKEN_ID)
  l_rp=len(res_prefix)
  
  tokenized=tokenizer.encode(plain_text,add_special_tokens=False,truncation=True,max_length=self.max_seq_length-2-l_rp)
  
  tokenized+=res_prefix
  
  # Generate answer
  pred_ids = model.generate(input_ids=tokenized,max_new_token=self.max_target_length,do_sample=True,top_p=0.9)
  pred_tokens=tokenizer.batch_decode(pred_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
  res=pred_tokens.replace('<extra_id_0>','').replace('有答案:','')
  ```
  
  
  # 引用 Citation
  如果您在您的工作中使用了我们的模型，可以引用我们的[论文](https://arxiv.org/abs/2210.08590)：
  
  If you are using the resource for your work, please cite the our [paper](https://arxiv.org/abs/2210.08590):
  
  ```text
  @article{fengshenbang,
    author    = {Junjie Wang and Yuxiang Zhang and Lin Zhang and Ping Yang and Xinyu Gao and Ziwei Wu and Xiaoqun Dong and Junqing He and Jianheng Zhuo and Qi Yang and Yongfeng Huang and Xiayu Li and Yanghan Wu and Junyu Lu and Xinyu Zhu and Weifeng Chen and Ting Han and Kunhao Pan and Rui Wang and Hao Wang and Xiaojun Wu and Zhongshen Zeng and Chongpei Chen and Ruyi Gan and Jiaxing Zhang},
    title     = 