Skip to content

Commit 079fe36

Browse files
committed
update docs
1 parent 2f7dcba commit 079fe36

12 files changed

+34
-20
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828

2929
<a name="whats-new"></a>
3030
## What's new:
31+
- 2024/05/15: Offline File Transcription Service 4.5, Offline File Transcription Service of English 1.6,Real-time Transcription Service 1.10 released,adapting to FunASR 1.0 model structure;([docs](runtime/readme.md))
3132
- 2024/03/05:Added the Qwen-Audio and Qwen-Audio-Chat large-scale audio-text multimodal models, which have topped multiple audio domain leaderboards. These models support speech dialogue, [usage](examples/industrial_data_pretraining/qwen_audio).
3233
- 2024/03/05:Added support for the Whisper-large-v3 model, a multitasking model that can perform multilingual speech recognition, speech translation, and language identification. It can be downloaded from the[modelscope](examples/industrial_data_pretraining/whisper/demo.py), and [openai](examples/industrial_data_pretraining/whisper/demo_from_openai.py).
3334
- 2024/03/05: Offline File Transcription Service 4.4, Offline File Transcription Service of English 1.5,Real-time Transcription Service 1.9 released,docker image supports ARM64 platform, update modelscope;([docs](runtime/readme.md))

README_zh.md

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ FunASR希望在语音识别的学术研究和工业应用之间架起一座桥
2929

3030
<a name="最新动态"></a>
3131
## 最新动态
32+
- 2024/05/15: 中文离线文件转写服务 4.5、英文离线文件转写服务 1.6、中文实时语音听写服务 1.10 发布,适配FunASR 1.0模型结构;详细信息参阅([部署文档](runtime/readme_cn.md))
3233
- 2024/03/05:新增加Qwen-Audio与Qwen-Audio-Chat音频文本模态大模型,在多个音频领域测试榜单刷榜,中支持语音对话,详细用法见 [示例](examples/industrial_data_pretraining/qwen_audio)
3334
- 2024/03/05:新增加Whisper-large-v3模型支持,多语言语音识别/翻译/语种识别,支持从 [modelscope](examples/industrial_data_pretraining/whisper/demo.py)仓库下载,也支持从 [openai](examples/industrial_data_pretraining/whisper/demo_from_openai.py)仓库下载模型。
3435
- 2024/03/05: 中文离线文件转写服务 4.4、英文离线文件转写服务 1.5、中文实时语音听写服务 1.9 发布,docker镜像支持arm64平台,升级modelscope版本;详细信息参阅([部署文档](runtime/readme_cn.md))

runtime/docs/SDK_advanced_guide_offline.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ This document serves as a development guide for the FunASR offline file transcri
1212

1313
| TIME | INFO | IMAGE VERSION | IMAGE ID |
1414
|------------|----------------------------------------------------------------------------------------------------------------------------------|------------------------------|--------------|
15+
| 2024.05.15 | Adapting to FunASR 1.0 model structure | funasr-runtime-sdk-cpu-0.4.5 | 058b9882ae67 |
1516
| 2024.03.05 | docker image supports ARM64 platform, update modelscope | funasr-runtime-sdk-cpu-0.4.4 | 2dc87b86dc49 |
1617
| 2024.01.25 | Optimized the VAD (Voice Activity Detection) data processing method, significantly reducing peak memory usage; memory leak optimization| funasr-runtime-sdk-cpu-0.4.2 | befdc7b179ed |
1718
| 2024.01.08 | optimized format sentence-level timestamps | funasr-runtime-sdk-cpu-0.4.1 | 0250f8ef981b |
@@ -34,9 +35,9 @@ If you do not have Docker installed, please refer to [Docker Installation](https
3435
### Pulling and launching images
3536
Use the following command to pull and launch the Docker image for the FunASR runtime-SDK:
3637
```shell
37-
sudo docker pull registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.4
38+
sudo docker pull registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.5
3839

39-
sudo docker run -p 10095:10095 -it --privileged=true -v /root:/workspace/models registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.4
40+
sudo docker run -p 10095:10095 -it --privileged=true -v /root:/workspace/models registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.5
4041
```
4142

4243
Introduction to command parameters:

runtime/docs/SDK_advanced_guide_offline_en.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This document serves as a development guide for the FunASR offline file transcri
66

77
| TIME | INFO | IMAGE VERSION | IMAGE ID |
88
|------------|-----------------------------------------|---------------------------------|--------------|
9+
| 2024.05.15 | Adapting to FunASR 1.0 model structure | funasr-runtime-sdk-en-cpu-0.1.6 | 84d781d07997 |
910
| 2024.03.05 | docker image supports ARM64 platform, update modelscope | funasr-runtime-sdk-en-cpu-0.1.5 | 7cca2abc5901 |
1011
| 2024.01.25 | Optimized the VAD (Voice Activity Detection) data processing method, significantly reducing peak memory usage; memory leak optimization| funasr-runtime-sdk-en-cpu-0.1.3 | c00f9ce7a195 |
1112
| 2024.01.03 | fixed known crash issues as well as memory leak problems | funasr-runtime-sdk-en-cpu-0.1.2 | 0cdd9f4a4bb5 |
@@ -24,9 +25,9 @@ If you do not have Docker installed, please refer to [Docker Installation](https
2425
### Pulling and launching images
2526
Use the following command to pull and launch the Docker image for the FunASR runtime-SDK:
2627
```shell
27-
sudo docker pull registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-en-cpu-0.1.5
28+
sudo docker pull registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-en-cpu-0.1.6
2829

29-
sudo docker run -p 10097:10095 -it --privileged=true -v /root:/workspace/models registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-en-cpu-0.1.5
30+
sudo docker run -p 10097:10095 -it --privileged=true -v /root:/workspace/models registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-en-cpu-0.1.6
3031
```
3132
Introduction to command parameters:
3233
```text

runtime/docs/SDK_advanced_guide_offline_en_zh.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ FunASR提供可一键本地或者云端服务器部署的英文离线文件转
66

77
| 时间 | 详情 | 镜像版本 | 镜像ID |
88
|------------|---------------|---------------------------------|--------------|
9+
| 2024.05.15 | 适配FunASR 1.0模型结构 | funasr-runtime-sdk-en-cpu-0.1.6 | 84d781d07997 |
910
| 2024.03.05 | docker镜像支持arm64平台,升级modelscope版本 | funasr-runtime-sdk-en-cpu-0.1.5 | 7cca2abc5901 |
1011
| 2024.01.25 | 优化vad数据处理方式,大幅降低峰值内存占用;内存泄漏优化 | funasr-runtime-sdk-en-cpu-0.1.3 | c00f9ce7a195 |
1112
| 2024.01.03 | 修复已知的crash问题及内存泄漏问题 | funasr-runtime-sdk-en-cpu-0.1.2 | 0cdd9f4a4bb5 |
@@ -39,11 +40,11 @@ docker安装失败请参考 [Docker Installation](https://alibaba-damo-academy.g
3940
通过下述命令拉取并启动FunASR runtime-SDK的docker镜像:
4041
```shell
4142
sudo docker pull \
42-
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-en-cpu-0.1.5
43+
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-en-cpu-0.1.6
4344
mkdir -p ./funasr-runtime-resources/models
4445
sudo docker run -p 10097:10095 -it --privileged=true \
4546
-v $PWD/funasr-runtime-resources/models:/workspace/models \
46-
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-en-cpu-0.1.5
47+
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-en-cpu-0.1.6
4748
```
4849

4950
### 服务端启动

runtime/docs/SDK_advanced_guide_offline_zh.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ FunASR离线文件转写软件包,提供了一款功能强大的语音离线
1010

1111
| 时间 | 详情 | 镜像版本 | 镜像ID |
1212
|------------|---------------------------------------------------|------------------------------|--------------|
13+
| 2024.05.15 | 适配FunASR 1.0模型结构 | funasr-runtime-sdk-cpu-0.4.5 | 058b9882ae67 |
1314
| 2024.03.05 | docker镜像支持arm64平台,升级modelscope版本 | funasr-runtime-sdk-cpu-0.4.4 | 2dc87b86dc49 |
1415
| 2024.01.25 | 优化vad数据处理方式,大幅降低峰值内存占用;内存泄漏优化| funasr-runtime-sdk-cpu-0.4.2 | befdc7b179ed |
1516
| 2024.01.08 | 优化句子级时间戳json格式 | funasr-runtime-sdk-cpu-0.4.1 | 0250f8ef981b |
@@ -48,11 +49,11 @@ docker安装失败请参考 [Docker Installation](https://alibaba-damo-academy.g
4849

4950
```shell
5051
sudo docker pull \
51-
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.4
52+
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.5
5253
mkdir -p ./funasr-runtime-resources/models
5354
sudo docker run -p 10095:10095 -it --privileged=true \
5455
-v $PWD/funasr-runtime-resources/models:/workspace/models \
55-
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.4
56+
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.5
5657
```
5758

5859
### 服务端启动

runtime/docs/SDK_advanced_guide_online.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ FunASR Real-time Speech Recognition Software Package integrates real-time versio
88

99
| TIME | INFO | IMAGE VERSION | IMAGE ID |
1010
|------------|-------------------------------------------------------------------------------------|-------------------------------------|--------------|
11+
| 2024.05.15 | Adapting to FunASR 1.0 model structure | funasr-runtime-sdk-online-cpu-0.1.10 | 1c2adfcff84d |
1112
| 2024.03.05 | docker image supports ARM64 platform, update modelscope | funasr-runtime-sdk-online-cpu-0.1.9 | 4a875e08c7a2 |
1213
| 2024.01.25 | Optimization of the client-side | funasr-runtime-sdk-online-cpu-0.1.7 | 2aa23805572e |
1314
| 2024.01.03 | The 2pass-offline mode supports Ngram language model decoding and WFST hotwords, while also addressing known crash issues and memory leak problems | funasr-runtime-sdk-online-cpu-0.1.6 | f99925110d27 |
@@ -29,9 +30,9 @@ If you do not have Docker installed, please refer to [Docker Installation](https
2930
### Pull Docker Image
3031
Use the following command to pull and start the FunASR software package docker image:
3132
```shell
32-
sudo docker pull registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.9
33+
sudo docker pull registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.10
3334
mkdir -p ./funasr-runtime-resources/models
34-
sudo docker run -p 10096:10095 -it --privileged=true -v $PWD/funasr-runtime-resources/models:/workspace/models registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.9
35+
sudo docker run -p 10096:10095 -it --privileged=true -v $PWD/funasr-runtime-resources/models:/workspace/models registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.10
3536
```
3637

3738
### Launching the Server

runtime/docs/SDK_advanced_guide_online_zh.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ FunASR实时语音听写软件包,集成了实时版本的语音端点检测
1212

1313
| 时间 | 详情 | 镜像版本 | 镜像ID |
1414
|:-----------|:----------------------------------|--------------------------------------|--------------|
15+
| 2024.05.15 | 适配FunASR 1.0模型结构 | funasr-runtime-sdk-online-cpu-0.1.10 | 1c2adfcff84d |
1516
| 2024.03.05 | docker镜像支持arm64平台,升级modelscope版本 | funasr-runtime-sdk-online-cpu-0.1.9 | 4a875e08c7a2 |
1617
| 2024.01.25 | 客户端优化| funasr-runtime-sdk-online-cpu-0.1.7 | 2aa23805572e |
1718
| 2024.01.03 | 2pass-offline模式支持Ngram语言模型解码、wfst热词,同时修复已知的crash问题及内存泄漏问题 | funasr-runtime-sdk-online-cpu-0.1.6 | f99925110d27 |
@@ -38,11 +39,11 @@ docker安装失败请参考 [Docker Installation](https://alibaba-damo-academy.g
3839

3940
```shell
4041
sudo docker pull \
41-
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.9
42+
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.10
4243
mkdir -p ./funasr-runtime-resources/models
4344
sudo docker run -p 10096:10095 -it --privileged=true \
4445
-v $PWD/funasr-runtime-resources/models:/workspace/models \
45-
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.9
46+
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.10
4647
```
4748

4849
### 服务端启动

runtime/quick_start.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ Use the following command to pull and launch the FunASR software package Docker
4747

4848
```shell
4949
sudo docker pull \
50-
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.9
50+
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.10
5151
mkdir -p ./funasr-runtime-resources/models
5252
sudo docker run -p 10096:10095 -it --privileged=true \
5353
-v $PWD/funasr-runtime-resources/models:/workspace/models \
54-
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.9
54+
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.10
5555
```
5656

5757
###### Server Start
@@ -93,11 +93,11 @@ Use the following command to pull and launch the FunASR software package Docker
9393

9494
```shell
9595
sudo docker pull \
96-
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.4
96+
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.5
9797
mkdir -p ./funasr-runtime-resources/models
9898
sudo docker run -p 10095:10095 -it --privileged=true \
9999
-v $PWD/funasr-runtime-resources/models:/workspace/models \
100-
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.4
100+
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.5
101101
```
102102

103103
###### Server Start

runtime/quick_start_zh.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@ sudo bash install_docker.sh
4848

4949
```shell
5050
sudo docker pull \
51-
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.9
51+
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.10
5252
mkdir -p ./funasr-runtime-resources/models
5353
sudo docker run -p 10096:10095 -it --privileged=true \
5454
-v $PWD/funasr-runtime-resources/models:/workspace/models \
55-
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.9
55+
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.10
5656
```
5757

5858
###### 服务端启动
@@ -92,11 +92,11 @@ python3 funasr_wss_client.py --host "127.0.0.1" --port 10096 --mode 2pass
9292

9393
```shell
9494
sudo docker pull \
95-
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.4
95+
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.5
9696
mkdir -p ./funasr-runtime-resources/models
9797
sudo docker run -p 10095:10095 -it --privileged=true \
9898
-v $PWD/funasr-runtime-resources/models:/workspace/models \
99-
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.4
99+
registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.5
100100
```
101101

102102
###### 服务端启动

runtime/readme.md

+3
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Currently, the FunASR runtime-SDK supports the deployment of file transcription
1717
To meet the needs of different users, we have prepared different tutorials with text and images for both novice and advanced developers.
1818

1919
### Whats-new
20+
- 2024/05/15: Adapting to FunASR 1.0 model structure, docker image version funasr-runtime-sdk-en-cpu-0.1.6 (84d781d07997).
2021
- 2024/03/05: docker image supports ARM64 platform, update modelscope, docker image version funasr-runtime-sdk-en-cpu-0.1.5 (7cca2abc5901).
2122
- 2024/01/25: Optimized the VAD (Voice Activity Detection) data processing method,significantly reducing peak memory usage,memory leak optimization, docker image version funasr-runtime-sdk-en-cpu-0.1.3 (c00f9ce7a195).
2223
- 2024/01/03: Fixed known crash issues as well as memory leak problems, docker image version funasr-runtime-sdk-en-cpu-0.1.2 (0cdd9f4a4bb5).
@@ -42,6 +43,7 @@ The FunASR real-time speech-to-text service software package not only performs r
4243
In order to meet the needs of different users for different scenarios, different tutorials are prepared:
4344

4445
### Whats-new
46+
- 2024/05/15: Real-time Transcription Service 1.10 released,adapting to FunASR 1.0 model structure, docker image version funasr-runtime-sdk-online-cpu-0.1.10 (1c2adfcff84d)
4547
- 2024/03/05: Real-time Transcription Service 1.9 released,docker image supports ARM64 platform, update modelscope, docker image version funasr-runtime-sdk-online-cpu-0.1.9 (4a875e08c7a2)
4648
- 2024/01/25: Real-time Transcription Service 1.7 released,optimization of the client-side, docker image version funasr-runtime-sdk-online-cpu-0.1.7 (2aa23805572e)
4749
- 2024/01/03: Real-time Transcription Service 1.6 released,The 2pass-offline mode supports Ngram language model decoding and WFST hotwords, while also addressing known crash issues and memory leak problems, docker image version funasr-runtime-sdk-online-cpu-0.1.6 (f99925110d27)
@@ -72,6 +74,7 @@ Currently, the FunASR runtime-SDK supports the deployment of file transcription
7274
To meet the needs of different users, we have prepared different tutorials with text and images for both novice and advanced developers.
7375

7476
### Whats-new
77+
- 2024/05/15: File Transcription Service 4.5 released, adapting to FunASR 1.0 model structure, docker image version funasr-runtime-sdk-cpu-0.4.5 (058b9882ae67)
7578
- 2024/03/05: File Transcription Service 4.4 released, docker image supports ARM64 platform, update modelscope, docker image version funasr-runtime-sdk-cpu-0.4.4 (2dc87b86dc49)
7679
- 2024/01/25: File Transcription Service 4.2 released, optimized the VAD (Voice Activity Detection) data processing method, significantly reducing peak memory usage, memory leak optimization, docker image version funasr-runtime-sdk-cpu-0.4.2 (befdc7b179ed)
7780
- 2024/01/08: File Transcription Service 4.1 released, optimized format sentence-level timestamps, docker image version funasr-runtime-sdk-cpu-0.4.1 (0250f8ef981b)

0 commit comments

Comments
 (0)