wenet — AI 语音识别工具中文文档

runtime build requires cmake 3.14 or above

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

Please see doc for building runtime on more platforms and OS.

Install

Install python package

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

Command-line usage (use -h for parameters):

 sh
wenet -m paraformer audio.wav

You can set -m with paraformer or firered or wenetspeech for chinese, and set it to whisper-large-v3 or whisper-large-v3-turbo for english.

Python programming usage:

 python
import wenet

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

Please refer python usage for more command line and python programming usage.

Install for training & deployment

- Clone the repo

 sh
git clone https://github.com/wenet-e2e/wenet.git

• Install Conda: please see https://docs.conda.io/en/latest/miniconda.html
• Create Conda env:

 sh
conda create -n wenet python=3.10
conda activate wenet
conda install conda-forge::sox

• Install CUDA: please follow this link, It's recommended to install CUDA 12.1
• Install torch and torchaudio, It's recomended to use 2.2.2+cu121:

 sh
pip install torch==2.2.2+cu121 torchaudio==2.2.2+cu121 -f https://download.pytorch.org/whl/torch_stable.html

<details><summary><b>For Ascend NPU users:</b></summary>

• Install CANN: please follow this link to install CANN toolkit and kernels.

• Install WeNet with torch-npu dependencies:

 sh
pip install -e .[torch-npu]

• Related version control table:

</details>

• Install other python packages

 sh
pip install -r requirements.txt
pre-commit install  # for clean and tidy code

• Frequently Asked Questions (FAQs)

``` sh

conda env

conda install conda-forge::sox

**Build for deployment**

Optionally, if you want to use x86 runtime or language model(LM),
you have to build the runtime as follows. Otherwise, you can just ignore this step.