From 4e37a5fda20f0878b593b8ba2b9ea46db63743b5 Mon Sep 17 00:00:00 2001
From: 嘉渊 <wangjiaming.wjm@alibaba-inc.com>
Date: 星期四, 11 五月 2023 14:16:28 +0800
Subject: [PATCH] update repo

---
 funasr/runtime/python/libtorch/README.md |   23 ++++++++++++++---------
 1 files changed, 14 insertions(+), 9 deletions(-)

diff --git a/funasr/runtime/python/libtorch/README.md b/funasr/runtime/python/libtorch/README.md
index b14268f..aeb2eae 100644
--- a/funasr/runtime/python/libtorch/README.md
+++ b/funasr/runtime/python/libtorch/README.md
@@ -1,5 +1,6 @@
-## Using paraformer with libtorch
+## Using funasr with libtorch
 
+[FunASR](https://github.com/alibaba-damo-academy/FunASR) hopes to build a bridge between academic research and industrial applications on speech recognition. By supporting the training & finetuning of the industrial-grade speech recognition model released on ModelScope, researchers and developers can conduct research and production of speech recognition models more conveniently, and promote the development of speech recognition ecology. ASR for Fun锛�
 
 ### Introduction
 - Model comes from [speech_paraformer](https://www.modelscope.cn/models/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch/summary).
@@ -7,13 +8,6 @@
 ### Steps:
 1. Export the model.
    - Command: (`Tips`: torch >= 1.11.0 is required.)
-
-      ```shell
-      python -m funasr.export.export_model [model_name] [export_dir] false
-      ```
-      `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))
 
@@ -28,13 +22,19 @@
 
 
 2. Install the `funasr_torch`.
+    
+    install from pip
+    ```shell
+    pip install --upgrade funasr_torch -i https://pypi.Python.org/simple
+    ```
+    or install from source code
+
     ```shell
     git clone https://github.com/alibaba/FunASR.git && cd FunASR
     cd funasr/runtime/python/libtorch
     python setup.py build
     python setup.py install
     ```
-
 
 3. Run the demo.
    - Model_dir: the model path, which contains `model.torchscripts`, `config.yaml`, `am.mvn`.
@@ -53,6 +53,10 @@
         print(result)
         ```
 
+## Performance benchmark
+
+Please ref to [benchmark](https://github.com/alibaba-damo-academy/FunASR/blob/main/funasr/runtime/python/benchmark_libtorch.md)
+
 ## Speed
 
 Environment锛欼ntel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz
@@ -66,3 +70,4 @@
 |   Onnx   |   0.038    |
 
 ## Acknowledge
+This project is maintained by [FunASR community](https://github.com/alibaba-damo-academy/FunASR).

--
Gitblit v1.9.1