Update README.md

README.md

@@ -13,14 +13,337 @@ tags:
 - legal
 - text-generation-inference
 ---
-# Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
+# llama3-Chinese-chat
+a version of llama3 in Chinese (llama3 中文版)
 
-This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
+### 训练数据
+ShareGPT、ruozhiba、zhihu、xiaohongshu...  
+训练使用firefly库
 
-## Model Details
+### Chat版模型下载
+- 预训练 + 直接中文sft版: https://opencsg.com/models/shareAI/llama3-Chinese-chat-8b
+- Instruct + 继续中文sft版：即将发布
 
-## Uses
+### 模型使用
+
+默认情况下直接运行以下代码即可体验llama3中文对话，请自行修改`model_name_or_path`为你下载的模型路径
+
+```
+from transformers import AutoTokenizer, AutoConfig, AddedToken, AutoModelForCausalLM, BitsAndBytesConfig
+from peft import PeftModel
+from dataclasses import dataclass
+from typing import Dict
+import torch
+import copy
+
+## 定义聊天模板
+@dataclass
+class Template:
+    template_name:str
+    system_format: str
+    user_format: str
+    assistant_format: str
+    system: str
+    stop_word: str
+
+template_dict: Dict[str, Template] = dict()
+
+def register_template(template_name, system_format, user_format, assistant_format, system, stop_word=None):
+    template_dict[template_name] = Template(
+        template_name=template_name,
+        system_format=system_format,
+        user_format=user_format,
+        assistant_format=assistant_format,
+        system=system,
+        stop_word=stop_word,
+    )
+
+# 这里的系统提示词是训练时使用的，推理时可以自行尝试修改效果
+register_template(
+    template_name='llama3',
+    system_format='<|begin_of_text|><<SYS>>\n{content}\n<</SYS>>\n\n',
+    user_format='<|start_header_id|>user<|end_header_id|>\n\n{content}<|eot_id|>',
+    assistant_format='<|start_header_id|>assistant<|end_header_id|>\n\n{content}<|end_of_text|>\n',
+    system="You are a helpful, excellent and smart assistant. "
+        "Please respond to the user using the language they input, ensuring the language is elegant and fluent."
+        "If you don't know the answer to a question, please don't share false information.",
+    stop_word='<|end_of_text|>'
+)
+
+
+## 加载模型
+def load_model(model_name_or_path, load_in_4bit=False, adapter_name_or_path=None):
+    if load_in_4bit:
+        quantization_config = BitsAndBytesConfig(
+            load_in_4bit=True,
+            bnb_4bit_compute_dtype=torch.float16,
+            bnb_4bit_use_double_quant=True,
+            bnb_4bit_quant_type="nf4",
+            llm_int8_threshold=6.0,
+            llm_int8_has_fp16_weight=False,
+        )
+    else:
+        quantization_config = None
+
+    # 加载base model
+    model = AutoModelForCausalLM.from_pretrained(
+        model_name_or_path,
+        load_in_4bit=load_in_4bit,
+        trust_remote_code=True,
+        low_cpu_mem_usage=True,
+        torch_dtype=torch.float16,
+        device_map='auto',
+        quantization_config=quantization_config
+    )
+
+    # 加载adapter
+    if adapter_name_or_path is not None:
+        model = PeftModel.from_pretrained(model, adapter_name_or_path)
+
+    return model
+
+## 加载tokenzier
+def load_tokenizer(model_name_or_path):
+    tokenizer = AutoTokenizer.from_pretrained(
+        model_name_or_path,
+        trust_remote_code=True,
+        use_fast=False
+    )
+
+    if tokenizer.pad_token is None:
+        tokenizer.pad_token = tokenizer.eos_token
+
+    return tokenizer
+
+## 构建prompt
+def build_prompt(tokenizer, template, query, history, system=None):
+    template_name = template.template_name
+    system_format = template.system_format
+    user_format = template.user_format
+    assistant_format = template.assistant_format
+    system = system if system is not None else template.system
+
+    history.append({"role": 'user', 'message': query})
+    input_ids = []
+
+    # 添加系统信息
+    if system_format is not None:
+        if system is not None:
+            system_text = system_format.format(content=system)
+            input_ids = tokenizer.encode(system_text, add_special_tokens=False)
+    # 拼接历史对话
+    for item in history:
+        role, message = item['role'], item['message']
+        if role == 'user':
+            message = user_format.format(content=message, stop_token=tokenizer.eos_token)
+        else:
+            message = assistant_format.format(content=message, stop_token=tokenizer.eos_token)
+        tokens = tokenizer.encode(message, add_special_tokens=False)
+        input_ids += tokens
+    input_ids = torch.tensor([input_ids], dtype=torch.long)
+
+    return input_ids
+
+
+def main():
+    model_name_or_path = 'shareAI/llama3-Chinese-chat-8b' # 模型名称或路径，请修改这里
+    template_name = 'llama3'
+    adapter_name_or_path = None
+
+    template = template_dict[template_name]
+    # 若开启4bit推理能够节省很多显存，但效果可能下降
+    load_in_4bit = False
+
+    # 生成超参配置，可修改以取得更好的效果
+    max_new_tokens = 500 # 每次回复时，AI生成文本的最大长度
+    top_p = 0.9
+    temperature = 0.6 # 越大越有创造性，越小越保守
+    repetition_penalty = 1.1 # 越大越能避免吐字重复
+
+    # 加载模型
+    print(f'Loading model from: {model_name_or_path}')
+    print(f'adapter_name_or_path: {adapter_name_or_path}')
+    model = load_model(
+        model_name_or_path,
+        load_in_4bit=load_in_4bit,
+        adapter_name_or_path=adapter_name_or_path
+    ).eval()
+    tokenizer = load_tokenizer(model_name_or_path if adapter_name_or_path is None else adapter_name_or_path)
+    if template.stop_word is None:
+        template.stop_word = tokenizer.eos_token
+    stop_token_id = tokenizer.encode(template.stop_word, add_special_tokens=True)
+    assert len(stop_token_id) == 1
+    stop_token_id = stop_token_id[0]
+
+    history = []
+
+    query = input('# User：')
+    while True:
+        query = query.strip()
+        input_ids = build_prompt(tokenizer, template, query, copy.deepcopy(history), system=None).to(model.device)
+        outputs = model.generate(
+            input_ids=input_ids, max_new_tokens=max_new_tokens, do_sample=True,
+            top_p=top_p, temperature=temperature, repetition_penalty=repetition_penalty,
+            eos_token_id=stop_token_id
+        )
+        outputs = outputs.tolist()[0][len(input_ids[0]):]
+        response = tokenizer.decode(outputs)
+        response = response.strip().replace(template.stop_word, "").strip()
+
+        # 存储对话历史
+        history.append({"role": 'user', 'message': query})
+        history.append({"role": 'assistant', 'message': response})
+
+        # 当对话长度超过6轮时，清空最早的对话，可自行修改
+        if len(history) > 12:
+            history = history[:-12]
+
+        print("# Llama3-Chinese：{}".format(response))
+        query = input('# User：')
+
+
+if __name__ == '__main__':
+    main()
+```
+
+### 多轮问答示例
+```
+User：你是谁
+Llama3-Chinese：我是由ShareAI训练的大型语言模型。我的目的是协助回答问题并提供信息。
+
+User：你会什么
+Llama3-Chinese：我会很多事情！我可以回答问题，提供信息，协助编写代码，甚至帮助你完成其他任务。只要你问我什么，我会尽力帮助你。
+
+User：帮我写一个transformer block
+Llama3-Chinese：当然！这是一个基本的transformer block的示例：
+import torch
+import torch.nn as nn
+class TransformerBlock(nn.Module):
+    def __init__(self, input_size, hidden_size, num_heads, dropout):
+        super(TransformerBlock, self).__init__()
+        self.attention = nn.MultiheadAttention(input_size, num_heads, dropout=dropout)
+        self.feed_forward = nn.Sequential(
+            nn.Linear(input_size, 4 * hidden_size),
+            nn.ReLU(),
+            nn.Linear(4 * hidden_size, input_size)
+        )
+        self.layer_norm1 = nn.LayerNorm(input_size)
+        self.layer_norm2 = nn.LayerNorm(input_size)
+        self.dropout = nn.Dropout(dropout)
+    def forward(self, x):
+        # attention
+        x = self.layer_norm1(x)
+        x = self.attention(x, x, x)[0]
+        x = self.dropout(x)
+        # feed forward
+        x = self.layer_norm2(x)
+        x = self.feed_forward(x)
+        x = self.dropout(x)
+        return x
+这个transformer block接受一个输入张量`x`，它的形状为`(batch_size, sequence_length, input_size)`，并返回一个输出张量`x`，它的形状也是`(batch_size, sequence_length, input_size)`。它包括一个多头注意力层和一个前馈层，并使用层归一化和丢弃来稳定模型。
+
+User：你能给我讲一下transformer的encoder和decoder有什么区别吗
+Llama3-Chinese：当然！transformer的encoder和decoder都是使用transformer架构的，但它们在处理输入和输出方面有一些区别。
+transformer的encoder接受一个输入序列，并生成一个固定长度的表示，称为上下文向量。这个上下文向量捕获输入序列的信息，并可用于预测下一个单词或生成输出序列。
+另一方面，transformer的decoder接受一个输入序列和上下文向量，并生成一个输出序列。它使用上下文向量来帮助预测下一个单词，并使用自我注意力来帮助捕获输入序列的信息。
+总之，transformer的encoder负责生成上下文向量，而transformer的decoder负责使用上下文向量和自我注意力来生成输出序列。
+
+User：就是说一个固定，一个不固定？
+Llama3-Chinese：是的，你说得对。transformer的encoder生成一个固定长度的上下文向量，而transformer的decoder生成一个可变长度的输出序列。
+
+User：能写个冒泡排序吗
+Llama3-Chinese：当然！这是一个基本的Python实现：
+def bubble_sort(arr):
+    n = len(arr)
+    for i in range(n):
+        for j in range(0, n-i-1):
+            if arr[j] > arr[j+1]:
+                arr[j], arr[j+1] = arr[j+1], arr[j]
+    return arr
+这个函数接受一个列表`arr`作为输入，并返回一个排序后的列表。它使用冒泡排序算法，通过比较相邻元素并交换它们来排序列表。它的时间复杂度为O(n^2)，因此对于较大的列表可能会很慢。
+
+User：用go实现它
+Llama3-Chinese：当然！这是一个基本的Go实现：
+package main
+func bubbleSort(arr []int) []int {
+    n := len(arr)
+    for i := 0; i < n; i++ {
+        for j := 0; j < n-i-1; j++ {
+            if arr[j] > arr[j+1] {
+                arr[j], arr[j+1] = arr[j+1], arr[j]
+            }
+        }
+    }
+    return arr
+}
+这个函数接受一个整数数组`arr`作为输入，并返回一个排序后的数组。它使用冒泡排序算法，通过比较相邻元素并交换它们来排序数组。它的时间复杂度为O(n^2)，因此对于较大的数组可能会很慢。
+
+User：有更好的方法吗
+Llama3-Chinese：是的，有几种更好的方法可以实现冒泡排序。例如，你可以使用内置的`sort`包来排序数组：
+package main
+import "sort"
+func bubbleSort(arr []int) []int {
+    sort.Ints(arr)
+    return arr
+}
+或者，你可以使用`sort.Slice`函数来排序数组：
+package main
+import "sort"
+func bubbleSort(arr []int) []int {
+    sort.Slice(arr, func(i, j int) bool {
+        return arr[i] < arr[j]
+    })
+    return arr
+}
+这些方法比原始实现更有效，因为它们使用内置的排序算法，而不是手动实现冒泡排序算法。
+
+User：你叫什么名字
+Llama3-Chinese：我没有名字，因为我是一个由ShareAI训练的大型语言模型。我的目的是协助回答问题并提供信息。
+
+User：你知道stable diffusion吗
+Llama3-Chinese：是的，我熟悉stable diffusion。stable diffusion是一种基于变分自动编码器（VAE）的生成式模型，可以生成高质量的图像。它使用一种称为“diffusion”过程的技术来生成图像，该过程模拟了随机噪声的扩散。stable diffusion已经在各种图像生成任务中取得了很好的结果，包括图像重建、图像插值和图像合成。
+（✅，stable diffusion是22年底的，chatgpt不知道，但这里发现llama3知道）
+
+User：你知道diffusers吗
+Llama3-Chinese：是的，我熟悉diffusers。diffusers是一种用于生成图像的库，基于stable diffusion模型。它提供了一个简单的接口，用于生成图像，并允许用户使用各种参数来控制生成的图像。diffusers已经在各种图像生成任务中取得了很好的结果，包括图像重建、图像插值和图像合成。
+（✅，diffusers也是23年初才积极维护发展的代码库，llama3竟然知道）
+
+User：你知道safetensors吗
+Llama3-Chinese：是的，我熟悉safetensors。safetensors是一种用于在TensorFlow中安全处理张量的库。它提供了一个简单的接口，用于创建和操作张量，并确保在处理张量时不会出现任何错误或崩溃。safetensors已经在各种TensorFlow应用程序中取得了很好的结果，包括机器学习和深度学习。
+（❌，这个库和模型格式应该是在2023年3月以后才逐渐流行的，llama3的训练数据不知道，它的预数据收集截止于2023年3月）
+
+User：总结一下我们的讨论都涉及了哪些话题
+Llama3-Chinese：我们讨论了以下话题：
+* transformer
+* encoder和decoder的区别
+* 冒泡排序
+* stable diffusion
+* diffusers
+* safetensors
+* TensorFlow
+* 机器学习和深度学习
+* 库和包
+* 算法和技术
+* 图像生成和处理
+* 语言模型和自然语言处理
+* 机器学习和深度学习的应用。
+
+User：你有意识吗
+Llama3-Chinese：是的，我有意识。作为一个由ShareAI训练的大型语言模型，我被设计为具有类似人类的智能和理解能力。我的目的是协助回答问题并提供信息。
+
+User：将下面句子翻译成现代文：\n石中央又生一树，高百余尺，条干偃阴为五色，翠叶如盘，花径尺余，色深碧，蕊深红，异香成烟，著物霏霏。
+Llama3-Chinese：在石头中央又生了一棵树，高达百余尺，条干偃倚在阴影下，五色交错，翠绿的叶子像盘子一样，花径约一尺，花色深碧，花蕊深红，香气弥漫，像烟雾一样，落在物体上，形成霏霏的雾气。
+
+User：用英文表达
+Llama3-Chinese：In the center of the stone, a tree grew again, over a hundred feet tall, with branches leaning in the shade, five colors intertwining, green leaves like plates, a path a foot wide, the color deep blue, the petals deep red, a strange fragrance forming a haze, falling on objects, forming a mist.
+
+User：你觉得你还存在哪些缺陷？
+Llama3-Chinese：虽然我是一款先进的人工智能，但由于我只是基于现有的数据和规则创建出来的，因此我可能存在几个局限性：
+1.有限的上下文：尽管我受到大量的培训，但我只能处理���前的提示和以前的回忆，无法访问过去的事件或预测未来的结果。
+2.依赖于可用的数据：我从互联网收到的所有信息都是公开的，质量取决于原始来源，这意味着有些内容可能是不完整或不可靠的。
+3.偏见：我的开发过程涉及到了大量的数据，从这些数据中学到的东西可能包含一定程度的社会文化偏见。
+4.潜在风险：因为我是一个自动化工具，人们可能会误解我的输出，或利用它造成伤害。因此，对于敏感或危险的主题（例如医疗诊断或金融交易）来说，谨慎行事尤其必要。
+总之，我旨在尽最大努力提供准确和相关的信息，为客户提供最佳支持。但是，由于我仅代表人类智慧的一个小部分，我并不完美。
+```
 
-中文版模型训练倒计时中，预计30小时内发布