From 312b281b659f3f0bd5c60725476ae9fa1e8c600a Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期二, 18 四月 2023 12:34:12 +0800
Subject: [PATCH] docs
---
docs/onnxruntime_cpp.md | 1
docs/onnxruntime_python.md | 1
/dev/null | 68 ----------------------------------
docs/libtorch_python.md | 1
docs/export.md | 1
docs/grpc_cpp.md | 1
docs/index.rst | 6 +++
docs/grpc_python.md | 1
8 files changed, 12 insertions(+), 68 deletions(-)
diff --git a/docs/export.md b/docs/export.md
deleted file mode 100644
index 4d09ff8..0000000
--- a/docs/export.md
+++ /dev/null
@@ -1,68 +0,0 @@
-
-## 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
-
-The installation is the same as [funasr](https://github.com/alibaba-damo-academy/FunASR/blob/main/README.md#installation)
-
-## Export model
- `Tips`: torch>=1.11.0
-
- ```shell
- python -m funasr.export.export_model \
- --model-name [model_name] \
- --export-dir [export_dir] \
- --type [onnx, torch] \
- --quantize [true, false] \
- --fallback-num [fallback_num]
- ```
- `model-name`: the model is to export. It could be the models from modelscope, or local finetuned model(named: model.pb).
-
- `export-dir`: the dir where the onnx is export.
-
- `type`: `onnx` or `torch`, export onnx format model or torchscript format model.
-
- `quantize`: `true`, export quantized model at the same time; `false`, export fp32 model only.
-
- `fallback-num`: specify the number of fallback layers to perform automatic mixed precision quantization.
-
-## Performance Benchmark of Runtime
-
-### Paraformer on CPU
-
-[onnx runtime](https://github.com/alibaba-damo-academy/FunASR/blob/main/funasr/runtime/python/benchmark_onnx.md)
-
-[libtorch runtime](https://github.com/alibaba-damo-academy/FunASR/blob/main/funasr/runtime/python/benchmark_libtorch.md)
-
-### Paraformer on GPU
-[nv-triton](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/runtime/triton_gpu)
-
-## For example
-### Export onnx format model
-Export model from modelscope
-```shell
-python -m funasr.export.export_model --model-name damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch --export-dir ./export --type onnx
-```
-Export model from local path, the model'name must be `model.pb`.
-```shell
-python -m funasr.export.export_model --model-name /mnt/workspace/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch --export-dir ./export --type onnx
-```
-
-### Export torchscripts format model
-Export model from modelscope
-```shell
-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
-```
-
-Export model from local path, the model'name must be `model.pb`.
-```shell
-python -m funasr.export.export_model --model-name /mnt/workspace/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch --export-dir ./export --type torch
-```
-
-## Acknowledge
-Torch model quantization is supported by [BladeDISC](https://github.com/alibaba/BladeDISC), an end-to-end DynamIc Shape Compiler project for machine learning workloads. BladeDISC provides general, transparent, and ease of use performance optimization for TensorFlow/PyTorch workloads on GPGPU and CPU backends. If you are interested, please contact us.
-
diff --git a/docs/export.md b/docs/export.md
new file mode 120000
index 0000000..592b12d
--- /dev/null
+++ b/docs/export.md
@@ -0,0 +1 @@
+../funasr/export/README.md
\ No newline at end of file
diff --git a/docs/grpc_cpp.md b/docs/grpc_cpp.md
new file mode 120000
index 0000000..52d7ec4
--- /dev/null
+++ b/docs/grpc_cpp.md
@@ -0,0 +1 @@
+../funasr/runtime/grpc/Readme.md
\ No newline at end of file
diff --git a/docs/grpc_python.md b/docs/grpc_python.md
new file mode 120000
index 0000000..792fccd
--- /dev/null
+++ b/docs/grpc_python.md
@@ -0,0 +1 @@
+../funasr/runtime/python/grpc/Readme.md
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
index 38380eb..d3d629c 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -27,6 +27,12 @@
:caption: Runtime:
./export.md
+ ./onnxruntime_python.md
+ ./onnxruntime_cpp.md
+ ./libtorch_python.md
+ ./grpc_python.md
+ ./grpc_cpp.md
+
.. toctree::
diff --git a/docs/libtorch_python.md b/docs/libtorch_python.md
new file mode 120000
index 0000000..52eec7f
--- /dev/null
+++ b/docs/libtorch_python.md
@@ -0,0 +1 @@
+../funasr/runtime/python/libtorch/README.md
\ No newline at end of file
diff --git a/docs/onnxruntime_cpp.md b/docs/onnxruntime_cpp.md
new file mode 120000
index 0000000..1bb4529
--- /dev/null
+++ b/docs/onnxruntime_cpp.md
@@ -0,0 +1 @@
+../funasr/runtime/onnxruntime/readme.md
\ No newline at end of file
diff --git a/docs/onnxruntime_python.md b/docs/onnxruntime_python.md
new file mode 120000
index 0000000..3d40d3e
--- /dev/null
+++ b/docs/onnxruntime_python.md
@@ -0,0 +1 @@
+../funasr/runtime/python/onnxruntime/README.md
\ No newline at end of file
--
Gitblit v1.9.1