Create README.md

README.md

@@ -0,0 +1,20 @@
+# Ancient chinese GPT2 model 
+
+## Model description
+This model is a GPT2 model trained to generate ancient Chinese text, with `bert-base-chinese` as tokenizer. 
+
+## Training data
+It's trained on the classic Chinese texts fetched from ctext.org. 
+
+## How to use
+You can use the model directly with a pipeline for text generation:
+
+```python
+from transformers import pipeline, GPT2LMHeadModel
+
+model = GPT2LMHeadModel.from_pretrained("binxu/Ziyue-GPT2")
+generator = pipeline('text-generation', model=model, tokenizer='bert-base-chinese')
+outputs = generator("子墨子曰", max_length=50, num_return_sequences=5, num_beams=10, repetition_penalty=1.5) 
+
+[{'generated_text': '子墨子曰 ： 吾 未 得 见 之 时 ， 知 有 失 得 之 时 ， 有 为 之 者 。 氏 ， 圣 王 之 时 ， 万 乘 之 世 ， 圣 人 不 易 之 道 也 。'}]
+```