Home

Awesome

TigerBot

<p align="center" width="100%"> <img src="image/logo_core.png" alt="Tiger" style="width: 20%; display: block; margin: auto;"></img> </p> <p align="center"> <font face="黑体" color=orange size=5"> A cutting-edge foundation for your very own LLM. </font> </p> <p align="center"> <font face="黑体" color=orange size=5"> 以世界级的基础大模型,贡献于中国式的创新。 </font> </p> <p align="center"> 🌐 <a href="https://tigerbot.com/" target="_blank">TigerBot</a> • 🤗 <a href="https://huggingface.co/TigerResearch" target="_blank">Hugging Face</a> • 💻<a href="https://modelscope.cn/organization/TigerResearch" target="_blank">ModelScope</a> </p> <div align="center">

evaluation

</div> <h4 align="left"> <p> <b>中文</b> | <a href="https://github.com/TigerResearch/TigerBot/blob/main/README_en.md">English</a> <p> </h4>

最新发布

<p align="center" width="100%"> <img src="image/search-link.jpg" alt="search-link" style="width: 80%; display: block; margin: auto;"> </p>

https://github.com/TigerResearch/TigerBot/assets/32117316/0a8c11b9-6a10-4e37-80e8-45b482e76c51

<p align="center" width="100%"> <img src="image/api/search/demo.png" alt="tigerbot search-api sample" style="width: 65%; display: block; margin: auto;"></a> </p> <p align="center" width="100%"> <img src="image/peft_metrics.png" alt="tigerbot chat-api sample" style="width: 65%; display: block; margin: auto;"></a> </p> <p align="center" width="100%"> <img src="image/tigerbot_chatapi_sample.png" alt="tigerbot chat-api sample" style="width: 65%; display: block; margin: auto;"></a> </p>

目录

环境安装


conda create --name tigerbot python=3.8
conda activate tigerbot
conda install pytorch torchvision torchaudio pytorch-cuda=11.7 -c pytorch -c nvidia

git clone https://github.com/TigerResearch/TigerBot
cd TigerBot
pip install -r requirements.txt

模型下载

ModelVersionArchitectureDisk size (GB)Note
tigerbot-70b-basev2 [🤗][🤖]llama-2129From llama-2-70b weights
v1 [🤗][🤖]llama-2129From llama-2-70b weights
tigerbot-70b-chatv6 [🤗][🤖]llama-2129From tigerbot-70b-base v2
v4-4k [🤗][🤖]llama-2129From tigerbot-70b-base v2
v4 [🤗][🤖]llama-2129From tigerbot-70b-base v2
v3 [🤗][🤖]llama-2129From tigerbot-70b-base v1
v2 [🤗][🤖]llama-2129From tigerbot-70b-base v1
v1 [🤗]llama-2129From tigerbot-70b-base v1
tigerbot-70b-chat-4bitv6 [🤗]llama-237From tigerbot-70b-chat v6
v4 [🤗]llama-237From tigerbot-70b-chat v4
v3 [🤗]llama-237From tigerbot-70b-chat v3
v2 [🤗]llama-237From tigerbot-70b-chat v2
v1 [🤗]llama-237From tigerbot-70b-chat v1
tigerbot-13b-basev3 [🤗][🤖]llama-226.6From llama-2-13b weights
v2 [🤗][🤖]llama-226.6From llama-2-13b weights
v1 [🤗]llama-226.6From llama-2-13b weights
tigerbot-13b-chatv6 [🤗][🤖]llama-226.6From tigerbot-13b-base v3
v5 [🤗][🤖]llama-226.6From tigerbot-13b-base v3
v5 [🤗][🤖]llama-226.6From tigerbot-13b-base v3
v4 [🤗][🤖]llama-226.6From tigerbot-13b-base v2
v3 [🤗][🤖]llama-226.6From tigerbot-13b-base v2
v2 [🤗]llama-226.6From tigerbot-13b-base v2
v1 [🤗]llama-226.6From tigerbot-13b-base v1
tigerbot-13b-chat-4bitv6 [🤗]llama-211.5From tigerbot-13b-chat v6
v5 [🤗]llama-211.5From tigerbot-13b-chat v5-4k
v4 [🤗]llama-211.5From tigerbot-13b-chat v4
tigerbot-7b-basev3 [🤗][🤖]llama-213.9From llama-2-7b weights
v2 [🤗]bloom16.2From bloom weights
v1 [🤗]bloom16.2From bloom weights
tigerbot-7b-chatv3 [🤗][🤖]llama-213.9From tigerbot-7b-base v3
v2 [🤗]bloom16.2From tigerbot-7b-base v2
v1 [🤗]bloom16.2From tigerbot-7b-base v1
tigerbot-7b-chat-8bitv3 [🤗]llama-210.8From tigerbot-7b-chat v3
tigerbot-7b-chat-4bitv3 [🤗]llama-26.5From tigerbot-7b-chat v3
tigerbot-180b-basev2 [🤗][🤖]bloom347.6From bloom weights
tigerbot-180b-chatv2 [🤗][🤖]bloom347.6From tigerbot-180b-chat v2
v1 [🤗]bloom347.6From bloom weights

推理

CLI

CUDA_VISIBLE_DEVICES=0 python infer.py --model_path tigerbot-13b-chat --max_input_length 1024 --max_generate_length 1024 --streaming True

参数:

输入 clear 可以清空对话历史,输入 exit 终止推理对话。

<p width="100%"> <img src="image/terminal_case.jpeg" alt="命令行推理" style="width: 100%; min-width: 200px;"> </p>

WebPage

export PYTHONPATH='./' ; export CUDA_VISIBLE_DEVICES=0 ; streamlit run apps/web_demo.py -- --model_path tigerbot-13b-chat

启动量化模型的web_demo

export PYTHONPATH='./' ; export CUDA_VISIBLE_DEVICES=0 ; streamlit run apps/exllamav2_web_demo.py -- --model_path TigerResearch/tigerbot-70b-chat-v4-4bit-exl2

参数同CLI启动参数

本地API

CLI/WebPage均为demo性质。TGI实现了混合batch,request queue等工程特性,如有大量推理需求,推荐通过TGI镜像提供服务。

docker run --gpus '"device=0,1,2,3"' -d -p 8080:80 -v PATH-TO-MODEL-DIR:/model ghcr.io/huggingface/text-generation-inference:1.1.1 --model-id /model --max-total-tokens=1024 --max-input-length=1024 --max-batch-prefill-tokens=1024

请根据模型规模与硬件情况选择合适的参数。一般来说7B/13B需要A100 40G * 1,70B需要A100 * 4。

注意,TGI部署服务,生成控制参数需要在每个请求中控制。

量化

exllamav2量化推理

使用exllamav2加载[TigerResearch/tigerbot-70b-chat-v4-4bit-exl2]进行推理,推理速度加快

# 安装exllamav2
git clone https://github.com/turboderp/exllamav2
cd exllamav2
pip install -r requirements.txt

#  启动推理
CUDA_VISIBLE_DEVICES=0 python other_infer/exllamav2_hf_infer.py --model_path ${MODEL_PATH}

MODEL_PATH为量化模型路径,如 TigerResearch/tigerbot-70b-chat-v4-4bit-exl2

使用以上量化方式,请将transformers、bitsandbytes等包升级到最新版(目前transformers==4.33.1和bitsandbytes==0.41.1可以正常使用)

pip install -U transformers bitsandbytes

动态量化模型加载

此方式为在线量化与推理

CUDA_VISIBLE_DEVICES=0 python other_infer/quant_infer.py --model_path ${MODEL_DIR} --wbit 8

训练

预训练

启动训练前安装 DeepSpeed

git clone git@github.com:microsoft/DeepSpeed.git
cd DeepSpeed
rm -rf build
TORCH_CUDA_ARCH_LIST="8.0" DS_BUILD_CPU_ADAM=1 DS_BUILD_UTILS=1 pip install . \
--global-option="build_ext" --global-option="-j8" --no-cache -v \
--disable-pip-version-check 2>&1 | tee build.log

TORCH_CUDA_ARCH_LIST 根据你运行的 GPU 架构做调整,获取 TORCH_CUDA_ARCH_LIST

CUDA_VISIBLE_DEVICES=0 python -c "import torch; print(torch.cuda.get_device_capability())"

如果返回的结果是(8, 0),那么 TORCH_CUDA_ARCH_LIST="8.0"

启动训练

启动tigerbot-7b训练至少需要 1 x A100 (40GB), 启动tigerbot-180b至少需要 16 x A100 (40GB)

deepspeed \
--include="localhost:0,1,2,3" \
./train_clm.py \
--deepspeed ./ds_config/ds_config_zero3.json \
--model_name_or_path TigerResearch/tigerbot-7b-base \
--dataset_name TigerResearch/dev_pretrain \
--do_train \
--output_dir ./ckpt-clm \
--overwrite_output_dir \
--preprocess_num_workers 8 \
--num_train_epochs 5 \
--learning_rate 1e-5 \
--evaluation_strategy steps \
--eval_steps 10 \
--bf16 True \
--save_strategy steps \
--save_steps 10 \
--save_total_limit 2 \
--logging_steps 10 \
--tf32 True \
--per_device_train_batch_size 2 \
--per_device_eval_batch_size 2

微调

启动训练

deepspeed \
--include="localhost:0,1,2,3" \
./train_sft.py \
--deepspeed ./ds_config/ds_config_zero3.json \
--model_name_or_path TigerResearch/tigerbot-7b-base \
--dataset_name TigerResearch/dev_sft \
--do_train \
--output_dir ./ckpt-sft \
--overwrite_output_dir \
--preprocess_num_workers 8 \
--num_train_epochs 5 \
--learning_rate 1e-5 \
--evaluation_strategy steps \
--eval_steps 10 \
--bf16 True \
--save_strategy steps \
--save_steps 10 \
--save_total_limit 2 \
--logging_steps 10 \
--tf32 True \
--per_device_train_batch_size 2 \
--per_device_eval_batch_size 2

测评

我们使用经典的中英文benchmark自动评测,共13项任务,涵盖代码,常识推理,阅读理解,数学,自然语言理解等。我们基于opencompass建立自动评测体系(感谢@opencompass)

# 安装
cd opencompass
pip install -e .

# 下载数据集到 data/ 处
wget https://github.com/InternLM/opencompass/releases/download/0.1.1/OpenCompassData.zip
unzip OpenCompassData.zip

#运行测评任务:
CUDA_VISIBLE_DEVICES=0,1,2 python run.py configs/eval_tigerbot_13b.py -w outputs/tigerbot-13b-base

总分为各类任务的平均分

chat模型测评结果

image

base模型测评结果

image

开源数据集

预训练数据

<details> 基于 GPT3 的 pretrain 的数据分布,采集中文书籍,互联网,和百科类数据,并通过数据源质量分过滤和 tf-idf soft deduping,从 20TB 数据过滤到 2TB,保持语言和类目的比例,并在此基础上随机抽样 100G 数据开源: <p align="center" width="100%"> <img src="image/pretrain_v2.png" alt="Tiger" style="width: 65%; display: block; margin: auto;"></a> </p> <p width="100%"> <img src="image/zh-books.png" alt="中文书籍分类" style="width: 50%; min-width: 200px;"><img src="image/code-lang-type.png" alt="代码语言" style="width: 50%; min-width: 200px;"> </p> </details>

微调数据

<details> <summary><b>数据搜集</b></summary>

模型中使用的微调数据的搜集思想如下:

a. 从用户指令的自然分布,人工标注总结 10 大类,120 小类任务,例如,事实性问答,开放式创作,语法分析,代码编辑等;

b. self-instruct: 参考 Alpaca self-instruct 方法,扩充中英文 seed_tasks,增加一些中文习惯种子问题,基于此生成 2M 中文(本次开源 0.5M)及 0.1M 英文(本次开源 50k);

c. human-labeling: 基于人工写题及答案、网络搜集方式,整理加工问答集数据,在开源列表中标识为[自研]部分,本次开放部分数据;

d. open-source data cleaning: 基于各类公开数据集转换清洗,其中[自研*]部分,表示基于原始数据进行二次开发后得到,[开源] 部分数据集一般原始数据即为较规整的问答数据,进行简单清洗得到;

e. 总的数据分布符合用户指令自然分布。

</details> <details> <summary><b>数据清洗</b></summary> - 由于各类数据质量存在差异,通过 Alpaca Self-Instruct 生成的数据亦存在各种问题。因此,我们经过细致的人工校验和分类,总结出一套全面且系统化的数据清洗规则与方法。 - 整体规则可以划分为**过滤类规则**和**清洗类规则**两大类。其中,命中过滤规则的数据项将被弃用,而清洗规则旨在处理并保留所需的数据。 - 同时,在数据梳理与积累的过程中,我们也不断对清洗规则进行迭代和优化。 - 通用清洗规则描述如下所示:

a. 过滤类-敏感词规则:基于积累的敏感词库,清洗丢弃涉政、涉黄、涉暴、涉恐等数据项;

b. 过滤类-无效输入输出:此类规则主要针对 Self-Instruct 生成数据缺陷进行专项清理,根据输入输出分别制定规则,以丢弃一些无效的数据项;

无效输入如"<一段文本>",无效输出如"[图画]";

c. 清洗类-关键词规则:根据整理的关键词/正则列表进行数据的替换,包括:清理特殊标志位字符、清理非可见字符、清理标签、繁简转换等;

d. 清洗类-特殊逻辑规则:此类规则用于清洗一些特殊现象数据,如指令与输入重复等,如下所示:

{"instruction": "描述如何做一道红烧肉。请提供食材和详细的步骤。", "input": "请描述如何做一道红烧肉,提供食材和详细步骤。", ...}

</details> <details> <summary><b>数据开源</b></summary> - 指令数据集, 当前开源 120W 问答对,磁盘空间 1.1G (数据集开放到 huggingface,中英文指令明细及下载如下表) - <a href=https://huggingface.co/datasets/TigerResearch/sft_zh>中文-微调指令集-合集 - 53W 条 - 下载 [hugging face]</a> - <a href=https://huggingface.co/datasets/TigerResearch/sft_en>英文-微调指令集-合集 - 67W 条 - 下载 [hugging face]</a>
类型语言数据集数量来源
alpaca 中文中文tigerbot-alpaca-zh-0.5m0.5m自研
百科问答中文tigerbot-wiki-qa-1k1k自研
名著问答中文tigerbot-book-qa-1k1k自研
猜谜语中文tigerbot-riddle-qa-1k1k自研
阅读理解中文tigerbot-superclue-c3-zh-5k5k自研*
问答中文tigerbot-HC3-zh-12k12k开源
知乎问答中文tigerbot-zhihu-zh-10k10k开源
alpaca 英文英文tigerbot-alpaca-en-50k50k自研
头脑风暴英文tigerbot-dolly-Brainstorming-en-1.7k1.7k开源
分类英文tigerbot-dolly-Classification-en-2k2k开源 |
代码英文tigerbot-kaggle-leetcodesolutions-en-2k2k自研*
食谱生成英文tigerbot-kaggle-recipes-en-2k2k开源
病历生成英文tigerbot-mt-note-generation-en450开源
多轮对话英文tigerbot-OIG-multichat-en-50k50k自研*
综合问答英文tigerbot-stackexchange-qa-en-0.5m0.5m开源
wiki 问答英文tigerbot-wiki-qa-bart-en-10k10k开源
如何做类教程英文tigerbot-youtube-howto-en-50k50k开源
总量120W 条

更多数据集陆续整理开放中...

</details>

领域数据

<details> 开放金融、法律、百科相关领域数据,作为 rethink 外部数据源
类型数量
金融-研报2W 篇
金融-财报2500 篇
法律11 类 5.5W 条款
百科10W 词条
</details>

Tigerbot API

<details>

chat

<details><summary><b>示例</b></summary> <img src="image/api/demo/chat.png" alt="tigerbot chat-api sample" style="width: 65%; display: block"> <img src="image/api/demo/chat2.png" alt="tigerbot chat-api sample" style="width: 65%; display: block"> </details>

plugin

<details><summary><b>示例</b></summary> <img src="image/api/demo/plugin.png" alt="tigerbot chat-api sample" style="width: 65%; display: block"> </details>

finetune

<details><summary><b>示例</b></summary> <img src="image/api/demo/finetune.png" alt="tigerbot chat-api sample" style="width: 65%; display: block"> </details>

embedding

<details><summary><b>示例</b></summary> <img src="image/api/demo/embedding.png" alt="tigerbot chat-api sample" style="width: 65%; display: block"> </details>

summarization

<details><summary><b>示例</b></summary> <img src="image/api/demo/summarization.png" alt="tigerbot chat-api sample" style="width: 65%; display: block"> </details>

pdf2text

<details><summary><b>示例</b></summary> <img src="image/api/demo/pdf2text.png" alt="tigerbot chat-api sample" style="width: 65%; display: block"> </details>

text2image

<details><summary><b>示例</b></summary> <img src="image/api/demo/text2image.png" alt="tigerbot chat-api sample" style="width: 65%; display: block"> </details> </details>

其他

<details><summary><b>案例</b></summary> ![image](./image/api/case-1.png) ![image](image/api/case-2.png) ![image](image/api/case-3.png) ![image](image/api/case-4.png) ![image](image/api/case-5.png) ![image](image/api/case-6.png) </details> <details><summary><b>开发者生态</b></summary> </details> <details><summary><b>加入我们</b></summary>

产品链接

https://www.tigerbot.com

联系电话

021-63888086

联系邮箱

<p>cong.fu@tigerbot.com</p> <p>wei.cai@tigerbot.com</p>

微信讨论群

<img src="image/qiyewechat.png" alt="Tiger" style="width: 260px; "></a>

</details> <details><summary><b>局限性与免责声明</b></summary> 当前模型可能存在生成幻觉、误导性、或歧视性内容。请谨慎使用 TigerBot 系列模型生成的内容,请勿将生成的有害内容进行传播。 如需将模型公开使用或者商用,模型服务所产生的不良影响或者有害言论由服务方负责,本项目开发者不承担任何因使用本项目(包含但不限于数据、模型、代码等)导致的危害或损失。 </details>