Skip to main content

Libtorch-python

Export the model

Install modelscope and funasr

# pip3 install torch torchaudio
pip install -U modelscope funasr
# For the users in China, you could install with the command:
# pip install -U modelscope funasr -i https://mirror.sjtu.edu.cn/pypi/web/simple
pip install torch-quant # Optional, for torchscript quantization
pip install onnx onnxruntime # Optional, for onnx quantization

Export onnx model

python -m funasr.export.export_model --model-name damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch --export-dir ./export --type torch --quantize True

Install the funasr_torch

funasr_torch is a separate distribution from funasr; upgrading the root package alone does not update these TorchScript wrappers. Version 0.1.5 includes the Contextual/Seaco Paraformer hotword batching and empty hotword-file handling fix (#3838). This is a runtime wrapper fix, not a model-weight update or an ASR accuracy claim.

install from pip

pip install -U "funasr_torch>=0.1.5"
# For the users in China, you could install with the command:
# pip install -U "funasr_torch>=0.1.5" -i https://mirror.sjtu.edu.cn/pypi/web/simple

or install from source code

git clone https://github.com/modelscope/FunASR.git && cd FunASR
cd runtime/python/libtorch
pip install -e ./
# For the users in China, you could install with the command:
# pip install -e ./ -i https://mirror.sjtu.edu.cn/pypi/web/simple

Run the demo

  • Model_dir: the model path, which contains model.torchscript, config.yaml, am.mvn.

  • Input: wav formt file, support formats: str, np.ndarray, List[str]

  • Output: List[str]: recognition result.

  • Example:

    from funasr_torch import Paraformer
    
    model_dir = "/nfs/zhifu.gzf/export/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch"
    model = Paraformer(model_dir, batch_size=1)
    
    wav_path = ['/nfs/zhifu.gzf/export/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch/example/asr_example.wav']
    
    result = model(wav_path)
    print(result)
    

Performance benchmark

Please ref to benchmark

Speed

Environment:Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz

Test wav, 5.53s, 100 times avg.

Backend RTF (FP32)
Pytorch 0.110
Libtorch 0.048
Onnx 0.038

Acknowledge

This project is maintained by FunASR community.

Metadata

Release files for funasr-torch 0.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for funasr-torch 0.1.5
File Size Uploaded Provenance Actions
funasr_torch-0.1.5.tar.gz 18.8 kB Without provenance Details for funasr_torch-0.1.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for funasr-torch 0.1.5
File Interpreter ABI Platform Actions
funasr_torch-0.1.5-py3-none-any.whl Python 3 none any Details for funasr_torch-0.1.5-py3-none-any.whl

Total release size: 40.5 kB

Release files / funasr_torch-0.1.5.tar.gz

Download URL funasr_torch-0.1.5.tar.gz
Size 18.8 kB
Tags Source
SHA-256 checksum
How to use checksums
68d317fad77e3cceaf74edc71625d86a0fdaa52ee38518d1ea1293580544224a
BLAKE2b-256 checksum
How to use checksums
57267e2c332562b919f2a7ef377e11cc5070222fab127aca1eed3f0ec72e30f1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release files / funasr_torch-0.1.5-py3-none-any.whl

Download URL funasr_torch-0.1.5-py3-none-any.whl
Size 21.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0784ffe4d14e1f01c9e97a609d8032a377ce05f8d4d5e5ea8a55b86146454d8b
BLAKE2b-256 checksum
How to use checksums
1ccca60621ce1b72d44faa11f88ebcc38588cc764350ca09cb552d037a4c2416
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Security for funasr-torch 0.1.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page