hcgf 0.1.0

Humanable ChatGPT/GLM Fine-tuning.

先clone仓库或pip安装：

pip install hcgf

需要的依赖在requirements.txt中，通过下面命令安装：

pip install -r requirements.txt

注意：不支持PyTorch2.0，历史版本请参考下面链接安装：

https://pytorch.org/get-started/previous-versions/

微调

准备数据

每一行一个dict的.json文件，必须包含prompt和completion两个字段。示例如下：

{"prompt": "你是谁？", "completion": "不告诉你。"}

正常微调

至少需要一张16G显存的卡。如果不指定显卡，默认为cuda。

#===== 微调 =====#
import hcgf
gl = hcgf.GlmLora("THUDM/chatglm-6b", device="cuda:0")
gl.load_data("/path/to/data.json").tune()

#===== 推理 =====#
gl = hcgf.GlmLora("THUDM/chatglm-6b", device="cuda:0")
gl.load_pretrained("/path/to/lora_pt").eval()
gl.chat("你是谁?")

#===== 切换模式 =====#
gl = hcgf.GlmLora("THUDM/chatglm-6b", device="cuda:0")
gl.load_data("/path/to/data.json").tune()
# 切换到推理模式
gl.eval()
gl.chat("你是谁？")
# 切换回微调模式，还是用原来的数据继续跑
gl.tune()
# 如果有新的数据集，参考上面的写法，先加载数据
gl.load_data("/path/to/new_data.json").tune()
# 如果在原来的基础上用新数据继续微调，先加载之前的pt文件，再加载数据微调
gl.load_pretrained("/path/to/lora_pt").load_data("/path/to/new_data.json").tune()

8bit微调

至少需要一张12G显存的卡。不指定device。只需要初始化时改一下即可，其他操作和上面正常微调一样。

需要安装依赖: bitsandbytes

gl = hcgf.GlmLora("THUDM/chatglm-6b", load_in_8bit=True)

继续微调

先加载之前的pt文件，然后加载数据微调。

gl.load_pretrained("/path/to/lora_pt").load_data("/path/to/new_data.json").tune()

参数说明

主要有三个方法的参数，有值的表示默认值。

load_data(
    data_path: str, 
    max_seq_len: int = 512, # 句子最大长度，超过会截断
)
tune(
    batch_size: int = 1,
    lr: float = 2e-4,
    num_epochs: int = 10,
    warmup_steps: Optional[int] = None,     # 为None时会用第一个Epoch进行warmup
    accumulate_steps: Optional[int] = 32,
    out_dir: str = "./output/",
    print_every: int = 10,                  # 每隔多少个Step打印一次输出（Step、Loss、LearningRate）
)
chat(
    inp: str, 
    history: List[Tuple[str, str]] = None,  # (问，答)Pair对
    max_len: int = 512,                     # 上下文的最大长度，超过就不生成了
    temperature: float = 0.95,              # 越小越确定，越大越随机，比如你微调后可以把它改成0.2
    top_p: float = 0.7,                     # 同上，两者不要同时调
    stop: List[str] = []                    # 停止文本，可以是标点、特定词或句子等，输出不包含停止文本
)

配置

有几个影响显存的参数可以配置：max_seq_len，batch_size。

(
gl
.load_data("./data/chatgpt_finetune_faq.json", max_seq_len=128)
.tune(batch_size=1)
)

不同配置 8bit 资源占用：

max_seq_len	batch_size	memory
64	1	11G
128	1	12G
512	1	22G
128	2	15G
128	4	21G

不同配置正常资源占用：

max_seq_len	batch_size	memory
64	1	15G
128	1	16G
512	1	30G
128	2	19G
128	4	25G

RM

使用小模型（如BERT等）训练。

训练

准备数据

需要pair对数据，计算logits过程和普通预训练模型一样（一个Batch多个pair对）；计算loss时属于同一个pair对的logits放一块算。

推理时直接用logits就行。

推理

测试

# 全部测试
python -m pytest
# 测试训练和推理，比较慢
python -m pytest -s -m slow
# 测试其他的
python -m pytest -m "not slow"

版本说明

如果你用的是旧版本的ChatGLM（icetk tokenizer），可以安装hcgf==0.0.7版本，同时，需要手动指定model_id参数为模型文件实际路径。

即将"THUDM/chatglm-6b"替换为transformers cache的对应snapshots下的id。或者，建议手动clone仓库：

git lfs install
git clone https://huggingface.co/THUDM/chatglm-6b

然后切换到早期使用icetk的commit。这时候要替换的就是这个仓库的路径了。

更新日志

• v0.1.0 20230412
  • 支持ChatGLM新版Tokenizer
  • 使用官方调整后的MASK方式
• v0.0.7 20230405