yeyupiaoling/Whisper-Finetune

This is stars and forks stats for /yeyupiaoling/Whisper-Finetune repository. As of 30 Apr, 2024 this repository has 334 stars and 41 forks.

微调Whisper语音识别模型和加速推理 简体中文 | English 前言 OpenAI在开源了号称其英文语音辨识能力已达到人类水准的Whisper项目，且它亦支持其它98种语言的自动语音辨识。Whisper所提供的自动语音识与翻译任务，它们能将各种语言的语音变成文本，也能将这些文本翻译成英文。本项目主要的目的是为了对Whisper模型使用Lora进行微调，支持无时间戳数据训练，有时间戳数据训练、无语音数据训练。目前开源了好几个模型，具体可以在openai查看，下面列出了常用的几个模型。另外项目最后还支持CTranslate2加速推理和GGML加速推理，提示一下，加速推理支持直接使用Whisper原模型转换，并不一定需要微调。支持Windows桌面应用，Android应用和服务器部署。 请先点 ⭐ 支持模型 openai/whisper-tiny openai/whisper-base openai/whisper-small openai/whisper-medium openai/whisper-large openai/whisper-large-v2 欢迎大家扫码入知识星球（左）或者QQ群（右）讨论，知识星球里面提供项目的模型文件和博主其他相关项目的模型文件，也包括其他一些资源。 使用环境： Anaconda 3 Python 3.8 Pytorch 1.13.1 Ubuntu 18.04 GPU A100-PCIE-40GB*1 视频讲解：哔哩哔哩 演示地址：Web部署 目录 项目主要程序介绍 模型测试表 安装环境 准备数据 微调模型 单卡训练 多卡训练 合并模型 评估模型 预测 加速预测 GUI界面预测 Web部署 接口文档 Android部署 Windows桌面应用 打赏作者 项目主要程序介绍 aishell.py：制作AIShell训练数据。 finetune.py：微调模型。 merge_lora.py：合并Whisper和Lora的模型。 evaluation.py：评估使用微调后的模型或者Whisper原模型。 infer_tfs.py：使用transformers直接调用微调后的模型或者Whisper原模型预测，只适合推理短音频。 infer_ct2.py：使用转换为CTranslate2的模型预测，主要参考这个程序用法。 infer_gui.py：有GUI界面操作，使用转换为CTranslate2的模型预测。 infer_server.py：使用转换为CTranslate2的模型部署到服务器端，提供给客户端调用。 convert-ggml.py：转换模型为GGML格式模型，给Android应用或者Windows应用使用。 AndroidDemo：该目录存放的是部署模型到Android的源码。 WhisperDesktop：该目录存放的是Windows桌面应用的程序。 模型测试表 原始模型字错率测试表。 使用模型 指定语言 aishell_test test_net test_meeting 模型获取 whisper-tiny Chinese 0.31898 0.40482 0.75332 加入知识星球获取 whisper-base Chinese 0.22196 0.30404 0.50378 加入知识星球获取 whisper-small Chinese 0.13897 0.18417 0.31154 加入知识星球获取 whisper-medium Chinese 0.09538 0.13591 0.26669 加入知识星球获取 whisper-large Chinese 0.08969 0.12933 0.23439 加入知识星球获取 whisper-large-v2 Chinese 0.08817 0.12332 0.26547 加入知识星球获取 微调数据集后字错率测试表。 使用模型 指定语言 数据集 aishell_test test_net test_meeting 模型获取 whisper-tiny Chinese AIShell 0.13043 0.4463 0.57728 加入知识星球获取 whisper-base Chinese AIShell 0.08999 0.33089 0.40713 加入知识星球获取 whisper-small Chinese AIShell 0.05452 0.19831 0.24229 加入知识星球获取 whisper-medium Chinese AIShell 0.03681 0.13073 0.16939 加入知识星球获取 whisper-large-v2 Chinese AIShell 0.03139 0.12201 0.15776 加入知识星球获取 whisper-tiny Chinese WenetSpeech 0.17711 0.24783 0.39226 加入知识星球获取 whisper-base Chinese WenetSpeech 0.14548 0.17747 0.30590 加入知识星球获取 whisper-small Chinese WenetSpeech 0.08484 0.11801 0.23471 加入知识星球获取 whisper-medium Chinese WenetSpeech 0.05861 0.08794 0.19486 加入知识星球获取 whisper-large-v2 Chinese WenetSpeech 0.05443 0.08367 0.19087 加入知识星球获取 未加速和加速后的推理速度测试表，使用GPU为GTX3090（24G）。 使用模型 原生模型实时率(float16) 转换CTranslate2加速后实时率(float16) 转换CTranslate2加速后实时率(int8_float16) whisper-tiny 0.03 0.06 0.06 whisper-base 0.04 0.06 0.06 whisper-small 0.08 0.08 0.08 whisper-medium 0.13 0.10 0.10 whisper-large-v2 0.19 0.12 0.12 经过处理的数据列表。 数据列表处理方式 AiShell WenetSpeech 添加标点符号 加入知识星球获取 加入知识星球获取 添加标点符号和时间戳 加入知识星球获取 加入知识星球获取 重要说明： 在评估的时候移除模型输出的标点符号，并把繁体中文转成简体中文。 aishell_test为AIShell的测试集，test_net和test_meeting为WenetSpeech的测试集。 RTF= 所有音频总时间(单位秒) / ASR识别所有音频处理时间(单位秒)。 测试速度的音频为dataset/test.wav，时长为8秒。 训练数据使用的是带标点符号的数据，字错率高一点。 微调AiShell数据不带时间戳，微调WenetSpeech带时间戳。 安装环境 首先安装的是Pytorch的GPU版本，以下介绍两种安装Pytorch的方式，只需要选择一种即可。 以下是使用Anaconda安装Pytorch环境，如果已经安装过了，请跳过。 conda install pytorch==1.13.1 torchvision==0.14.1 torchaudio==0.13.1 pytorch-cuda=11.6 -c pytorch -c nvidia 以下是使用Docker镜像，拉取一个Pytorch环境的镜像。 sudo docker pull pytorch/pytorch:1.13.1-cuda11.6-cudnn8-devel 然后进入到镜像中，同时将当前路径挂载到容器的/workspace目录下。 sudo nvidia-docker run --name pytorch -it -v $PWD:/workspace pytorch/pytorch:1.13.1-cuda11.6-cudnn8-devel /bin/bash 安装所需的依赖库。 python -m pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple Windows需要单独安装bitsandbytes。 python -m pip install https://github.com/jllllll/bitsandbytes-windows-webui/releases/download/wheels/bitsandbytes-0.40.1.post1-py3-none-win_amd64.whl 准备数据 训练的数据集如下，是一个jsonlines的数据列表，也就是每一行都是一个JSON数据，数据格式如下。本项目提供了一个制作AIShell数据集的程序aishell.py，执行这个程序可以自动下载并生成如下列格式的训练集和测试集，注意： 这个程序可以通过指定AIShell的压缩文件来跳过下载过程的，如果直接下载会非常慢，可以使用一些如迅雷等下载器下载该数据集，然后通过参数--filepath指定下载的压缩文件路径，如/home/test/data_aishell.tgz。 小提示： 如果不使用时间戳训练，可以不包含sentences字段的数据。 如果只有一种语言的数据，可以不包含language字段数据。 如果训练空语音数据，sentences字段为[]，sentence字段为""，language字段可以不存在。 数据可以不包含标点符号，但微调的模型会损失添加符号能力。 { "audio": { "path": "dataset/0.wav" }, "sentence": "近几年，不但我用书给女儿压岁，也劝说亲朋不要给女儿压岁钱，而改送压岁书。", "language": "Chinese", "sentences": [ { "start": 0, "end": 1.4, "text": "近几年，" }, { "start": 1.42, "end": 8.4, "text": "不但我用书给女儿压岁，也劝说亲朋不要给女儿压岁钱，而改送压岁书。" } ], "duration": 7.37 } 微调模型 准备好数据之后，就可以开始微调模型了。训练最重要的两个参数分别是，--base_model指定微调的Whisper模型，这个参数值需要在HuggingFace存在的，这个不需要提前下载，启动训练时可以自动下载，当然也可以提前下载，那么--base_model指定就是路径，同时--local_files_only设置为True。第二个--output_path是是训练时保存的Lora检查点路径，因为我们使用Lora来微调模型。如果想存足够的话，最好将--use_8bit设置为False，这样训练速度快很多。其他更多的参数请查看这个程序。 单卡训练 单卡训练命令如下，Windows系统可以不添加CUDA_VISIBLE_DEVICES参数。 CUDA_VISIBLE_DEVICES=0 python finetune.py --base_model=openai/whisper-tiny --output_dir=output/ 多卡训练 多卡训练有两种方法，分别是torchrun和accelerate，开发者可以根据自己的习惯使用对应的方式。 使用torchrun启动多卡训练，命令如下，通过--nproc_per_node指定使用的显卡数量。 torchrun --nproc_per_node=2 finetune.py --base_model=openai/whisper-tiny --output_dir=output/ 使用accelerate启动多卡训练，如果是第一次使用accelerate，要配置训练参数，方式如下。 首先配置训练参数，过程是让开发者回答几个问题，基本都是默认就可以，但有几个参数需要看实际情况设置。 accelerate config 大概过程就是这样： --------------------------------------------------------------------In which compute environment are you running? This machine --------------------------------------------------------------------Which type of machine are you using? multi-GPU How many different machines will you use (use more than 1 for multi-node training)? [1]: Do you wish to optimize your script with torch dynamo?[yes/NO]: Do you want to use DeepSpeed? [yes/NO]: Do you want to use FullyShardedDataParallel? [yes/NO]: Do you want to use Megatron-LM ? [yes/NO]: How many GPU(s) should be used for distributed training? [1]:2 What GPU(s) (by id) should be used for training on this machine as a comma-seperated list? [all]: --------------------------------------------------------------------Do you wish to use FP16 or BF16 (mixed precision)? fp16 accelerate configuration saved at /home/test/.cache/huggingface/accelerate/default_config.yaml 配置完成之后，可以使用以下命令查看配置。 accelerate env 开始训练命令如下。 accelerate launch finetune.py --base_model=openai/whisper-tiny --output_dir=output/ 输出日志如下： {'loss': 0.9098, 'learning_rate': 0.000999046843662503, 'epoch': 0.01} {'loss': 0.5898, 'learning_rate': 0.0009970611012927184, 'epoch': 0.01} {'loss': 0.5583, 'learning_rate': 0.0009950753589229333, 'epoch': 0.02} {'loss': 0.5469, 'learning_rate': 0.0009930896165531485, 'epoch': 0.02} {'loss': 0.5959, 'learning_rate': 0.0009911038741833634, 'epoch': 0.03} 合并模型 微调完成之后会有两个模型，第一个是Whisper基础模型，第二个是Lora模型，需要把这两个模型合并之后才能之后的操作。这个程序只需要传递两个参数，--lora_model指定的是训练结束后保存的Lora模型路径，其实就是检查点文件夹路径，第二个--output_dir是合并后模型的保存目录。 python merge_lora.py --lora_model=output/whisper-tiny/checkpoint-best/ --output_dir=models/ 评估模型 执行以下程序进行评估模型，最重要的两个参数分别是。第一个--model_path指定的是合并后的模型路径，同时也支持直接使用Whisper原模型，例如直接指定openai/whisper-large-v2，第二个是--metric指定的是评估方法，例如有字错率cer和词错率wer。提示： 没有微调的模型，可能输出带有标点符号，影响准确率。其他更多的参数请查看这个程序。 python evaluation.py --model_path=models/whisper-tiny-finetune --metric=cer 预测 执行以下程序进行语音识别，这个使用transformers直接调用微调后的模型或者Whisper原模型预测，只适合推理短音频，长语音还是参考infer_ct2.py的使用方式。第一个--audio_path参数指定的是要预测的音频路径。第二个--model_path指定的是合并后的模型路径，同时也支持直接使用Whisper原模型，例如直接指定openai/whisper-large-v2。其他更多的参数请查看这个程序。 python infer_tfs.py --audio_path=dataset/test.wav --model_path=models/whisper-tiny-finetune 加速预测 众所周知，直接使用Whisper模型推理是比较慢的，所以这里提供了一个加速的方式，主要是使用了CTranslate2进行加速，首先要转换模型，把合并后的模型转换为CTranslate2模型。如下命令，--model参数指定的是合并后的模型路径，同时也支持直接使用Whisper原模型，例如直接指定openai/whisper-large-v2。--output_dir参数指定的是转换后的CTranslate2模型路径，--quantization参数指定的是量化模型大小，不希望量化模型的可以直接去掉这个参数。 ct2-transformers-converter --model models/whisper-tiny-finetune --output_dir models/whisper-tiny-finetune-ct2 --copy_files tokenizer.json --quantization float16 执行以下程序进行加速语音识别，--audio_path参数指定的是要预测的音频路径。--model_path指定的是转换后的CTranslate2模型。其他更多的参数请查看这个程序。 python infer_ct2.py --audio_path=dataset/test.wav --model_path=models/whisper-tiny-finetune-ct2 输出结果如下： ----------- Configuration Arguments ----------- audio_path: dataset/test.wav model_path: models/whisper-tiny-finetune-ct2 language: zh use_gpu: True use_int8: False beam_size: 10 num_workers: 1 vad_filter: False local_files_only: True ------------------------------------------------ [0.0 - 8.0]：近几年,不但我用书给女儿压碎,也全说亲朋不要给女儿压碎钱,而改送压碎书。 GUI界面预测 这里同样是使用了CTranslate2进行加速，转换模型方式看上面文档。--model_path指定的是转换后的CTranslate2模型。其他更多的参数请查看这个程序。 python infer_gui.py --model_path=models/whisper-tiny-finetune-ct2 启动后界面如下： Web部署 Web部署同样是使用了CTranslate2进行加速，转换模型方式看上面文档。--host指定服务启动的地址，这里设置为0.0.0.0，即任何地址都可以访问。--port指定使用的端口号。--model_path指定的是转换后的CTranslate2模型。--num_workers指定是使用多少个线程并发推理，这在Web部署上很重要，当有多个并发访问是可以同时推理。其他更多的参数请查看这个程序。 python infer_server.py --host=0.0.0.0 --port=5000 --model_path=models/whisper-tiny-finetune-ct2 --num_workers=2 接口文档 目前提供两个接口，普通的识别接口/recognition和流式返回结果/recognition_stream，注意这个流式是指流式返回识别结果，同样是上传完整的音频，然后流式返回识别结果，这种方式针对长语音识别体验非常好。他们的文档接口是完全一致的，接口参数如下。 字段 是否必须 类型 默认值 说明 audio 是 File 要识别的音频文件 to_simple 否 int 1 是否繁体转简体 remove_pun 否 int 0 是否移除标点符号 task 否 String transcribe 识别任务类型，支持transcribe和translate language 否 String zh 设置语言，简写，如果为None则自动检测语言 返回结果： 字段 类型 说明 results list 分割的识别结果 +result str 每片分隔的文本结果 +start int 每片分隔的开始时间，单位秒 +end int 每片分隔的结束时间，单位秒 code int 错误码，0即为成功识别 示例如下： { "results": [ { "result": "近几年,不但我用书给女儿压碎,也全说亲朋不要给女儿压碎钱,而改送压碎书。", "start": 0, "end": 8 } ], "code": 0 } 为了方便理解，这里提供了调用Web接口的Python代码，下面的是/recognition的调用方式。 import requests response = requests.post(url="http://127.0.0.1:5000/recognition", files=[("audio", ("test.wav", open("dataset/test.wav", 'rb'), 'audio/wav'))], json={"to_simple": 1, "remove_pun": 0, "language": "zh", "task": "transcribe"}, timeout=20) print(response.text) 下面的是/recognition_stream的调用方式。 import json import requests response = requests.post(url="http://127.0.0.1:5000/recognition_stream", files=[("audio", ("test.wav", open("dataset/test_long.wav", 'rb'), 'audio/wav'))], json={"to_simple": 1, "remove_pun": 0, "language": "zh", "task": "transcribe"}, stream=True, timeout=20) for chunk in response.iter_lines(decode_unicode=False, delimiter=b"\0"): if chunk: result = json.loads(chunk.decode()) text = result["result"] start = result["start"] end = result["end"] print(f"[{start} - {end}]：{text}") 提供的测试页面如下： 首页http://127.0.0.1:5000/ 的页面如下： 文档页面http://127.0.0.1:5000/docs 的页面如下： Android部署 安装部署的源码在AndroidDemo目录下，具体文档可以到该目录下的README.md查看。 Windows桌面应用 程序在WhisperDesktop目录下，具体文档可以到该目录下的README.md查看。 打赏作者 打赏一块钱支持一下作者 参考资料 https://github.com/huggingface/peft https://github.com/guillaumekln/faster-whisper https://github.com/ggerganov/whisper.cpp https://github.com/Const-me/Whisper