🛠️ToolBench🤖

Model • Data Release • Web Demo • Tool Eval • Paper • Citation

🔨这个项目(ToolLLM)旨在构建开源、大规模、高质量的指令调整 SFT 数据，以促进构建具有通用工具使用能力的强大LLMs。我们的目标是赋予开源 LLMs 掌握成千上万多样的真实世界API能力。我们通过收集高质量的指令调整数据集来实现这一目标。该数据集使用最新的ChatGPT（gpt-3.5-turbo-16k）自动构建，该版本升级了增强的函数调用功能。我们提供数据集、相应的训练和评估脚本，以及在ToolBench上经过微调的强大模型ToolLLaMA。

💁‍♂️💁💁‍♀️在 Discord 加入我们!

英文README链接.

🗒️数据

👐ToolBench仅用于研究和教育目的，不应被视为反映此数据集的创作者、所有者或贡献者的观点或意见。该数据集以 CC BY NC 4.0许可证进行分发。以下是数据集的统计信息:

工具数量	API数量	实例数量	真实API调用数量	平均Reasoning步数
3451	16464	12657	37204	4.1

我们从RapidAPI爬取了超过16000个API，并且为之构造了真实的人类指令。以下是RapidAPI的架构信息与指令构造的方式。

ToolBench包含单工具和多工具场景。多工具场景可以进一步分为类别内多工具和集合内多工具。我们在数据创建过程中使用DFSDT方法。以下是使用DFSDT方法进行数据创建的说明：

数据发布

请使用以下链接下载我们的数据集：Google Drive或者清华云盘.

G1，G2，G3 数据分别代表单工具数据，类别内多工具数据和集合内多工具数据。我们在 G1、G2 和 G3 数据内分别划分出训练集、验证集和测试集，并将训练集合并，作为我们的主要实验的训练数据。toolllama_G123_dfs_train.json 文件代表合并后的训练集数据。同时我们也给出了基于Atlas的数据可视化结果：Atlas Explorer for visualization。
与工具环境相关的数据位于 toolenv 目录下。
我们从每个测试集中抽样 100 个实例。test_query_ids 目录包含每个测试集中测试实例的query id。
用于工具检索的数据也包含在 retrieval 目录中。

🤖模型

我们发布了全参数微调版本ToolLLaMA-7b和lora版本ToolLLaMA-7b-LoRA，都是在发布的数据集上以多任务方式训练的。我们也发布在实验设置下训练的tool retriever.

🚀精调

安装

克隆这个仓库并进入ToolBench文件夹。

git clone git@github.com:OpenBMB/ToolBench.git
cd ToolBench

安装包 (python>=3.9)

pip install -r requirements.txt

或者仅安装ToolEval需要的包

pip install -r toolbench/tooleval/requirements.txt

准备数据和工具环境:

wget --no-check-certificate 'https://docs.google.com/uc?export=download&id=1Vis-RxBstXLKC1W1agIQUJNuumPJrrw0&confirm=yes' -O data.zip
unzip data.zip

训练Retriever

数据预处理:

export PYTHONPATH=./
python preprocess/preprocess_retriever_data.py \
    --query_file data/instruction/G1_query.json \
    --index_file data/test_query_ids/G1_instruction_test_query_ids.json \
    --dataset_name G1 \
    --output_dir data/retrieval/G1

使用以下命令训练Retriever:

export PYTHONPATH=./
python toolbench/retrieval/train.py \
    --data_path data/retrieval/G1/ \
    --model_name bert-base-uncased \
    --output_path retrieval_model \
    --num_epochs 5 \
    --train_batch_size 32 \
    --learning_rate 2e-5 \
    --warmup_steps 500 \
    --max_seq_length 256

训练ToolLLaMA

我们的训练代码基于FastChat开发.您可以使用以下命令用两张A100（80G）训练ToolLLaMA-7b, 训练数据是我们已经处理好的数据:

export PYTHONPATH=./
torchrun --nproc_per_node=2 --master_port=20001 toolbench/train/train_long_seq.py \
    --model_name_or_path huggyllama/llama-7b  \
    --data_path  data/toolllama_G123_dfs_train.json \
    --eval_data_path  data/toolllama_G123_dfs_eval.json \
    --conv_template tool-llama-single-round \
    --bf16 True \
    --output_dir toolllama \
    --num_train_epochs 2 \
    --per_device_train_batch_size 2 \
    --per_device_eval_batch_size 2 \
    --gradient_accumulation_steps 8 \
    --evaluation_strategy "epoch" \
    --prediction_loss_only \
    --save_strategy "epoch" \
    --save_total_limit 8 \
    --learning_rate 5e-5 \
    --weight_decay 0. \
    --warmup_ratio 0.04 \
    --lr_scheduler_type "cosine" \
    --logging_steps 1 \
    --fsdp "full_shard auto_wrap" \
    --fsdp_transformer_layer_cls_to_wrap 'LlamaDecoderLayer' \
    --tf32 True \
    --model_max_length 8192 \
    --gradient_checkpointing True \
    --lazy_preprocess True \
    --report_to none

您也可以用以下命令用您自己的方式去预处理并划分数据:

export PYTHONPATH=./
python preprocess/preprocess_toolllama_data.py \
    --tool_data_dir data/answer/G1_answer \
    --method DFS_woFilter_w2 \
    --output_file data/answer/toolllama_G1_dfs.json

训练lora版本:

export PYTHONPATH=./
deepspeed --master_port=20001 toolbench/train/train_long_seq_lora.py \
    --model_name_or_path huggyllama/llama-7b  \
    --data_path  data/toolllama_G123_dfs_train.json \
    --eval_data_path  data/toolllama_G123_dfs_eval.json \
    --conv_template tool-llama-single-round \
    --bf16 True \
    --output_dir toolllama_lora \
    --num_train_epochs 5 \
    --per_device_train_batch_size 4 \
    --per_device_eval_batch_size 2 \
    --gradient_accumulation_steps 2 \
    --evaluation_strategy "epoch" \
    --prediction_loss_only \
    --save_strategy "epoch" \
    --save_total_limit 8 \
    --learning_rate 5e-5 \
    --weight_decay 0. \
    --warmup_ratio 0.04 \
    --lr_scheduler_type "cosine" \
    --logging_steps 1 \
    --model_max_length 8192 \
    --gradient_checkpointing True \
    --lazy_preprocess True \    
    --deepspeed ds_configs/stage2.json \
    --report_to none

用我们的RapidAPI服务进行推理

请先填写问卷，我们会尽快审核然后给您发送toolbench key。然后初始化您的toolbench key:

export TOOLBENCH_KEY="your_toolbench_key"

ToolLLaMA

用以下命令用ToolLLaMA做推理:

export PYTHONPATH=./
python toolbench/inference/qa_pipeline.py \
    --tool_root_dir data/toolenv/tools/ \
    --backbone_model toolllama \
    --model_path /path/to/your/toolllama \
    --max_observation_length 1024 \
    --observ_compress_method truncate \
    --method DFS_woFilter_w2 \
    --input_query_file data/instruction/inference_query_demo.json \
    --output_answer_file data/answer/toolllama_dfs \
    --toolbench_key $TOOLBENCH_KEY

lora版本的inference:

export PYTHONPATH=./
python toolbench/inference/qa_pipeline.py \
    --tool_root_dir data/toolenv/tools/ \
    --backbone_model toolllama \
    --model_path huggyllama/llama-7b \
    --lora \
    --lora_path /path/to/your/toolllama_lora \
    --max_observation_length 1024 \
    --observ_compress_method truncate \
    --method DFS_woFilter_w2 \
    --input_query_file data/instruction/inference_query_demo.json \
    --output_answer_file data/answer/toolllama_lora_dfs \
    --toolbench_key $TOOLBENCH_KEY

lora版本的开放域, 用以下命令:

export PYTHONPATH=./
python toolbench/inference/qa_pipeline_open_domain.py \
    --tool_root_dir data/toolenv/tools/ \
    --corpus_tsv_path data/retrieval/G1/corpus.tsv \
    --retrieval_model_path /path/to/your/retrival_model \
    --retrieved_api_nums 5 \
    --backbone_model toolllama \
    --model_path huggyllama/llama-7b \
    --lora \
    --lora_path /path/to/your/toolllama_lora \
    --max_observation_length 1024 \
    --observ_compress_method truncate \
    --method DFS_woFilter_w2 \
    --input_query_file data/instruction/inference_query_demo_open_domain.json \
    --output_answer_file data/answer/toolllama_lora_dfs_open_domain \
    --toolbench_key $TOOLBENCH_KEY

OpenAI模型

用ChatGPT:

export TOOLBENCH_KEY=""
export OPENAI_KEY=""
export PYTHONPATH=./
python toolbench/inference/qa_pipeline.py \
    --tool_root_dir data/toolenv/tools/ \
    --backbone_model chatgpt_function \
    --openai_key $OPENAI_KEY \
    --max_observation_length 1024 \
    --method DFS_woFilter_w2 \
    --input_query_file data/instruction/inference_query_demo.json \
    --output_answer_file data/answer/chatgpt_dfs \
    --toolbench_key $TOOLBENCH_KEY

用Text-Davinci-003:

export TOOLBENCH_KEY=""
export OPENAI_KEY=""
export PYTHONPATH=./
python toolbench/inference/qa_pipeline.py \
    --tool_root_dir data/toolenv/tools/ \
    --backbone_model davinci \
    --openai_key $OPENAI_KEY \
    --max_observation_length 1024 \
    --method DFS_woFilter_w2 \
    --input_query_file data/instruction/inference_query_demo.json \
    --output_answer_file data/answer/davinci_dfs \
    --toolbench_key $TOOLBENCH_KEY

用您自己的RapidAPI账号做推理

要用定制化的RapidAPI账号进行推理，请在脚本中传入您的rapidapi key并指定use_rapidapi_key参数:

export RAPIDAPI_KEY=""
export OPENAI_KEY=""
export PYTHONPATH=./
python toolbench/inference/qa_pipeline.py \
    --tool_root_dir data/toolenv/tools/ \
    --backbone_model chatgpt_function \
    --openai_key $OPENAI_KEY \
    --max_observation_length 1024 \
    --method DFS_woFilter_w2 \
    --input_query_file data/instruction/inference_query_demo.json \
    --output_answer_file data/answer/chatgpt_dfs \
    --rapidapi_key $RAPIDAPI_KEY \
    --use_rapidapi_key

自定义API做推理

要使用自定义API进行推理，您需要准备API文档和代码，然后修改您的query文件。例如，要添加hello_world API，该API的功能为返回“hello world”字符串：

API文档：首先生成API文档json文件（hello_world.json），该文件应遵循以下格式：

{
    "tool_description": "Return hello world.",
    "tool_name": "hello world",
    "title": "hello world",
    "api_list": [
        {
            "name": "get_hello_world",
            "url": "",
            "description": "To get 'hello world'.",
            "method": "GET",
            "required_parameters": [],
            "optional_parameters": []
        }
    ],
    "standardized_name": "hello_world"
}

然后将其放在“data/toolenv/tools/”中的某个category下，可以是已有的49个现有类别之一，也可以新创建一个类别，例如Customized。

API代码：在Customized文件夹下创建一个名为hello_world的文件夹，然后编写实现API功能的代码api.py并将其放在Customized/hello_world/下。 API代码可以写成这样的格式：

def get_hello_world():
    """
    To get hello world 
    """
    observation = "hello world"
    return observation

现在 data/toolenv/ 下的文件结构应该是：

├── /tools/
│  ├── /Sports/
│  │  ├── basketball.json
│  │  ├── /basketball/
│  │  │  └── api.py
│  │  └── ...
│  ├── ...
│  ├── /Customized/
│  │  ├── hello_world.json
│  │  ├── /hello_world/
│  │  │  └── api.py
└── response_examples

修改您的query文件，查询文件应遵循以下格式：

[
    {
        "query": "I want to get a 'hello world' string.",
        "query_id": 200001,
        "api_list": [
            {
                "category_name": "Customized",
                "tool_name": "hello world",
                "api_name": "get_hello_world"
            }
        ]
    }
]

最后，我们可以通过运行以下命令来使用自定义的hello_worldAPI进行推理：

export RAPIDAPI_KEY=""
export PYTHONPATH=./
python toolbench/inference/qa_pipeline.py \
    --tool_root_dir data/toolenv/tools/ \
    --backbone_model toolllama \
    --model_path ToolBench/ToolLLaMA-7b \
    --max_observation_length 1024 \
    --observ_compress_method truncate \
    --method DFS_woFilter_w2 \
    --input_query_file /path/to/your/query/file \
    --output_answer_file /path/to/your/output/file \
    --rapidapi_key $RAPIDAPI_KEY \
    --use_rapidapi_key

Currently we only support customized API usage under close-domain setting. We plan to support open-domain soon.

Setting up and running the interface

ToolBench包含一个基于Chatbot UI的Web UI，经过修改以包含在界面中使用工具的功能。它包含两个部分：后端服务器和chatbot-ui-toolllama。这是一个视频演示。

Web UI

git clone https://github.com/lilbillybiscuit/chatbot-ui-toolllama
cd chatbot-ui-toolllama
npm install
npm run dev

应用将在 http://localhost:3000/ 上可用

Backend server

export PYTHONPATH=./
python toolbench/inference/toolbench_server.py \
    --tool_root_dir data/toolenv/tools/ \
    --corpus_tsv_path data/retrieval/G1/corpus.tsv \
    --retrieval_model_path /path/to/your/retrival_model \
    --retrieved_api_nums 5 \
    --backbone_model toolllama \
    --model_path huggyllama/llama-7b \
    --lora \
    --lora_path /path/to/your/toolllama_lora \
    --max_observation_length 1024 \
    --method DFS_woFilter_w2 \
    --input_query_file data/instruction/inference_query_demo_open_domain.json \
    --output_answer_file data/answer/toolllama_lora_dfs_open_domain \
    --rapidapi_key $RAPIDAPIKEY

This server will be available on http://localhost:5000/. To start a request, call http://localhost:5000/stream with a GET or POST request containing a JSON object with the following fields:

{
    "text": "What is the weather in New York today?",
    "top_k": 5,
    "method": "DFS_woFilter_w2"
}

ToolEval

通过在ToolBench上对LLaMA进行微调，我们得到了ToolLLaMA。考虑到人工评估非常耗时，我们借鉴AlpacaEval开发了一个高效的机器自动评估ToolEval，其中包含两个评估指标：

通过率：计算在有限的OpenAI API调用次数内成功完成指令的比例。
偏好：通过比较给定指令的两个答案（动作序列）来衡量。我们预先定义了一组更好答案的标准，这些标准被组织成ChatGPT的提示。我们向评估器提供测试指令和两个候选答案，并获得其偏好。我们对每个答案对进行多次评估以提高系统的可靠性。然后，我们计算优胜率（被评估器选择为更优的百分比）和标准差（优胜率的标准误差）。有关详细信息，请参阅我们的论文。

为了验证偏好指标的有效性，我们从三种不同方法（ChatGPT+ReACT、GPT4+ReACT和ChatGPT+DFSDT）中随机抽样获得600个测试指令的答案对。然后，我们邀请人工标注人员对它们进行人工偏好注释（每个答案对4个注释，总共2400个注释）。我们使用ChatGPT开发的自动评估器与人工标注者呈现出显著的75.8%相关性。我们还获得了不同人工标注者之间的一致性为83.54%，与我们的评估器和人类标注者之间的一致性为80.21%。

有关ToolEval的更多细节，请参阅我们的论文。

Evaluation with ToolEval

要在测试集（如G1-Inst.）上评估模型，可以执行以下命令：

通过率:

python toolbench/tooleval/pass_rate.py --answer_dir data/answer/toolllama_dfs/G1_instruction

优胜率 (参考模型: ChatGPT-ReACT):

export OPENAI_KEY=""
export REF_MODEL_DATA="data/answer/chatgpt_cot/G1_instruction"
export REF_MODEL_METHOD="CoT"
export TEST_MODEL_DATA="data/answer/toolllama_dfs/G1_instruction"
export TEST_MODEL_METHOD="DFS"
python ./toolbench/tooleval/convert_to_answer_format.py \
    --method CoT \
    --answer_dir $REF_MODEL_DATA \
    --output ${REF_MODEL_DATA}_converted

python ./toolbench/tooleval/convert_to_answer_format.py \
    --method DFS \
    --answer_dir $TEST_MODEL_DATA \
    --output ${TEST_MODEL_DATA}_converted

python ./toolbench/tooleval/automatic_eval_sample.py \
    --output ${REF_MODEL_DATA}_converted \
    --ref_output ${TEST_MODEL_DATA}_converted \
    --method $REF_MODEL_METHOD \
    --use_existed_output

更多细节请参考 ToolEval.

Model Experiment

在我们的主要实验中，ToolLLaMA展现了处理单一工具和复杂多工具指令的引人注目的能力。 We introduce hallucinate rate(lower is better) evaluation metric as a complement of ToolEval. An instance is considered to be a hallucinate instance, as long as the whole decision tree contains at least one hallucinated function call. 我们引入幻觉率作为ToolEval的补充。若一条实例的决策树包含至少一个幻觉函数调用，我们就认为它是一条幻觉实例。以下是与ChatGPT和Text-Davinci-003相比的主要结果。

幻觉率：

model	I1-Inst.	I1-Tool.	I1-Cat.	I2-Inst.	I2-Cat.	I3-Inst.	Average
ChatGPT-DFSDT	2	6	5	14	16	17	10
Text-Davinci-003-DFSDT	6	5	5	6	8	6	6.0
ToolLLaMA	16	13	20	24	24	27	20.7
ToolLLaMA-LoRA	61	62	52	69	67	64	62.5
ToolLLaMA-API Retriever	16	25	22	20	23	37	23.8
ToolLLaMA-2	3	11	9	8	10	10	8.5

通过率：

model	I1-Inst.	I1-Tool.	I1-Cat.	I2-Inst.	I2-Cat.	I3-Inst.	Average
ChatGPT-DFSDT	78	84	89	51	58	57	69.6
ChatGPT-ReACT	56	62	66	28	22	30	44.0
Text-Davinci-003-DFSDT	53	58	61	38	38	39	47.8
Text-Davinci-003-ReACT	19	25	30	12	11	14	18.5
ToolLLaMA	68	80	75	47	56	40	61.0
ToolLLaMA-LoRA	51	63	61	38	42	45	50.0
ToolLLaMA-API Retriever	62	62	72	45	55	47	57.2
ToolLLaMA-2	64	72	78	50	51	46	59.8

优胜率： (Reference model: ChatGPT-DFSDT)

model	I1-Inst.	I1-Tool.	I1-Cat.	I2-Inst.	I2-Cat.	I3-Inst.	Average
ChatGPT-DFSDT	50	50	50	50	50	50	50.0
ChatGPT-ReACT	38	32	41	43	22	23	30.7
Text-Davinci-003-ReACT	14	21	18	8	7	12	13.3
Text-Davinci-003-DFSDT	38	34	43	25	20	28	31.3
ToolLLaMA	50	45	45	59	48	46	48.8
ToolLLaMA-LoRA	43	36.4	30	42	45	51	41.2
ToolLLaMA-API Retriever	51	39	44	49	49	55	47.8
ToolLLaMA-2	43	42	46	55	46	50	47.0

TODO

ToolLLaMA将达到GPT-4的工具使用能力。

工具学习相关链接

鉴于基础模型的强大能力，我们期待看到它们在操纵各种工具中的应用。更多的资源，请参考以下内容：

BMTools. [Project]
Tool Learning Survey. [Paper]
Tool Learning Paper List. [Project]
WebCPM. [Paper]

Citation

如果您对ToolBench感兴趣，欢迎引用我们的工作。

@misc{qin2023toolllm,
      title={ToolLLM: Facilitating Large Language Models to Master 16000+ Real-world APIs}, 
      author={Yujia Qin and Shihao Liang and Yining Ye and Kunlun Zhu and Lan Yan and Yaxi Lu and Yankai Lin and Xin Cong and Xiangru Tang and Bill Qian and Sihan Zhao and Runchu Tian and Ruobing Xie and Jie Zhou and Mark Gerstein and Dahai Li and Zhiyuan Liu and Maosong Sun},
      year={2023},
      eprint={2307.16789},
      archivePrefix={arXiv},
      primaryClass={cs.AI}
}

@misc{qin2023tool,
      title={Tool Learning with Foundation Models}, 
      author={Yujia Qin and Shengding Hu and Yankai Lin and Weize Chen and Ning Ding and Ganqu Cui and Zheni Zeng and Yufei Huang and Chaojun Xiao and Chi Han and Yi Ren Fung and Yusheng Su and Huadong Wang and Cheng Qian and Runchu Tian and Kunlun Zhu and Shihao Liang and Xingyu Shen and Bokai Xu and Zhen Zhang and Yining Ye and Bowen Li and Ziwei Tang and Jing Yi and Yuzhang Zhu and Zhenning Dai and Lan Yan and Xin Cong and Yaxi Lu and Weilin Zhao and Yuxiang Huang and Junxi Yan and Xu Han and Xian Sun and Dahai Li and Jason Phang and Cheng Yang and Tongshuang Wu and Heng Ji and Zhiyuan Liu and Maosong Sun},
      year={2023},
      eprint={2304.08354},
      archivePrefix={arXiv},
      primaryClass={cs.CL}
}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README_ZH.md

README_ZH.md

🛠️ToolBench🤖

最新支持

🗒️数据

数据发布

🤖模型

🚀精调

安装

训练Retriever

训练ToolLLaMA

用我们的RapidAPI服务进行推理

ToolLLaMA

OpenAI模型

用您自己的RapidAPI账号做推理

自定义API做推理

Setting up and running the interface

Web UI

Backend server

ToolEval

Evaluation with ToolEval

Model Experiment

TODO

工具学习相关链接

Citation

Files

README_ZH.md

Latest commit

History

README_ZH.md

File metadata and controls

🛠️ToolBench🤖

最新支持

🗒️数据

数据发布

🤖模型

🚀精调

安装

训练Retriever

训练ToolLLaMA

用我们的RapidAPI服务进行推理

ToolLLaMA

OpenAI模型

用您自己的RapidAPI账号做推理

自定义API做推理

Setting up and running the interface

Web UI

Backend server

ToolEval

Evaluation with ToolEval

Model Experiment

TODO

工具学习相关链接

Citation