Open-source speech recognition toolkit for training, inference, streaming ASR, VAD, punctuation, speaker diarization pipelines, and OpenAI-compatible/MCP serving.
Python asraudiochineseemotion-recognitionfunasrmcp-servermultilingual-asropenai-compatible-apiparaformerpunctuationpytorchreal-time-asrspeaker-diarizationspeech-recognitionspeech-to-textstreaming-asrtranscriptionvllmvoice-activity-detectionwhisper-alternative
docs: localize Colab quickstart guide
zhifu gaofc76d9945bbf
diff --git a/README_zh.md b/README_zh.mdindex 2adb6ba14..d7da9a10d 100644--- a/README_zh.md+++ b/README_zh.md@@ -21,7 +21,7 @@</p><p align="center">- <a href="#快速开始">快速开始</a> · <a href="./examples/colab/">Colab</a> · <a href="#性能评测">性能评测</a> · <a href="./docs/model_selection_zh.md">模型选择</a> · <a href="./docs/migration_from_whisper_zh.md">迁移指南</a> · <a href="./docs/use_case_showcase_zh.md">场景速览</a> · <a href="./docs/deployment_matrix_zh.md">部署选型</a> · <a href="#模型列表">模型列表</a> · <a href="https://modelscope.github.io/FunASR/agent.html">Agent 集成</a> · <a href="https://modelscope.github.io/FunASR/zh/">文档</a> · <a href="./CONTRIBUTING.md">贡献</a>+ <a href="#快速开始">快速开始</a> · <a href="./examples/colab/README_zh.md">Colab</a> · <a href="#性能评测">性能评测</a> · <a href="./docs/model_selection_zh.md">模型选择</a> · <a href="./docs/migration_from_whisper_zh.md">迁移指南</a> · <a href="./docs/use_case_showcase_zh.md">场景速览</a> · <a href="./docs/deployment_matrix_zh.md">部署选型</a> · <a href="#模型列表">模型列表</a> · <a href="https://modelscope.github.io/FunASR/agent.html">Agent 集成</a> · <a href="https://modelscope.github.io/FunASR/zh/">文档</a> · <a href="./CONTRIBUTING.md">贡献</a></p>---@@ -30,7 +30,7 @@[](https://colab.research.google.com/github/modelscope/FunASR/blob/main/examples/colab/funasr_quickstart.ipynb)-不想先配置本地环境?可以打开 [Colab 快速体验](./examples/colab/) 在浏览器里转写公开样例或上传自己的音频。+不想先配置本地环境?可以打开 [Colab 快速体验](./examples/colab/README_zh.md) 在浏览器里转写公开样例或上传自己的音频。```bashpip install funasr@@ -69,7 +69,7 @@ result = model.generate(input="meeting.wav")| 费用 | 免费 | 免费 | ¥0.04/分钟起 || CPU 可用 | ✅ 17 倍实时 | ❌ 太慢 | 不适用 |-第一次试用 FunASR?可以先跑 [Colab 快速体验](./examples/colab/),再配置本地环境。还不确定先用哪个模型?先看 [模型选择指南](./docs/model_selection_zh.md)。计划从 Whisper 或云端 ASR 切换?请按 [迁移指南](./docs/migration_from_whisper_zh.md) 和 [评测示例](./examples/migration/) 用代表性音频评测、映射功能并安全上线。+第一次试用 FunASR?可以先跑 [Colab 快速体验](./examples/colab/README_zh.md),再配置本地环境。还不确定先用哪个模型?先看 [模型选择指南](./docs/model_selection_zh.md)。计划从 Whisper 或云端 ASR 切换?请按 [迁移指南](./docs/migration_from_whisper_zh.md) 和 [评测示例](./examples/migration/) 用代表性音频评测、映射功能并安全上线。---diff --git a/docs/deployment_matrix_zh.md b/docs/deployment_matrix_zh.mdindex 8ea4ac127..83ea655ee 100644--- a/docs/deployment_matrix_zh.md+++ b/docs/deployment_matrix_zh.md@@ -6,7 +6,7 @@| 路径 | 适合场景 | 从这里开始 | 运维提示 ||---|---|---|---|-| Colab Notebook | 浏览器 smoke test、首次评估、可分享 demo | [Colab 快速体验](../examples/colab/) | 不需要本地环境;首次运行会下载模型,GPU runtime 更快。 |+| Colab Notebook | 浏览器 smoke test、首次评估、可分享 demo | [Colab 快速体验](../examples/colab/README_zh.md) | 不需要本地环境;首次运行会下载模型,GPU runtime 更快。 || Python API | Notebook、离线任务、首次模型评测 | [README 快速开始](../README_zh.md#快速开始) | 最简单;调用方自己负责批处理、重试和文件管理。 || OpenAI 兼容 API | 私有语音 API、Agent、Dify/LangChain/AutoGen 风格客户端 | [OpenAI API 示例](../examples/openai_api/README_zh.md) | 已支持 OpenAI audio API 的应用最容易接入。 || Docker Compose API | 可复现本地 smoke test 或小型内部服务 | [OpenAI API Docker 文档](../examples/openai_api/README_zh.md) | 默认 CPU;容器里使用 CUDA 前需要先适配 CUDA-capable 镜像。 |@@ -22,7 +22,7 @@### 我想五分钟内试跑 FunASR-如果只想在浏览器里 smoke test,可以先用 [Colab 快速体验](../examples/colab/);本地工作再使用 README 里的 Python API。它是验证安装、模型下载、设备选择和基础输出格式的最短路径。如果还不确定先用哪个模型,请看 [模型选择指南](./model_selection_zh.md)。+如果只想在浏览器里 smoke test,可以先用 [Colab 快速体验](../examples/colab/README_zh.md);本地工作再使用 README 里的 Python API。它是验证安装、模型下载、设备选择和基础输出格式的最短路径。如果还不确定先用哪个模型,请看 [模型选择指南](./model_selection_zh.md)。### 我想替代云端转写服务diff --git a/docs/tutorial/README_zh.md b/docs/tutorial/README_zh.mdindex 2e882db1b..aa96952c0 100644--- a/docs/tutorial/README_zh.md+++ b/docs/tutorial/README_zh.md@@ -16,7 +16,7 @@ FunASR开源了大量在工业数据上预训练模型,您可以在 [模型许### 快速使用-不想先配置本地环境?可以先跑 [Colab 快速体验](../../examples/colab/),确认模型和输出格式后再切到命令行。+不想先配置本地环境?可以先跑 [Colab 快速体验](../../examples/colab/README_zh.md),确认模型和输出格式后再切到命令行。命令行方式调用:```shelldiff --git a/docs/use_case_showcase_zh.md b/docs/use_case_showcase_zh.mdindex b50f4ca62..3dc1e7553 100644--- a/docs/use_case_showcase_zh.md+++ b/docs/use_case_showcase_zh.md@@ -6,7 +6,7 @@ FunASR 不只是一个离线转写命令。这个页面把常见的评测、部| 目标 | 从这里开始 | 为什么重要 ||---|---|---|-| 在浏览器里试用 FunASR | [Colab 快速体验](../examples/colab/) | 配置本地环境前,先跑公开样例并上传自己的音频。 |+| 在浏览器里试用 FunASR | [Colab 快速体验](../examples/colab/README_zh.md) | 配置本地环境前,先跑公开样例并上传自己的音频。 || 本地转写一个文件 | [README 快速开始](../README_zh.md#快速开始) 和 [模型选择指南](./model_selection_zh.md) | 几分钟内验证安装、模型选择、模型下载和首次推理。 || 对比准确率和速度 | [性能评测报告](https://modelscope.github.io/FunASR/zh/benchmark.html) | 选型前先查看 184 条长音频评测结果。 || 从 Whisper/云端 ASR 迁移 | [迁移指南](./migration_from_whisper_zh.md) | 将现有流水线映射到 FunASR,用代表性音频评测并规划安全上线。 |diff --git a/examples/colab/README.md b/examples/colab/README.mdindex 311394fe0..ebe01559a 100644--- a/examples/colab/README.md+++ b/examples/colab/README.md@@ -1,5 +1,7 @@# FunASR Colab Quickstart+English | [简体中文](README_zh.md)+Run FunASR in a browser without preparing a local Python environment.[](https://colab.research.google.com/github/modelscope/FunASR/blob/main/examples/colab/funasr_quickstart.ipynb)diff --git a/examples/colab/README_zh.md b/examples/colab/README_zh.mdnew file mode 100644index 000000000..ab61c8006--- /dev/null+++ b/examples/colab/README_zh.md@@ -0,0 +1,24 @@+# FunASR Colab 快速体验++[English](README.md) | 简体中文++无需提前配置本地 Python 环境,直接在浏览器里运行 FunASR。++[](https://colab.research.google.com/github/modelscope/FunASR/blob/main/examples/colab/funasr_quickstart.ipynb)++## Notebook 覆盖内容++- 在 Colab 中安装 FunASR 和运行依赖。+- 如果 Colab runtime 有 GPU,自动使用 `cuda:0`;否则使用 CPU。+- 使用 `paraformer-zh`、VAD 和标点模型转写公开样例音频。+- 上传自己的音频文件,并用同一套模型运行转写。+- 保存 transcript JSON,便于分享、对比或提交 issue。++## 使用建议++- 第一次运行会下载模型文件,可能需要几分钟。+- CPU runtime 适合快速 smoke test;长音频建议切换到 GPU runtime。+- 如果要评估生产部署,先跑通 notebook,再阅读 [部署选型表](../../docs/deployment_matrix_zh.md)。+- 如果要测试 OpenAI 兼容 HTTP 服务,请使用 [examples/openai_api](../openai_api/README_zh.md)。++Notebook 源文件:[funasr_quickstart.ipynb](https://github.com/modelscope/FunASR/blob/main/examples/colab/funasr_quickstart.ipynb)。