Update README.md

README.md

@@ -4,13 +4,34 @@ language:
 license: apache-2.0
 ---
 
-# Abstract 
+# Bigan-Transformer-XL-denoise-1.1B
+
+- Github: [Fengshenbang-LM](https://github.com/IDEA-CCNL/Fengshenbang-LM)
+- Docs: [Fengshenbang-Docs](https://fengshenbang-doc.readthedocs.io/)
+
+## 简介 Brief Introduction
+
+以去噪任务为预训练目标的中文Transformer-XL。
+
+Chinese Transformer-XL with a denoising task as a pre-training target.
+
+## 模型分类 Model Taxonomy
+
+|  需求 Demand  | 任务 Task       | 系列 Series      | 模型 Model    | 参数 Parameter | 额外 Extra |
+|  :----:  | :----:  | :----:  | :----:  | :----:  | :----:  |
+| 特殊 Special | 探索 Exploration | 比干 Bigan | Transformer |      1.1B      |     denoise     |
+
+## 模型信息 Model Information
+
+
+
 This is a Chinese transformer-xl model trained on [Wudao dataset](https://resource.wudaoai.cn/home?ind&name=WuDaoCorpora%202.0&id=1394901288847716352) 
 and finetuned on a denoise dataset constructed by our team. The denoise task is to reconstruct a fluent and clean text from a noisy input which includes random insertion/swap/deletion/replacement/sentence reordering.
 
-## Usage 
+## 使用 Usage
+
+### 加载模型 Loading Models
 
-### load model
 ```python 
 from fengshen.models.transfo_xl_denoise.tokenization_transfo_xl_denoise import TransfoXLDenoiseTokenizer
 from fengshen.models.transfo_xl_denoise.modeling_transfo_xl_denoise import TransfoXLDenoiseModel
@@ -19,7 +40,8 @@ tokenizer = TransfoXLDenoiseTokenizer.from_pretrained('IDEA-CCNL/Bigan-Transform
 model = TransfoXLDenoiseModel.from_pretrained('IDEA-CCNL/Bigan-Transformer-XL-denoise-1.1B')
 ```
 
-### generation
+### 使用示例 Usage Examples
+
 ```python 
 from fengshen.models.transfo_xl_denoise.generate import denoise_generate
 input_text = "凡是有成就的人, 都很严肃地对待生命自己的"
@@ -27,13 +49,31 @@ res = denoise_generate(model, tokenizer,  input_text)
 print(res) # "有成就的人都很严肃地对待自己的生命。"
 ```
 
-## Citation
-If you find the resource is useful, please cite the following website in your paper.
+## 引用 Citation
+
+如果您在您的工作中使用了我们的模型，可以引用我们的[论文](https://arxiv.org/abs/2209.02970)：
+
+If you are using the resource for your work, please cite the our [paper](https://arxiv.org/abs/2209.02970):
+
+```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     = {Fengshenbang 1.0: Being the Foundation of Chinese Cognitive Intelligence},
+  journal   = {CoRR},
+  volume    = {abs/2209.02970},
+  year      = {2022}
+}
 ```
+
+也可以引用我们的[网站](https://github.com/IDEA-CCNL/Fengshenbang-LM/):
+
+You can also cite our [website](https://github.com/IDEA-CCNL/Fengshenbang-LM/):
+
+```text
 @misc{Fengshenbang-LM,
   title={Fengshenbang-LM},
   author={IDEA-CCNL},
-  year={2022},
+  year={2021},
   howpublished={\url{https://github.com/IDEA-CCNL/Fengshenbang-LM}},
 }
-```
+```