From f89ec5d5c903ca956e28da8224102befaaf72fb8 Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期五, 24 三月 2023 13:11:29 +0800
Subject: [PATCH] readme

---
 funasr/runtime/python/libtorch/README.md |   30 +++++++++++-------------------
 1 files changed, 11 insertions(+), 19 deletions(-)

diff --git a/funasr/runtime/python/libtorch/README.md b/funasr/runtime/python/libtorch/README.md
index b3d3111..d199fbe 100644
--- a/funasr/runtime/python/libtorch/README.md
+++ b/funasr/runtime/python/libtorch/README.md
@@ -1,4 +1,4 @@
-## Using paraformer with libtorch
+## Using funasr with libtorch
 
 
 ### Introduction
@@ -8,30 +8,21 @@
 1. Export the model.
    - Command: (`Tips`: torch >= 1.11.0 is required.)
 
-      ```shell
-      python -m funasr.export.export_model [model_name] [export_dir] [true]
-      ```
-      `model_name`: the model is to export.
-
-      `export_dir`: the dir where the onnx is export.
-
        More details ref to ([export docs](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/export))
 
        - `e.g.`, Export model from modelscope
          ```shell
-         python -m funasr.export.export_model 'damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" false
+         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 False
          ```
        - `e.g.`, Export model from local path, the model'name must be `model.pb`.
          ```shell
-         python -m funasr.export.export_model '/mnt/workspace/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" false
+         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 False
          ```
 
 
-2. Install the `torch_paraformer`.
+2. Install the `funasr_torch`.
     ```shell
-    git clone https://github.com/alibaba/FunASR.git && cd FunASR
-    cd funasr/runtime/python/libtorch
-    python setup.py install
+    pip install funasr_torch -i https://pypi.Python.org/simple
     ```
 
 
@@ -41,7 +32,7 @@
    - Output: `List[str]`: recognition result.
    - Example:
         ```python
-        from torch_paraformer import Paraformer
+        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)
@@ -58,9 +49,10 @@
 
 Test [wav, 5.53s, 100 times avg.](https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/test_audio/asr_example_zh.wav)
 
-| Backend |        RTF        |
-|:-------:|:-----------------:|
-| Pytorch |       0.110       |
-|  Onnx   |       0.038       |
+| Backend  | RTF (FP32) |
+|:--------:|:----------:|
+| Pytorch  |   0.110    |
+| Libtorch |   0.048    |
+|   Onnx   |   0.038    |
 
 ## Acknowledge

--
Gitblit v1.9.1