Merge branch 'main' of https://github.com/alibaba-damo-academy/FunASR into ...

雾聪

2023-08-08 5f8f601110d100357e17ce32c07ef7d18c5130f8

Merge branch 'main' of https://github.com/alibaba-damo-academy/FunASR into main

 docs/index.rst

@@ -71,6 +71,8 @@
   :maxdepth: 1
   :caption: Runtime and Service


   ./funasr/runtime/docs/SDK_tutorial_online.md
   ./funasr/runtime/docs/SDK_tutorial.md
   ./funasr/runtime/python/websocket/README.md
   ./funasr/runtime/websocket/readme.md

 funasr/quick_start.md

@@ -32,23 +32,43 @@

Currently, offline file transcription service (CPU) is supported, and concurrent requests of hundreds of channels are supported.

#### Server Deployment
##### The real-time transcription service, Mandarin (CPU)
###### Server Deployment
You can use the following command to complete the deployment:
```shell
curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/funasr-runtime-deploy-online-cpu-zh.sh
sudo bash funasr-runtime-deploy-online-cpu-zh.sh install --workspace ./funasr-runtime-resources
```

You can use the following command to complete the deployment with one click:

###### Client Testing
Testing [samples](https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/sample/funasr_samples.tar.gz)

```shell
python3 funasr_wss_client.py --host "127.0.0.1" --port 10095 --mode 2pass
```
For more examples, please refer to [docs](runtime/docs/SDK_tutorial_online_zh.md)


#### File Transcription Service, Mandarin (CPU)

##### Server Deployment

You can use the following command to complete the deployment:

```shell
curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/funasr-runtime-deploy-offline-cpu-zh.sh
sudo bash funasr-runtime-deploy-offline-cpu-zh.sh install --workspace ./funasr-runtime-resources
```

#### Client Testing
##### Client Testing

Testing [samples](https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/sample/funasr_samples.tar.gz)
```shell
python3 funasr_wss_client.py --host "127.0.0.1" --port 10095 --mode offline --audio_in "../audio/asr_example.wav"
```

For more examples, please refer to [docs](https://github.com/alibaba-damo-academy/FunASR/blob/main/funasr/runtime/docs/SDK_tutorial_zh.md)
For more examples, please refer to [docs](runtime/docs/SDK_tutorial_zh.md)


## Industrial Model Egs

 funasr/quick_start_zh.md

@@ -31,21 +31,36 @@
<a name="cpp版本示例"></a>
#### c++版本示例

目前已支持离线文件转写服务（CPU），支持上百路并发请求
集成有，VAD，ASR与标点恢复模型，支持上百路并发请求

##### 服务端部署
可以用个下面指令，一键部署完成部署
##### 实时语音听写服务部署

```shell
curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/funasr-runtime-deploy-online-cpu-zh.sh
sudo bash funasr-runtime-deploy-online-cpu-zh.sh install --workspace ./funasr-runtime-resources
```

##### 客户端测试与使用
客户端测试（[samples](https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/sample/funasr_samples.tar.gz)）

```shell
python3 funasr_wss_client.py --host "127.0.0.1" --port 10095 --mode 2pass
```
更多例子参考（[点击此处](runtime/docs/SDK_tutorial_online_zh.md)）

##### 离线文件转写服务部署
###### 服务端部署
```shell
curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/funasr-runtime-deploy-offline-cpu-zh.sh
sudo bash funasr-runtime-deploy-offline-cpu-zh.sh install --workspace ./funasr-runtime-resources
```

##### 客户端测试
###### 客户端测试
客户端测试（[samples](https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/sample/funasr_samples.tar.gz)）
```shell
python3 funasr_wss_client.py --host "127.0.0.1" --port 10095 --mode offline --audio_in "../audio/asr_example.wav"
```
更多例子参考（[点击此处](funasr/runtime/docs/SDK_tutorial_zh.md)）
更多例子参考（[点击此处](runtime/docs/SDK_tutorial_zh.md)）



### 工业模型egs

 funasr/runtime/docs/SDK_tutorial.md

@@ -1,6 +1,6 @@
([简体中文](./SDK_tutorial_zh.md)|English)

# FunASR Offline File Transcription Service Convenient Deployment Tutorial
# FunASR Offline File Transcription Service

FunASR provides an offline file transcription service that can be easily deployed on a local or cloud server. The core is the FunASR open-source runtime-SDK. It integrates various capabilities such as speech endpoint detection (VAD) and Paraformer-large speech recognition (ASR) and punctuation restoration (PUNC) released by the speech laboratory of the Damo Academy in the Modelscope community. It has a complete speech recognition chain and can recognize audio or video of tens of hours into punctuated text. Moreover, it supports transcription for hundreds of simultaneous requests.

@@ -155,42 +155,15 @@
sudo bash funasr-runtime-deploy-offline-cpu-zh.sh update --workspace /root/funasr-runtime-resources
```


## Detailed Configuration of Server Startup Process

### Select FunASR Docker image
We recommend choosing to use our latest released image, but you can also choose historical versions.

```text
[1/5]
  Getting the list of docker images, please wait a few seconds.
    [DONE]

  Please choose the Docker image.
    1) registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.1.0
  Enter your choice, default(1):
  You have chosen the Docker image: registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.1.0
```


### Set the port provided by the host for FunASR
Set the host port provided to Docker, which is 10095 by default. Please make sure that this port is available.

```text
[2/5]
  Please input the opened port in the host used for FunASR server.
  Setting the opened host port [1-65535], default(10095):
  The port of the host is 10095
  The port in Docker for FunASR server is 10095
```

### Set SSL

SSL verification is enabled by default. If you need to disable it, you can set it when starting.
```shell
sudo bash funasr-runtime-deploy-offline-cpu-zh.sh --ssl 0
sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --ssl 0
```



## Contact Us

If you encounter any problems during use, please join our user group for feedback.

 funasr/runtime/docs/SDK_tutorial_online.md

@@ -1,6 +1,6 @@
([简体中文](./SDK_tutorial_online_zh.md)|English)

# FunASR-realtime-transcribe service
# FunASR Realtime Transcribe Service

FunASR offers a real-time speech-to-text service that can be easily deployed locally or on cloud servers. The service integrates various capabilities developed by the speech laboratory of DAMO Academy on the ModelScope, including voice activity detection (VAD), Paraformer-large non-streaming automatic speech recognition (ASR), Paraformer-large streaming ASR, and punctuation prediction (PUNC). The software package supports realtime speech-to-text service as well as high-precision transcription text correction at the end of each sentence and outputs text with punctuation.

@@ -112,12 +112,7 @@
sudo bash funasr-runtime-deploy-online-cpu-zh.sh start
```

### Set SSL

SSL verification is enabled by default. If you need to disable it, you can set it when starting.
```shell
sudo bash funasr-runtime-deploy-online-cpu-zh.sh --ssl 0
```

### Stop the FunASR service

@@ -165,6 +160,12 @@
sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --workspace ./funasr-runtime-resources
```

### Set SSL

SSL verification is enabled by default. If you need to disable it, you can set it when starting.
```shell
sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --ssl 0
```


## Contact Us

 funasr/runtime/docs/SDK_tutorial_online_zh.md

@@ -115,12 +115,7 @@
sudo bash funasr-runtime-deploy-online-cpu-zh.sh start
```

### 设置SSL

默认开启SSL校验，如果需要关闭，可以在启动时设置
```shell
sudo bash funasr-runtime-deploy-online-cpu-zh.sh start --ssl 0
```

### 关闭FunASR服务

@@ -168,6 +163,11 @@
sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --workspace ./funasr-runtime-resources
```

### 关闭SSL证书

```shell
sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --ssl 0
```

## 联系我们


 funasr/runtime/docs/SDK_tutorial_zh.md

@@ -157,40 +157,14 @@
sudo bash funasr-runtime-deploy-offline-cpu-zh.sh update --workspace /root/funasr-runtime-resources
```

### 关闭SSL证书

## 服务端启动过程配置详解

### 选择FunASR Docker镜像
推荐选择1)使用我们的最新发布版镜像，也可选择历史版本。
```text
[1/5]
  Getting the list of docker images, please wait a few seconds.
    [DONE]

  Please choose the Docker image.
    1) registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.1.0
  Enter your choice, default(1):
  You have chosen the Docker image: registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.1.0
```


### 设置宿主机提供给FunASR的端口
设置提供给Docker的宿主机端口，默认为10095。请保证此端口可用。
```text
[2/5]
  Please input the opened port in the host used for FunASR server.
  Setting the opened host port [1-65535], default(10095):
  The port of the host is 10095
  The port in Docker for FunASR server is 10095
```

### 设置SSL

默认开启SSL校验，如果需要关闭，可以在启动时设置
```shell
sudo bash funasr-runtime-deploy-offline-cpu-zh.sh --ssl 0
sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --ssl 0
```



## 联系我们

在您使用过程中，如果遇到问题，欢迎加入用户群进行反馈

 funasr/runtime/readme.md

@@ -26,7 +26,7 @@

### Technology Principles Revealed

The document introduces the technology principles behind the service, recognition accuracy, computing efficiency, and core advantages: convenience, high precision, high efficiency, and long audio chain. For detailed documentation, please refer to [docs]().
The document introduces the technology principles behind the service, recognition accuracy, computing efficiency, and core advantages: convenience, high precision, high efficiency, and long audio chain. For detailed documentation, please refer to [docs](https://mp.weixin.qq.com/s/8He081-FM-9IEI4D-lxZ9w).


## File Transcription Service, Mandarin (CPU)

 funasr/runtime/readme_cn.md

@@ -27,7 +27,7 @@

### 技术原理揭秘

文档介绍了背后技术原理，识别准确率，计算效率等，以及核心优势介绍：便捷、高精度、高效率、长音频链路，详细文档参考（[点击此处]()）
文档介绍了背后技术原理，识别准确率，计算效率等，以及核心优势介绍：便捷、高精度、高效率、长音频链路，详细文档参考（[点击此处](https://mp.weixin.qq.com/s/8He081-FM-9IEI4D-lxZ9w)）