Update README.md

README.md

@@ -14,20 +14,18 @@ license: apache-2.0
 
 代码部分在：https://github.com/ViperEkura/KHAOSZ/tree/main
 
-代码遵循 apache-2.0 协议， 使用时请注明代码来源
+- **📊设备选择**：当前代码默认使用CUDA进行训练
+- **🌐性能优化**：代码中设置了`dtype=torch.bfloat16`来启用训练，这有助于提高训练速度和降低显存消耗，但需确保硬件支持此特性。
+- **🤖语言支持**：该模型目前支持在中文和英文数据集上训练， 在训练分词器时没有加入其他语言的文本，BBPE分词器不会存在OOV问题，但是对别的语言支持比较差
 
-- **设备选择**：当前代码默认使用CUDA进行训练
-- **性能优化**：代码中设置了`dtype=torch.bfloat16`来启用训练，这有助于提高训练速度和降低显存消耗，但需确保硬件支持此特性。
-- **语言支持**：该模型目前支持在中文和英文数据集上训练， 在训练分词器时没有加入其他语言的文本，BBPE分词器不会存在OOV问题，但是对别的语言支持比较差
-
-### 1. 如何训练
+## 📌如何训练
 
 要训练这个Transformer模型，您可以按照以下步骤进行操作：
 
 (1). 准备数据集：
 
 确保您的数据集位于一个指定的根目录下。数据集应包含用于训练的文本文件，这些文件可以是中文、英文或两者混合。
-数据文件的格式应与模型的输入要求一致，最好是经过tokenizer处理过后的token_id
+数据文件的格式应与模型的输入要求一致，最好是经过tokenizer处理过后的token_id, 为了节省内存占用采用torch.Tensor 存储id,(如果使用python的list, 在读取训练数据的时候内存占用大概是原来的两倍以上，因为python似乎是默认采用64位数精度存储的数据， 但是实际上int32足够)
 
 (2).安装依赖：
 
@@ -43,6 +41,7 @@ conda env create -f environment.yml --name env_name
 
 ```bash
 python train.py \
+--train_type=train_type[seq, sft, dpo] \
 --data_root_path=/path/to/dataset \
 --n_epoch=5 \
 --batch_size=8 \
@@ -50,6 +49,7 @@ python train.py \
 --n_iter_ckpt=10000 \
 --ckpt_dir checkpoints 
 ```
+--train_type: 指定训练的类型，可选值有seq, sft, dpo
 
 --data_root_path：指定数据集的根目录路径。
 
@@ -73,7 +73,7 @@ python train.py \
 检查点文件会保存在指定的检查点目录中，您可以使用这些检查点文件来恢复训练或进行评估。
 
 
-### 2. 如何使用
+## 👉如何使用
 如果您想使用这个模型进行对话聊天, 请打开 chat.py 文件，并运行它。
 或者， 您可以使用流式输出接口/对话生成接口完成对话
 
@@ -93,12 +93,12 @@ while True:
     for response, histroy in model.stream_generate(
         query=query, 
         history=histroy,
-        temperature=0.95,
-        top_p=0.9,
+        temperature=0.85,
+        top_p=0.95,
+        top_k=50
     ):
         print(response[response_size:], end="")
         response_size = len(response)       
-    print()
 
 ```
 
@@ -120,13 +120,14 @@ while True:
     response =  model.generate(
         query=query, 
         history=histroy,
-        temperature=0.95,
-        top_p=0.9,
+        temperature=0.85,
+        top_p=0.95,
+        top_k=50
     )
     print(response)
 ```
 
-### 其他问题
+## 📌其他问题
 本模型基于20层的transformer，参数大致设置如`config.json`，参数大小为4亿（0.40b）
 
 模型采用权重绑定， embedding层的权重和最后线性层的权重是共享的（比较小的模型都采用这种方式节省参数大小， 因为不采用权重绑定， embedding层假设有10000单词， 将会占用 10000 * 1024 = 102,400,000 参数， 也就是 0.1b 参数， 因为词表会占用太多的参数， 所以采用权重绑定是小模型的通用方法）