modelscope/FunASR
1
0
Fork 0
mirror of https://github.com/modelscope/FunASR.git synced 2026-10-12 02:19:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: refresh stale public FunASR links

Browse Source 
Replace stale public docs and clone hosts with current FunASR URLs, with regression coverage.
This commit is contained in:
zhifu gao
2026-07-22 22:23:19 +08:00
committed by GitHub
parent 2509e13ed5
commit 53e397d2fa
18 changed files with 47 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
benchmarks/benchmark_pipeline_cer.md
+3 -3
View File
@@ -11,7 +11,7 @@
### Tools
#### [Install Requirements](https://alibaba-damo-academy.github.io/FunASR/en/installation/installation.html#installation)
#### [Install Requirements](https://modelscope.github.io/FunASR/installation.html#installation)
Install ModelScope and FunASR from pip
```shell
@@ -22,7 +22,7 @@ pip install -U modelscope funasr
Or install FunASR from source code
```shell
git clone https://github.com/alibaba/FunASR.git && cd FunASR
git clone https://github.com/modelscope/FunASR.git && cd FunASR
pip install -e ./
# For the users in China, you could install with the command:
# pip install -e ./ -i https://mirror.sjtu.edu.cn/pypi/web/simple
@@ -32,7 +32,7 @@ pip install -e ./
#### Recipe
##### [Test CER](https://alibaba-damo-academy.github.io/FunASR/en/modelscope_pipeline/asr_pipeline.html#inference-with-multi-thread-cpus-or-multi-gpus)
##### [Test CER](https://modelscope.github.io/FunASR/tutorial.html)
set the `model`, `data_dir` and `output_dir` in `infer.sh`.
```shell
cd egs_modelscope/asr/TEMPLATE
docs/installation/installation.md
+1 -1
View File
@@ -50,7 +50,7 @@ pip3 install -U funasr
#### Or install from source code
``` sh
git clone https://github.com/alibaba/FunASR.git && cd FunASR
git clone https://github.com/modelscope/FunASR.git && cd FunASR
pip3 install -e ./
# For the users in China, you could install with the command:
# pip3 install -e ./ -i https://mirror.sjtu.edu.cn/pypi/web/simple
docs/installation/installation_zh.md
+1 -1
View File
@@ -50,7 +50,7 @@ pip3 install -U funasr
#### 或者从源代码安装
``` sh
git clone https://github.com/alibaba/FunASR.git && cd FunASR
git clone https://github.com/modelscope/FunASR.git && cd FunASR
pip3 install -e ./
# 对于中国大陆用户，可以使用以下命令进行安装：
# pip3 install -e ./ -i https://mirror.sjtu.edu.cn/pypi/web/simple
model_zoo/modelscope_models.md
+1 -1
View File
@@ -6,7 +6,7 @@
You are free to use, copy, modify, and share FunASR models under the conditions of this agreement. You should indicate the model source and author information when using, copying, modifying and sharing FunASR models. You should keep the relevant names of models in [FunASR software].. Full model license could see [license](https://github.com/modelscope/FunASR/blob/main/MODEL_LICENSE)
## Model Usage
Ref to [docs](https://alibaba-damo-academy.github.io/FunASR/en/modelscope_pipeline/quick_start.html)
Ref to [docs](https://modelscope.github.io/FunASR/tutorial.html)
## Model Zoo
Here we provided several pretrained models on different datasets. The details of models and datasets can be found on [ModelScope](https://www.modelscope.cn/models?page=1&tasks=auto-speech-recognition).
model_zoo/readme.md
+1 -1
View File
@@ -6,7 +6,7 @@
You are free to use, copy, modify, and share FunASR models under the conditions of this agreement. You should indicate the model source and author information when using, copying, modifying and sharing FunASR models. You should keep the relevant names of models in [FunASR software]. Full model license could see [license](https://github.com/modelscope/FunASR/blob/main/MODEL_LICENSE)
## Model Usage
Ref to [docs](https://alibaba-damo-academy.github.io/FunASR/en/modelscope_pipeline/quick_start.html)
Ref to [docs](https://modelscope.github.io/FunASR/tutorial.html)
## Model Zoo
Here we provided several pretrained models on different datasets. The details of models and datasets can be found on [ModelScope](https://www.modelscope.cn/models?page=1&tasks=auto-speech-recognition).
runtime/docs/SDK_advanced_guide_offline.md
+1 -1
View File
@@ -31,7 +31,7 @@ If you have already installed Docker, ignore this step!
curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/install_docker.sh;
sudo bash install_docker.sh
```
If you do not have Docker installed, please refer to [Docker Installation](https://alibaba-damo-academy.github.io/FunASR/en/installation/docker.html)
If you do not have Docker installed, please refer to [Docker Installation](https://modelscope.github.io/FunASR/installation.html#docker)
### Pulling and launching images
Use the following command to pull and launch the Docker image for the FunASR runtime-SDK:
runtime/docs/SDK_advanced_guide_offline_en.md
+1 -1
View File
@@ -21,7 +21,7 @@ If you have already installed Docker, ignore this step!
curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/install_docker.sh;
sudo bash install_docker.sh
```
If you do not have Docker installed, please refer to [Docker Installation](https://alibaba-damo-academy.github.io/FunASR/en/installation/docker.html)
If you do not have Docker installed, please refer to [Docker Installation](https://modelscope.github.io/FunASR/installation.html#docker)
### Pulling and launching images
Use the following command to pull and launch the Docker image for the FunASR runtime-SDK:
runtime/docs/SDK_advanced_guide_offline_en_zh.md
+1 -1
View File
@@ -35,7 +35,7 @@ FunASR提供可一键本地或者云端服务器部署的英文离线文件转
curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/install_docker.sh；
sudo bash install_docker.sh
```
docker安装失败请参考 [Docker Installation](https://alibaba-damo-academy.github.io/FunASR/en/installation/docker.html)
docker安装失败请参考 [Docker Installation](https://modelscope.github.io/FunASR/installation.html#docker)
### 镜像启动
通过下述命令拉取并启动FunASR runtime-SDK的docker镜像：
runtime/docs/SDK_advanced_guide_offline_gpu.md
+1 -1
View File
@@ -24,7 +24,7 @@ If you have already installed Docker, ignore this step!
curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/install_docker.sh;
sudo bash install_docker.sh
```
If you do not have Docker installed, please refer to [Docker Installation](https://alibaba-damo-academy.github.io/FunASR/en/installation/docker.html)
If you do not have Docker installed, please refer to [Docker Installation](https://modelscope.github.io/FunASR/installation.html#docker)
### Pulling and launching images
Use the following command to pull and launch the Docker image for the FunASR runtime-SDK:
runtime/docs/SDK_advanced_guide_offline_gpu_zh.md
+1 -1
View File
@@ -33,7 +33,7 @@ FunASR离线文件转写GPU软件包，提供了一款功能强大的语音离
curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/install_docker.sh；
sudo bash install_docker.sh
```
docker安装失败请参考 [Docker Installation](https://alibaba-damo-academy.github.io/FunASR/en/installation/docker.html)
docker安装失败请参考 [Docker Installation](https://modelscope.github.io/FunASR/installation.html#docker)
### 镜像启动
runtime/docs/SDK_advanced_guide_offline_zh.md
+1 -1
View File
@@ -42,7 +42,7 @@ FunASR离线文件转写软件包，提供了一款功能强大的语音离线
curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/install_docker.sh；
sudo bash install_docker.sh
```
docker安装失败请参考 [Docker Installation](https://alibaba-damo-academy.github.io/FunASR/en/installation/docker.html)
docker安装失败请参考 [Docker Installation](https://modelscope.github.io/FunASR/installation.html#docker)
### 镜像启动
runtime/docs/SDK_advanced_guide_online.md
+1 -1
View File
@@ -27,7 +27,7 @@ If you have already installed Docker, ignore this step!
curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/install_docker.sh;
sudo bash install_docker.sh
```
If you do not have Docker installed, please refer to [Docker Installation](https://alibaba-damo-academy.github.io/FunASR/en/installation/docker.html)
If you do not have Docker installed, please refer to [Docker Installation](https://modelscope.github.io/FunASR/installation.html#docker)
### Pull Docker Image
Use the following command to pull and start the FunASR software package docker image:
runtime/docs/SDK_advanced_guide_online_zh.md
+1 -1
View File
@@ -34,7 +34,7 @@ FunASR实时语音听写软件包，集成了实时版本的语音端点检测
curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/install_docker.sh
sudo bash install_docker.sh
```
docker安装失败请参考 [Docker Installation](https://alibaba-damo-academy.github.io/FunASR/en/installation/docker.html)
docker安装失败请参考 [Docker Installation](https://modelscope.github.io/FunASR/installation.html#docker)
### 镜像启动
通过下述命令拉取并启动FunASR软件包的docker镜像：
runtime/python/grpc/Readme.md
+1 -1
View File
@@ -5,7 +5,7 @@ In the demo client, audio_chunk_duration is set to 1000ms, and send_interval is
### 1. Install the requirements
```shell
git clone https://github.com/alibaba/FunASR.git && cd FunASR/funasr/runtime/python/grpc
git clone https://github.com/modelscope/FunASR.git && cd FunASR/funasr/runtime/python/grpc
pip install -r requirements.txt
```
runtime/python/libtorch/README.md
+1 -1
View File
@@ -32,7 +32,7 @@ pip install -U funasr_torch
or install from source code
```shell
git clone https://github.com/alibaba/FunASR.git && cd FunASR
git clone https://github.com/modelscope/FunASR.git && cd FunASR
cd funasr/runtime/python/libtorch
pip install -e ./
# For the users in China, you could install with the command:
runtime/python/onnxruntime/README.md
+1 -1
View File
@@ -17,7 +17,7 @@ pip install -U modelscope funasr
or install from source code
```shell
git clone https://github.com/alibaba/FunASR.git
git clone https://github.com/modelscope/FunASR.git
cd FunASR/runtime/python/onnxruntime
pip install -e ./
# For the users in China, you could install with the command:
runtime/python/websocket/README.md
+2 -2
View File
@@ -10,7 +10,7 @@ This is a demo using funasr pipeline with websocket python-api. It supports the
pip install -U modelscope funasr
# For the users in China, you could install with the command:
# pip install -U modelscope funasr -i https://mirror.sjtu.edu.cn/pypi/web/simple
git clone https://github.com/alibaba/FunASR.git && cd FunASR
git clone https://github.com/modelscope/FunASR.git && cd FunASR
```
### Install the requirements for server
@@ -43,7 +43,7 @@ python funasr_wss_server.py --port 10095
Install the requirements for client
```shell
git clone https://github.com/alibaba/FunASR.git && cd FunASR
git clone https://github.com/modelscope/FunASR.git && cd FunASR
cd funasr/runtime/python/websocket
pip install -r requirements_client.txt
```
tests/test_docs_funasr_install_commands.py
+27
View File
@@ -13,6 +13,26 @@ DOCS_WITH_CURRENT_FUNASR_INSTALL = [
"examples/industrial_data_pretraining/fun_asr_nano/docs/finetune_zh.md",
]
PUBLIC_DOCS_SHOULD_USE_CURRENT_HOSTS = [
"benchmarks/benchmark_pipeline_cer.md",
"docs/installation/installation.md",
"docs/installation/installation_zh.md",
"model_zoo/modelscope_models.md",
"model_zoo/readme.md",
"runtime/docs/SDK_advanced_guide_offline.md",
"runtime/docs/SDK_advanced_guide_offline_en.md",
"runtime/docs/SDK_advanced_guide_offline_en_zh.md",
"runtime/docs/SDK_advanced_guide_offline_gpu.md",
"runtime/docs/SDK_advanced_guide_offline_gpu_zh.md",
"runtime/docs/SDK_advanced_guide_offline_zh.md",
"runtime/docs/SDK_advanced_guide_online.md",
"runtime/docs/SDK_advanced_guide_online_zh.md",
"runtime/python/grpc/Readme.md",
"runtime/python/libtorch/README.md",
"runtime/python/onnxruntime/README.md",
"runtime/python/websocket/README.md",
]
def test_current_funasr_install_commands_are_quoted():
for relpath in DOCS_WITH_CURRENT_FUNASR_INSTALL:
@@ -28,6 +48,13 @@ def test_fun_asr_nano_finetune_zh_uses_canonical_filename():
assert "fintune_zh.md" not in (docs_dir / "finetune.md").read_text()
def test_public_docs_use_current_repository_and_docs_hosts():
for relpath in PUBLIC_DOCS_SHOULD_USE_CURRENT_HOSTS:
text = (ROOT / relpath).read_text()
assert "github.com/alibaba/FunASR" not in text
assert "alibaba-damo-academy.github.io/FunASR" not in text
def test_realtime_demo_documents_partial_and_hotword_boundaries():
text = (
ROOT