wenet

环境要求

• Python 环境（训练/部署建议用 Conda 创建 python=3.10 环境）
• pip 可访问 GitHub 以安装主仓库
• GPU 用户需自行安装匹配的 CUDA（README 推荐 CUDA 12.1）
• 构建 runtime 需 cmake 3.14 或以上
• 如需 sox 请通过 conda 安装 conda-forge::sox

安装与启动步骤

1. 1安装 Python 包

   直接用 pip 从 GitHub 安装 WeNet，会自动拉入 torch>=1.13.0 且无上限，可能装到高于驱动支持的版本。

   pip install git+https://github.com/wenet-e2e/wenet.git

   复制

2. 2检查 GPU 是否可用

   在带 GPU 的机器上验证 torch 能否调用 CUDA，返回 False 时会静默回退 CPU 且不报错。

   python -c "import torch; print(torch.cuda.is_available())"

   复制

3. 3按需重装匹配的 torch

   若上一步为 False，说明 torch 与驱动 CUDA 版本不匹配，按 README 示例重装 cu121 版本。

   pip install torch==2.4.0+cu121 torchaudio==2.4.0+cu121 --index-url https://download.pytorch.org/whl/cu121 --force-reinstall

   复制

4. 4命令行识别音频

   用 -m 指定模型名，对 wav 文件做识别；可用 -h 查看全部参数。

   wenet -m paraformer audio.wav

   复制

5. 5Python 代码调用

   以库的方式加载模型并转写音频，结果从 result.text 取出；load_model 可传 device 参数。

   import wenet
   
   model = wenet.load_model('paraformer')
   result = model.transcribe('audio.wav')
   print(result.text)

   复制

6. 6克隆仓库准备训练

   训练与部署需先克隆仓库，并准备好 Conda 环境，同时安装 sox。

   git clone https://github.com/wenet-e2e/wenet.git
   conda create -n wenet python=3.10
   conda activate wenet
   conda install conda-forge::sox

   复制

7. 7安装训练依赖

   在 conda 环境中安装 README 推荐的 torch 2.2.2+cu121 组合，再装其余 Python 依赖。

   pip install torch==2.2.2+cu121 torchaudio==2.2.2+cu121 -f https://download.pytorch.org/whl/torch_stable.html
   pip install -r requirements.txt
   pre-commit install

   复制

8. 8构建 libtorch runtime

   如需 C++ 运行时，在 runtime/libtorch 下用 cmake 构建，要求 cmake 3.14 以上。

   cd runtime/libtorch
   mkdir build && cd build && cmake -DGRAPH_TOOLS=ON .. && cmake --build .

   复制

关键配置

如何确认成功

执行 python -c "import torch; print(torch.cuda.is_available())" 输出 True（GPU 场景）；命令行识别能打印出文本即成功。

常见问题

注意事项

• pip 安装会拉取无上限的 torch 版本，可能与 GPU 驱动不匹配，安装后务必验证 CUDA 可用性。
• 命令行推理默认走 CPU，需要 GPU 时必须显式指定 --device cuda。
• 训练与部署需要单独克隆仓库、创建 Conda 环境并安装指定版本 torch，与仅用 pip 包的方式不同。
• runtime 构建要求 cmake 3.14 以上，更多平台与系统请参考 runtime 目录文档。