Update README.md (#1)

- Update README.md (f651f11642bc8003af28e92ea18c83de488e9e49)


Co-authored-by: XueHang <xuehaha@users.noreply.huggingface.co>

README.md

@@ -1,4 +1,200 @@
 ---
+inference:
+  parameters:
+    max_length: 250
+    temperature: 0.7
+    top_p: 1
+license: creativeml-openrail-m
+widget:
+- text: 用户：帮我写个请假条，我因为新冠不舒服，需要请假3天，请领导批准\n小元：
+- text: >-
+    用户：新冠什么症状？\n小元：新冠是指新型冠状病毒，其症状包括发热、干咳、乏力、嗅味觉减退、呼吸困难等。\n用户：可以吃什么药？\n小元：根据您提供的病史，目前没有明确的抗新冠病毒的药物，建议您在家进行自我隔离，避免与他人接触，多喝开水，清淡易消化饮食，避免熬夜和过度劳累，适当进行户外活动。\n用户：用什么后遗症么？\n小元：
 library_name: paddlenlp
 ---
-# ClueAI/ChatYuan-large-v1-paddle
+
+<a href="https://colab.research.google.com/drive/14B5_EyAXduE1WTaPiDs90-4Atsy7uaoy?usp=sharing">
+<img src="https://colab.research.google.com/assets/colab-badge.svg"></a>
+
+ChatYuan: 元语功能型对话大模型
+
+这个模型可以用于问答、结合上下文做对话、做各种生成任务，包括创意性写作，也能回答一些像法律、新冠等领域问题。它基于PromptCLUE-large结合数亿条功能对话多轮对话数据进一步训练得到。
+
+<a href='https://www.cluebenchmarks.com/clueai.html'>PromptCLUE-large:</a>在1000亿token中文语料上预训练，累计学习1.5万亿中文token，并且在数百种任务上进行Prompt任务式训练。针对理解类任务，如分类、情感分析、抽取等，可以自定义标签体系；针对多种生成任务，可以进行采样自由生成。 
+
+<a href='https://www.yuanyu.ai'>在线Demo(微信搜索小程序“元语智能”)</a> &nbsp; | 
+  <a href='https://www.clueai.cn'>使用API(large版)</a> &nbsp; | 
+ &nbsp; <a href='https://github.com/clue-ai/ChatYuan'>Github项目地址</a>&nbsp; |
+  &nbsp;<a href='https://colab.research.google.com/drive/14B5_EyAXduE1WTaPiDs90-4Atsy7uaoy?usp=sharing#scrollTo=QokO0pdGmAYH'>Colab在线试用</a> 
+
+   微信扫码在线体验：
+   
+   <img src="https://huggingface.co/ClueAI/ChatYuan-large-v1/resolve/main/chatyuan_wechat.jpg"  width="30%" height="30%" /> 
+
+
+加载模型：
+ 
+ ```python
+# 加载模型
+from paddlenlp.transformers import AutoTokenizer, T5ForConditionalGeneration
+
+tokenizer = AutoTokenizer.from_pretrained("ClueAI/ChatYuan-large-v1", from_hf_hub=False)
+model = T5ForConditionalGeneration.from_pretrained("ClueAI/ChatYuan-large-v1", from_hf_hub=False)
+ ```
+
+使用模型进行预测推理方法：
+```python
+# 使用
+import torch
+
+# 这里使用的是paddle的gpu版本，修改colab笔记本设置为gpu，推理更快
+
+def preprocess(text):
+  text = text.replace("\n", "\\n").replace("\t", "\\t")
+  return text
+
+def postprocess(text):
+  return text.replace("\\n", "\n").replace("\\t", "\t")
+
+def answer(text, sample=True, top_p=1, temperature=0.7):
+  '''sample：是否抽样。生成任务，可以设置为True;
+  top_p：0-1之间，生成的内容越多样'''
+  text = preprocess(text)
+  encoding = tokenizer(text=[text], truncation=True, padding=True, max_length=768, return_tensors="pd")
+  if not sample:
+    out = model.generate(**encoding, return_dict_in_generate=True, output_scores=False, max_length=512, max_new_tokens=512, num_beams=1, length_penalty=0.4)
+  else:
+    out = model.generate(**encoding, return_dict_in_generate=True, output_scores=False, max_length=512, max_new_tokens=512, do_sample=True, top_p=top_p, temperature=temperature, no_repeat_ngram_size=3)
+  
+  out_text = tokenizer.batch_decode(out[0], skip_special_tokens=True)
+  
+  return postprocess(out_text[0])
+print("end...")
+```
+
+# 问答、写作与功能型助手
+```python
+input_text0 = "帮我写一个请假条，我因为新冠不舒服，需要请假3天，请领导批准"
+input_text1 = "你能干什么"
+input_text2 = "用英文写一封道歉的邮件，表达因为物流延误，不能如期到达，我们可以赔偿贵公司所有损失"
+input_text3 = "写一个文章，题目是未来城市"
+input_text4 = "写一个诗歌，关于冬天"
+input_text5 = "从南京到上海的路线"
+input_text6 = "学前教育专业岗位实习中，在学生方面会存在问题，请提出改进措施。800字"
+input_text7 = "根据标题生成文章：标题：屈臣氏里的化妆品到底怎么样？正文：化妆品，要讲究科学运用，合理搭配。屈臣氏起码是正品连锁店。请继续后面的文字。"
+input_text8 = "帮我对比几款GPU，列出详细参数对比，并且给出最终结论"
+input_list = [input_text0, input_text1, input_text2, input_text3, input_text4, input_text5, input_text6, input_text7, input_text8]
+for i, input_text in enumerate(input_list):
+  input_text = "用户：" + input_text + "\n小元："
+  print(f"示例{i}".center(50, "="))
+  output_text = answer(input_text)
+  print(f"{input_text}{output_text}")
+```  
+
+=======================示例0========================  
+用户：帮我写一个请假条，我因为新冠不舒服，需要请假3天，请领导批准  
+小元：尊敬的领导：  
+
+您好!  
+
+因为最近新冠病毒的流行，我感到身体不舒服，所以请求请假3天，在这段时间内，我将积极配合医生的治疗，保证充足的睡眠，并做好防护工作。  
+ 
+在此期间，我保证将努力完成我的工作，并按时下班，在请假期间，我绝对遵守公司的规章制度，接受公司的监督和检查，请领导批准。  
+谢谢!   
+  
+此致  
+
+敬礼!   
+
+=======================示例1========================  
+用户：你能干什么  
+小元：您好!我是元语AI。我可以回答您的问题、写文章、写作业、翻译，对于一些法律等领域的问题我也可以给你提供信息。  
+=======================示例2========================  
+用户：用英文写一封道歉的邮件，表达因为物流延误，不能如期到达，我们可以赔偿贵公司所有损失  
+小元：E-mail apologies to your company for not reaching your delivery due to delay in logistics, we can compensate you for all losses.  
+=======================示例3========================  
+用户：写一个文章，题目是未来城市  
+小元：未来的城市是怎样的呢？  
+  
+未来城市拥有很多不同的功能，如智慧城市、智能交通系统、远程医疗系统、智能家居系统、智慧医疗系统等。未来城市还使用物联网技术，可以远程控制，使用远程操控和传感器来监控城市的发展，帮助他们解决各种城市问题。  
+  
+未来的城市还采用互联网技术，可以让城市变得更智能，让城市变得更智慧，让每一个人都能更轻松地生活。未来城市的智能设备也可以让城市的使用者更方便地掌握他们的生活，比如智能的智能交通系统和远程医疗系统和智能的安防系统等，可以提供他们更多的便利。  
+总之，未来城市的愿景是，让所有城市的使用者都能拥有一个美好的未来，让他们可以在自己的城市享受美好的生活。  
+=======================示例4========================  
+用户：写一个诗歌，关于冬天  
+小元：冬夜寂静冷， 
+云在天边飘，  
+冰封白雪上，  
+寒冷像一场雪。 
+ 
+雪花融化成冰，  
+像那雪花飘洒，  
+在寒冷的冬天，  
+感受春天的喜悦。  
+ 冬日里， 
+风雪渐消，  
+一片寂静，  
+把快乐和温暖带回家。    
+=======================示例5========================  
+用户：从南京到上海的路线  
+小元：你好，南京到上海的路线如下：  
+  
+1. 南京到上海，可以乘坐南京地铁1号线，在南京站乘坐轨道交通1号线。  
+ 
+2. 南京到浦东机场，可以搭乘上海地铁1号，在陆家嘴站乘坐地铁1线，在浦东国际机场站乘坐机场快线，前往上海浦东国际机场。  
+  
+3. 上海到南京，可以换乘上海地铁2号线，从南京站换乘地铁2线，再从南京南站换乘地铁1路，然后到达上海站。    
+ 
+=======================示例6========================  
+用户：学前教育专业岗位实习中，在学生方面会存在问题，请提出改进措施。800字  
+小元：在学前教育专业岗位实习中，在学生方面会存在一些问题，如学生缺少专业知识、缺乏合作意识、缺乏基本的责任心等等，需要我们采取措施，来解决这些问题。  
+  
+首先，在实习过程中，我们需要培养学生的团队意识，加强学生与老师之间的合作，加强与家长之间的沟通，提高他们的沟通能力。另外，我们也需要加强学生的独立性，让学生学会独立思考，学会和老师、家长进行沟通，培养其独立性。  
+此外，在日常的工作中，我们也要为学生提供适当的机会和机会，让学生多接触社会、多参加社会活动，加深他们对社会、学校的认识，培养他们主动、积极和创新的精神。  
+最后，我们还需要重视学生在实习中出现的问题，尤其是学生缺乏合作，有依赖心理，不懂得分享，有拖延行为等，这些学生应该引起我们的重视，制定合理的改进措施，改善这些问题。   
+=======================示例7========================  
+用户：根据标题生成文章：标题：屈臣氏里的化妆品到底怎么样？正文：化妆品，要讲究科学运用，合理搭配。屈臣氏起码是正品连锁店。请继续后面的文字。 
+
+小元：在屈臣氏买东西，要讲究科学运用，合理搭配。屈臣家起码是正品连锁店。下面，我就拿“化妆品”来说说屈臣家的化妆品。“化妆品”(护肤品、粉底液)产品种类多，产品品牌多，销售方式多样，产品种类比较齐全。屈氏是全港最大最大的化妆品超市之一。屈购是屈臣买日用品有限公司的简称。屈购物品在屈购商场经营，在屈购物市经营的屈购公司有7家，分别是：屈购商城、屈购超市、���取电器、屈拿电器、悦活、悦养、雅活，在“屈购”经营的商品有：洗发水、眼霜、口红、面霜、润肤露、面膜、洗发精、沐浴露、香皂、化妆品、沐浴产品、洁肤产品、洗衣液、护发素、洗护用品、化妆品用品、男士化妆品。屈买商品有：护肤霜、护肤粉底霜、眼影、指甲油、香水、身体洗发露、防晒产品、防晒用品、润发产品、美容工具、化妆品等。屈商的化妆品品种繁多，种类繁多，其中化妆品有100多种，占香港商品总量的   
+=======================示例8========================  
+用户：帮我对比几款GPU，列出详细参数对比，并且给出最终结论  
+小元：一、显存容量：  
+  
+1 GeForce GTX 880 显存类型：GDDR5  
+2 Geforce RTX 1060 显存在类型：PhysX物理加速 
+3 Ge force MX150 显存在于类型：SLI  
+4 GetoDirectX 11：支持DX11  
+二、显显存带宽：  
+1.GDDR4X 显显容量：256MB  
+2.GDDR6X 最大显存范围：8GB  
+3.GDDR3 显在带宽：120GB  
+4.GDDR7 显适用于2GB显存 
+三、显效时间：  
+1.4 GB/s 
+2. 5.5 ms 
+3. 5 ms     
+
+# 多轮对话
+```python
+input_text = ["你好","新冠什么症状？","可以吃什么药？"]
+answer_text = ["您好!我是元语AI。我可以回答您的问题、写文章、写作业、翻译，对于一些法律等领域的问题我也可以给你提供信息", "新冠是指新型冠状病毒，其症状包括发热、干咳、乏力、嗅味觉减退、呼吸困难等。", "根据您提供的病史，目前没有明确的抗新冠病毒的药物，建议您在家进行自我隔离，避免与他人接触，多喝开水，清淡易消化饮食，避免熬夜和过度劳累，适当进行户外活动。"]
+context = "\n".join([f"用户：{input_text[i]}\n小元：{answer_text[i]}" for i in range(len(input_text))])
+print(context)
+
+input_text = "用什么后遗症么？"
+print(f"示例".center(50, "="))
+input_text = context + "\n用户：" + input_text + "\n小元："
+output_text = answer(input_text)
+print(f"{input_text}{output_text}")
+```    
+========================示例========================  
+用户：你好  
+小元：您好!我是元语AI。我可以回答您的问题、写文章、写作业、翻译，对于一些法律等领域的问题我也可以给你提供信息  
+用户：新冠什么症状？  
+小元：新冠是指新型冠状病毒，其症状包括发热、干咳、乏力、嗅味觉减退、呼吸困难等。  
+用户：可以吃什么药？  
+小元：根据您提供的病史，目前没有明确的抗新冠病毒的药物，建议您在家进行自我隔离，避免与他人接触，多喝开水，清淡易消化饮食，避免熬夜和过度劳累，适当进行户外活动。  
+用户：用什么后遗症么？  
+小元：目前还没有人具体说是什么后遗症，但是目前症状比较轻的，可能没有后遗症，但是如果症状比较重，就可能出现呼吸困难，胸闷，发热，咳嗽等症状。 
+
+### 技术交流和问题反馈
+<a href='https://github.com/clue-ai/ChatYuan#%E6%8A%80%E6%9C%AF%E4%BA%A4%E6%B5%81%E5%92%8C%E9%97%AE%E9%A2%98%E5%8F%8D%E9%A6%88%E6%89%AB%E7%A0%81%E5%9C%A8%E7%BA%BF%E4%BD%93%E9%AA%8C%E5%B0%8F%E7%A8%8B%E5%BA%8F%E6%88%96%E5%85%A5%E7%BE%A4'>加微信入讨论群</a>