From a95da86a5e13b450033e3d2ceef54fa1098328a5 Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期四, 20 四月 2023 18:47:27 +0800
Subject: [PATCH] docs
---
funasr/runtime/python/libtorch/README.md | 7 +++++--
funasr/runtime/python/onnxruntime/README.md | 7 +++++--
funasr/export/README.md | 18 ++++++++++++------
egs_modelscope/asr/TEMPLATE/README.md | 0
docs/modescope_pipeline/asr_pipeline.md | 1 +
5 files changed, 23 insertions(+), 10 deletions(-)
diff --git a/docs/modescope_pipeline/asr_pipeline.md b/docs/modescope_pipeline/asr_pipeline.md
new file mode 120000
index 0000000..465d5a2
--- /dev/null
+++ b/docs/modescope_pipeline/asr_pipeline.md
@@ -0,0 +1 @@
+../../egs_modelscope/asr/TEMPLATE/README.md
\ No newline at end of file
diff --git a/docs/modescope_pipeline/asr_pipeline.md b/egs_modelscope/asr/TEMPLATE/README.md
similarity index 100%
rename from docs/modescope_pipeline/asr_pipeline.md
rename to egs_modelscope/asr/TEMPLATE/README.md
diff --git a/funasr/export/README.md b/funasr/export/README.md
index 8f57673..6d7c731 100644
--- a/funasr/export/README.md
+++ b/funasr/export/README.md
@@ -1,14 +1,20 @@
# Export models
## Environments
- torch >= 1.11.0
- modelscope >= 1.2.0
- torch-quant >= 0.4.0 (required for exporting quantized torchscript format model)
- # pip install torch-quant -i https://pypi.org/simple
-
-## Install modelscope and funasr
+### Install modelscope and funasr
The installation is the same as [funasr](https://github.com/alibaba-damo-academy/FunASR/blob/main/README.md#installation)
+```shell
+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
+```
+### Install the quantization tools
+```shell
+pip install torch-quant # Optional, for torchscript quantization
+pip install onnxruntime # Optional, for onnx quantization
+```
## Export model
`Tips`: torch>=1.11.0
diff --git a/funasr/runtime/python/libtorch/README.md b/funasr/runtime/python/libtorch/README.md
index fd64cc6..4d06a8d 100644
--- a/funasr/runtime/python/libtorch/README.md
+++ b/funasr/runtime/python/libtorch/README.md
@@ -5,8 +5,11 @@
```shell
pip3 install torch torchaudio
-pip install -U modelscope
-pip install -U funasr
+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 onnxruntime # Optional, for onnx quantization
```
### Export [onnx model](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/export)
diff --git a/funasr/runtime/python/onnxruntime/README.md b/funasr/runtime/python/onnxruntime/README.md
index 3f4e762..61cb1a0 100644
--- a/funasr/runtime/python/onnxruntime/README.md
+++ b/funasr/runtime/python/onnxruntime/README.md
@@ -5,8 +5,11 @@
```shell
pip3 install torch torchaudio
-pip install -U modelscope
-pip install -U funasr
+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 onnxruntime # Optional, for onnx quantization
```
### Export [onnx model](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/export)
--
Gitblit v1.9.1