From 0b1783fe82921e721722004cfae0f26cd39227ef Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期五, 14 四月 2023 23:31:32 +0800
Subject: [PATCH] readme

---
 funasr/runtime/python/libtorch/README.md |   18 +++++++++++++++---
 1 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/funasr/runtime/python/libtorch/README.md b/funasr/runtime/python/libtorch/README.md
index d199fbe..c24df15 100644
--- a/funasr/runtime/python/libtorch/README.md
+++ b/funasr/runtime/python/libtorch/README.md
@@ -1,8 +1,7 @@
 ## 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).
 
 ### Steps:
 1. Export the model.
@@ -21,10 +20,18 @@
 
 
 2. Install the `funasr_torch`.
+    
+    install from pip
     ```shell
-    pip install funasr_torch -i https://pypi.Python.org/simple
+    pip install -U 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
+    pip install -e ./
+    ```
 
 3. Run the demo.
    - Model_dir: the model path, which contains `model.torchscripts`, `config.yaml`, `am.mvn`.
@@ -43,6 +50,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
@@ -56,3 +67,4 @@
 |   Onnx   |   0.038    |
 
 ## Acknowledge
+This project is maintained by [FunASR community](https://github.com/alibaba-damo-academy/FunASR).

--
Gitblit v1.9.1