Update READEME

README.md

@@ -0,0 +1,103 @@
+---
+language: Chinese
+datasets: CLUECorpusSmall
+widget: 
+- text: "这是很久之前的事情了"
+
+
+---
+
+
+# Chinese GPT2 Model
+
+## Model description
+
+The model is used to generate Chinese texts. You can download the model either from the [GPT2-Chinese Github page](https://github.com/Morizeyao/GPT2-Chinese), or via HuggingFace from the link [gpt2-chinese-cluecorpussmall](https://huggingface.co/uer/gpt2-chinese-cluecorpussmall).
+
+## How to use
+
+You can use the model directly with a pipeline for text generation:
+
+```python
+>>> from transformers import BertTokenizer, GPT2LMHeadModel, TextGenerationPipeline
+>>> tokenizer = BertTokenizer.from_pretrained("uer/gpt2-chinese-cluecorpussmall")
+>>> model = GPT2LMHeadModel.from_pretrained("uer/gpt2-chinese-cluecorpussmall")
+>>> text_generator = TextGenerationPipeline(model, tokenizer)   
+>>> text_generator("这是很久之前的事情了", max_length=100, do_sample=True)
+    [{'generated_text': '这是很久之前的事情了 ！ 这 件 事 情 之 后 我 每 天 都 问 自 己 ， 对 未 来 的 影 响 是 什 么 ？ 在 这 个 过 程 中 我 一 直 提 高 自 己 的 理 论 和 实 践 能 力 ， 比 如 说 ， 我 们 现 在 有 很 多 很 多 的 投 资 行 为 可 以 赚 钱 ， 在 美 国 有 很 多 交 易 行 为 ， 是 一 个 比 较 灵 活 的 模'}]
+```
+
+
+
+## Training data
+
+[CLUECorpusSmall](https://github.com/CLUEbenchmark/CLUECorpus2020/) is used as training data. 
+
+## Training procedure
+
+The model is pre-trained by [UER-py](https://github.com/dbiir/UER-py/) on [Tencent Cloud TI-ONE](https://cloud.tencent.com/product/tione/). We pre-train 1,000,000 steps with a sequence length of 128 and then pre-train 250,000 additional steps with a sequence length of 1024. 
+
+Stage1:
+
+```
+python3 preprocess.py --corpus_path corpora/cluecorpussmall.txt \
+                      --vocab_path models/google_zh_vocab.txt \
+                      --dataset_path cluecorpussmall_lm_seq128_dataset.pt \
+                      --seq_length 128 --processes_num 32 --target lm 
+```
+
+```
+python3 pretrain.py --dataset_path cluecorpussmall_lm_seq128_dataset.pt \
+                    --vocab_path models/google_zh_vocab.txt \
+                    --output_model_path models/cluecorpussmall_gpt2_seq128_model.bin \
+                    --config_path models/gpt2/config.json \
+                    --world_size 8 --gpu_ranks 0 1 2 3 4 5 6 7 \
+                    --total_steps 1000000 --save_checkpoint_steps 100000 --report_steps 50000 \
+                    --learning_rate 1e-4 --batch_size 64 \
+                    --embedding word_pos --remove_embedding_layernorm \
+                    --encoder transformer --mask causal --layernorm_positioning pre \
+                    --target lm --tie_weight 
+```
+
+Stage2:
+
+```
+python3 preprocess.py --corpus_path corpora/cluecorpussmall.txt \
+                      --vocab_path models/google_zh_vocab.txt \
+                      --dataset_path cluecorpussmall_lm_seq1024_dataset.pt \
+                      --seq_length 1024 --processes_num 32 --target lm 
+```
+
+```
+python3 pretrain.py --dataset_path cluecorpussmall_lm_seq1024_dataset.pt \
+                    --pretrained_model_path models/cluecorpussmall_gpt2_seq128_model.bin-1000000 \
+                    --vocab_path models/google_zh_vocab.txt \
+                    --output_model_path models/cluecorpussmall_gpt2_seq1024_model.bin \
+                    --config_path models/gpt2/config.json \
+                    --world_size 8 --gpu_ranks 0 1 2 3 4 5 6 7 \
+                    --total_steps 250000 --save_checkpoint_steps 50000 --report_steps 10000 \
+                    --learning_rate 5e-5 --batch_size 16 \
+                    --embedding word_pos --remove_embedding_layernorm \
+                    --encoder transformer --mask causal --layernorm_positioning pre \
+                    --target lm --tie_weight 
+```
+
+Finally, we convert the pre-trained model into Huggingface's format:
+
+```
+python3 scripts/convert_gpt2_from_uer_to_huggingface.py --input_model_path cluecorpussmall_gpt2_seq1024_model.bin-250000 \
+                                                        --output_model_path pytorch_model.bin \
+                                                        --layers_num 12
+```
+
+### BibTeX entry and citation info
+
+```
+@article{zhao2019uer,
+  title={UER: An Open-Source Toolkit for Pre-training Models},
+  author={Zhao, Zhe and Chen, Hui and Zhang, Jinbin and Zhao, Xin and Liu, Tao and Lu, Wei and Chen, Xi and Deng, Haotang and Ju, Qi and Du, Xiaoyong},
+  journal={EMNLP-IJCNLP 2019},
+  pages={241},
+  year={2019}
+}
+```