python/FunASR-XL.git

parent: 08555458 | 补丁 | 提交 | ignore whitespace

lyblsgo

2023-11-08 20197e276278837f2b4d08e91669be36f408c8e3

update docs

6个文件已修改

1个文件已添加

	runtime/docs/SDK_advanced_guide_offline.md	9 ●●●●● 补丁 \| 查看 \| 原始文档 \| blame \| 历史
	runtime/docs/SDK_advanced_guide_offline_en.md	5 ●●●●● 补丁 \| 查看 \| 原始文档 \| blame \| 历史
	runtime/docs/SDK_advanced_guide_offline_en_zh.md	6 ●●●●● 补丁 \| 查看 \| 原始文档 \| blame \| 历史
	runtime/docs/SDK_advanced_guide_offline_zh.md	7 ●●●●● 补丁 \| 查看 \| 原始文档 \| blame \| 历史
	runtime/docs/SDK_advanced_guide_online.md	9 ●●●●● 补丁 \| 查看 \| 原始文档 \| blame \| 历史
	runtime/docs/SDK_advanced_guide_online_zh.md	10 ●●●●● 补丁 \| 查看 \| 原始文档 \| blame \| 历史
	runtime/docs/images/online_structure.png	补丁 \| 查看 \| 原始文档 \| blame \| 历史

 runtime/docs/SDK_advanced_guide_offline.md

@@ -6,6 +6,15 @@

<img src="images/offline_structure.jpg"  width="900"/>


| TIME       | INFO                                                                                                                             | IMAGE VERSION                | IMAGE ID     |
|------------|----------------------------------------------------------------------------------------------------------------------------------|------------------------------|--------------|
| 2023.11.08 | supporting punc-large model, Ngram model, fst hotwords, server-side loading of hotwords, adaptation to runtime structure changes | funasr-runtime-sdk-cpu-0.3.0 | caa64bddbb43 |
| 2023.09.19 | supporting ITN model                                                                                                             | funasr-runtime-sdk-cpu-0.2.2 | 2c5286be13e9 |
| 2023.08.22 | integrated ffmpeg to support various audio and video inputs, supporting nn-hotword model and timestamp model                     | funasr-runtime-sdk-cpu-0.2.0 | 1ad3d19e0707 |
| 2023.07.03 | 1.0 released                                                                                                                     | funasr-runtime-sdk-cpu-0.1.0 | 1ad3d19e0707 |


## Quick start
### Docker install
If you have already installed Docker, ignore this step!

 runtime/docs/SDK_advanced_guide_offline_en.md

@@ -4,6 +4,11 @@

This document serves as a development guide for the FunASR offline file transcription service. If you wish to quickly experience the offline file transcription service, please refer to the one-click deployment example for the FunASR offline file transcription service ([docs](./SDK_tutorial.md)).

| TIME       | INFO                                    | IMAGE VERSION                   | IMAGE ID     |
|------------|-----------------------------------------|---------------------------------|--------------|
| 2023.11.08 | Adaptation to runtime structure changes | funasr-runtime-sdk-en-cpu-0.1.1 | 27017f70f72a |
| 2023.10.16 | 1.0 released                            | funasr-runtime-sdk-en-cpu-0.1.0 | e0de03eb0163 |

## Quick start
### Docker install
If you have already installed Docker, ignore this step!

 runtime/docs/SDK_advanced_guide_offline_en_zh.md

@@ -4,6 +4,12 @@

本文档为FunASR离线文件转写服务开发指南。如果您想快速体验离线文件转写服务，可参考[快速上手](#快速上手)。

| 时间         | 详情            | 镜像版本                            | 镜像ID         |
|------------|---------------|---------------------------------|--------------|
| 2023.11.08 | runtime结构变化适配 | funasr-runtime-sdk-en-cpu-0.1.1 | 27017f70f72a |
| 2023.10.16 | 1.0 发布        | funasr-runtime-sdk-en-cpu-0.1.0 | e0de03eb0163 |


## 服务器配置

用户可以根据自己的业务需求，选择合适的服务器配置，推荐配置为：

 runtime/docs/SDK_advanced_guide_offline_zh.md

@@ -6,6 +6,13 @@

<img src="images/offline_structure.jpg"  width="900"/>

| 时间         | 详情                                                | 镜像版本                         | 镜像ID         |
|------------|---------------------------------------------------|------------------------------|--------------|
| 2023.11.08 | 支持标点大模型、支持Ngram模型、支持fst热词、支持服务端加载热词、runtime结构变化适配 | funasr-runtime-sdk-cpu-0.3.0 | caa64bddbb43 |
| 2023.09.19 | 支持ITN模型                                           | funasr-runtime-sdk-cpu-0.2.2 | 2c5286be13e9 |
| 2023.08.22 | 集成ffmpeg支持多种音视频输入、支持热词模型、支持时间戳模型                  | funasr-runtime-sdk-cpu-0.2.0 | 1ad3d19e0707 |
| 2023.07.03 | 1.0 发布                                            | funasr-runtime-sdk-cpu-0.1.0 | 1ad3d19e0707 |

## 服务器配置

用户可以根据自己的业务需求，选择合适的服务器配置，推荐配置为：

 runtime/docs/SDK_advanced_guide_online.md

@@ -2,6 +2,15 @@

FunASR provides a real-time speech transcription service that can be easily deployed on local or cloud servers, with the FunASR runtime-SDK as the core. It integrates the speech endpoint detection (VAD), Paraformer-large non-streaming speech recognition (ASR), Paraformer-large streaming speech recognition (ASR), punctuation (PUNC), and other related capabilities open-sourced by the speech laboratory of DAMO Academy on the Modelscope community. The software package can perform real-time speech-to-text transcription, and can also accurately transcribe text at the end of sentences for high-precision output. The output text contains punctuation and supports high-concurrency multi-channel requests.

<img src="images/online_structure.png"  width="900"/>

| TIME       | INFO                                                                                | IMAGE VERSION                       | IMAGE ID     |
|------------|-------------------------------------------------------------------------------------|-------------------------------------|--------------|
| 2023.11.08 | supporting server-side loading of hotwords, adaptation to runtime structure changes | funasr-runtime-sdk-online-cpu-0.1.4 | 691974017c38 |
| 2023.09.19 | supporting hotwords, timestamps, and ITN model in 2pass mode                        | funasr-runtime-sdk-online-cpu-0.1.2 | 7222c5319bcf |
| 2023.08.11 | addressing some known bugs (including server crashes)                               | funasr-runtime-sdk-online-cpu-0.1.1 | bdbdd0b27dee |
| 2023.08.07 | 1.0 released                                                                        | funasr-runtime-sdk-online-cpu-0.1.0 | bdbdd0b27dee |

## Quick Start
### Docker install
If you have already installed Docker, ignore this step!

 runtime/docs/SDK_advanced_guide_online_zh.md

@@ -5,6 +5,16 @@

本文档为FunASR实时转写服务开发指南。如果您想快速体验实时语音听写服务，可参考[快速上手](#快速上手)。

<img src="images/online_structure.png"  width="900"/>

| 时间         | 详情                                | 镜像版本                                | 镜像ID         |
|:-----------|:----------------------------------|-------------------------------------|--------------|
| 2023.11.08 | 支持服务端加载热词(更新热词通信协议)、runtime结构变化适配 | funasr-runtime-sdk-online-cpu-0.1.4 | 691974017c38 |
| 2023.09.19 | 2pass模式支持热词、时间戳、ITN模型             | funasr-runtime-sdk-online-cpu-0.1.2 | 7222c5319bcf |
| 2023.08.11 | 修复了部分已知的bug(包括server崩溃等)          | funasr-runtime-sdk-online-cpu-0.1.1 | bdbdd0b27dee |
| 2023.08.07 | 1.0 发布                            | funasr-runtime-sdk-online-cpu-0.1.0 | bdbdd0b27dee |


## 快速上手

### docker安装

 runtime/docs/images/online_structure.png

			@@ -6,6 +6,15 @@

			<img src="images/offline_structure.jpg" width="900"/>


			\| TIME \| INFO \| IMAGE VERSION \| IMAGE ID \|
			\|------------\|----------------------------------------------------------------------------------------------------------------------------------\|------------------------------\|--------------\|
			\| 2023.11.08 \| supporting punc-large model, Ngram model, fst hotwords, server-side loading of hotwords, adaptation to runtime structure changes \| funasr-runtime-sdk-cpu-0.3.0 \| caa64bddbb43 \|
			\| 2023.09.19 \| supporting ITN model \| funasr-runtime-sdk-cpu-0.2.2 \| 2c5286be13e9 \|
			\| 2023.08.22 \| integrated ffmpeg to support various audio and video inputs, supporting nn-hotword model and timestamp model \| funasr-runtime-sdk-cpu-0.2.0 \| 1ad3d19e0707 \|
			\| 2023.07.03 \| 1.0 released \| funasr-runtime-sdk-cpu-0.1.0 \| 1ad3d19e0707 \|


			## Quick start
			### Docker install
			If you have already installed Docker, ignore this step!

			@@ -4,6 +4,11 @@

			This document serves as a development guide for the FunASR offline file transcription service. If you wish to quickly experience the offline file transcription service, please refer to the one-click deployment example for the FunASR offline file transcription service ([docs](./SDK_tutorial.md)).

			\| TIME \| INFO \| IMAGE VERSION \| IMAGE ID \|
			\|------------\|-----------------------------------------\|---------------------------------\|--------------\|
			\| 2023.11.08 \| Adaptation to runtime structure changes \| funasr-runtime-sdk-en-cpu-0.1.1 \| 27017f70f72a \|
			\| 2023.10.16 \| 1.0 released \| funasr-runtime-sdk-en-cpu-0.1.0 \| e0de03eb0163 \|

			## Quick start
			### Docker install
			If you have already installed Docker, ignore this step!

			@@ -4,6 +4,12 @@

			本文档为FunASR离线文件转写服务开发指南。如果您想快速体验离线文件转写服务，可参考[快速上手](#快速上手)。

			\| 时间 \| 详情 \| 镜像版本 \| 镜像ID \|
			\|------------\|---------------\|---------------------------------\|--------------\|
			\| 2023.11.08 \| runtime结构变化适配 \| funasr-runtime-sdk-en-cpu-0.1.1 \| 27017f70f72a \|
			\| 2023.10.16 \| 1.0 发布 \| funasr-runtime-sdk-en-cpu-0.1.0 \| e0de03eb0163 \|


			## 服务器配置

			用户可以根据自己的业务需求，选择合适的服务器配置，推荐配置为：

			@@ -6,6 +6,13 @@

			<img src="images/offline_structure.jpg" width="900"/>

			\| 时间 \| 详情 \| 镜像版本 \| 镜像ID \|
			\|------------\|---------------------------------------------------\|------------------------------\|--------------\|
			\| 2023.11.08 \| 支持标点大模型、支持Ngram模型、支持fst热词、支持服务端加载热词、runtime结构变化适配 \| funasr-runtime-sdk-cpu-0.3.0 \| caa64bddbb43 \|
			\| 2023.09.19 \| 支持ITN模型 \| funasr-runtime-sdk-cpu-0.2.2 \| 2c5286be13e9 \|
			\| 2023.08.22 \| 集成ffmpeg支持多种音视频输入、支持热词模型、支持时间戳模型 \| funasr-runtime-sdk-cpu-0.2.0 \| 1ad3d19e0707 \|
			\| 2023.07.03 \| 1.0 发布 \| funasr-runtime-sdk-cpu-0.1.0 \| 1ad3d19e0707 \|

			## 服务器配置

			用户可以根据自己的业务需求，选择合适的服务器配置，推荐配置为：

			@@ -2,6 +2,15 @@

			FunASR provides a real-time speech transcription service that can be easily deployed on local or cloud servers, with the FunASR runtime-SDK as the core. It integrates the speech endpoint detection (VAD), Paraformer-large non-streaming speech recognition (ASR), Paraformer-large streaming speech recognition (ASR), punctuation (PUNC), and other related capabilities open-sourced by the speech laboratory of DAMO Academy on the Modelscope community. The software package can perform real-time speech-to-text transcription, and can also accurately transcribe text at the end of sentences for high-precision output. The output text contains punctuation and supports high-concurrency multi-channel requests.

			<img src="images/online_structure.png" width="900"/>

			\| TIME \| INFO \| IMAGE VERSION \| IMAGE ID \|
			\|------------\|-------------------------------------------------------------------------------------\|-------------------------------------\|--------------\|
			\| 2023.11.08 \| supporting server-side loading of hotwords, adaptation to runtime structure changes \| funasr-runtime-sdk-online-cpu-0.1.4 \| 691974017c38 \|
			\| 2023.09.19 \| supporting hotwords, timestamps, and ITN model in 2pass mode \| funasr-runtime-sdk-online-cpu-0.1.2 \| 7222c5319bcf \|
			\| 2023.08.11 \| addressing some known bugs (including server crashes) \| funasr-runtime-sdk-online-cpu-0.1.1 \| bdbdd0b27dee \|
			\| 2023.08.07 \| 1.0 released \| funasr-runtime-sdk-online-cpu-0.1.0 \| bdbdd0b27dee \|

			## Quick Start
			### Docker install
			If you have already installed Docker, ignore this step!

			@@ -5,6 +5,16 @@

			本文档为FunASR实时转写服务开发指南。如果您想快速体验实时语音听写服务，可参考[快速上手](#快速上手)。

			<img src="images/online_structure.png" width="900"/>

			\| 时间 \| 详情 \| 镜像版本 \| 镜像ID \|
			\|:-----------\|:----------------------------------\|-------------------------------------\|--------------\|
			\| 2023.11.08 \| 支持服务端加载热词(更新热词通信协议)、runtime结构变化适配 \| funasr-runtime-sdk-online-cpu-0.1.4 \| 691974017c38 \|
			\| 2023.09.19 \| 2pass模式支持热词、时间戳、ITN模型 \| funasr-runtime-sdk-online-cpu-0.1.2 \| 7222c5319bcf \|
			\| 2023.08.11 \| 修复了部分已知的bug(包括server崩溃等) \| funasr-runtime-sdk-online-cpu-0.1.1 \| bdbdd0b27dee \|
			\| 2023.08.07 \| 1.0 发布 \| funasr-runtime-sdk-online-cpu-0.1.0 \| bdbdd0b27dee \|


			## 快速上手

			### docker安装