diff --git a/benchmarks/benchmark_pipeline_cer.md b/benchmarks/benchmark_pipeline_cer.md index 33d85715c..98aa6d726 100644 --- a/benchmarks/benchmark_pipeline_cer.md +++ b/benchmarks/benchmark_pipeline_cer.md @@ -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 diff --git a/docs/installation/installation.md b/docs/installation/installation.md index 293608185..c1196e975 100755 --- a/docs/installation/installation.md +++ b/docs/installation/installation.md @@ -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 diff --git a/docs/installation/installation_zh.md b/docs/installation/installation_zh.md index afbf15150..53616fd00 100755 --- a/docs/installation/installation_zh.md +++ b/docs/installation/installation_zh.md @@ -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 diff --git a/model_zoo/modelscope_models.md b/model_zoo/modelscope_models.md index b973eed21..7a06c2999 100644 --- a/model_zoo/modelscope_models.md +++ b/model_zoo/modelscope_models.md @@ -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). diff --git a/model_zoo/readme.md b/model_zoo/readme.md index 320a2e27e..8feab2cf0 100644 --- a/model_zoo/readme.md +++ b/model_zoo/readme.md @@ -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). diff --git a/runtime/docs/SDK_advanced_guide_offline.md b/runtime/docs/SDK_advanced_guide_offline.md index 157731c5b..07e28b9fa 100644 --- a/runtime/docs/SDK_advanced_guide_offline.md +++ b/runtime/docs/SDK_advanced_guide_offline.md @@ -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: diff --git a/runtime/docs/SDK_advanced_guide_offline_en.md b/runtime/docs/SDK_advanced_guide_offline_en.md index fdbe03e5b..48890ea0b 100644 --- a/runtime/docs/SDK_advanced_guide_offline_en.md +++ b/runtime/docs/SDK_advanced_guide_offline_en.md @@ -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: diff --git a/runtime/docs/SDK_advanced_guide_offline_en_zh.md b/runtime/docs/SDK_advanced_guide_offline_en_zh.md index 35504d918..ed715863c 100644 --- a/runtime/docs/SDK_advanced_guide_offline_en_zh.md +++ b/runtime/docs/SDK_advanced_guide_offline_en_zh.md @@ -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镜像: diff --git a/runtime/docs/SDK_advanced_guide_offline_gpu.md b/runtime/docs/SDK_advanced_guide_offline_gpu.md index be3b728eb..3b4ed24be 100644 --- a/runtime/docs/SDK_advanced_guide_offline_gpu.md +++ b/runtime/docs/SDK_advanced_guide_offline_gpu.md @@ -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: diff --git a/runtime/docs/SDK_advanced_guide_offline_gpu_zh.md b/runtime/docs/SDK_advanced_guide_offline_gpu_zh.md index 2c8d2547e..fad79027b 100644 --- a/runtime/docs/SDK_advanced_guide_offline_gpu_zh.md +++ b/runtime/docs/SDK_advanced_guide_offline_gpu_zh.md @@ -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) ### 镜像启动 diff --git a/runtime/docs/SDK_advanced_guide_offline_zh.md b/runtime/docs/SDK_advanced_guide_offline_zh.md index 297d234cf..5956679c7 100644 --- a/runtime/docs/SDK_advanced_guide_offline_zh.md +++ b/runtime/docs/SDK_advanced_guide_offline_zh.md @@ -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) ### 镜像启动 diff --git a/runtime/docs/SDK_advanced_guide_online.md b/runtime/docs/SDK_advanced_guide_online.md index 8dc0f4813..28b0b3aae 100644 --- a/runtime/docs/SDK_advanced_guide_online.md +++ b/runtime/docs/SDK_advanced_guide_online.md @@ -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: diff --git a/runtime/docs/SDK_advanced_guide_online_zh.md b/runtime/docs/SDK_advanced_guide_online_zh.md index 41bc00fe5..c16a63f6a 100644 --- a/runtime/docs/SDK_advanced_guide_online_zh.md +++ b/runtime/docs/SDK_advanced_guide_online_zh.md @@ -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镜像: diff --git a/runtime/python/grpc/Readme.md b/runtime/python/grpc/Readme.md index 1389f76dd..54bb4dde1 100644 --- a/runtime/python/grpc/Readme.md +++ b/runtime/python/grpc/Readme.md @@ -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 ``` diff --git a/runtime/python/libtorch/README.md b/runtime/python/libtorch/README.md index e658b666e..382269a49 100644 --- a/runtime/python/libtorch/README.md +++ b/runtime/python/libtorch/README.md @@ -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: diff --git a/runtime/python/onnxruntime/README.md b/runtime/python/onnxruntime/README.md index e8bdd70f8..269262204 100644 --- a/runtime/python/onnxruntime/README.md +++ b/runtime/python/onnxruntime/README.md @@ -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: diff --git a/runtime/python/websocket/README.md b/runtime/python/websocket/README.md index 8483d5aab..2c130466c 100644 --- a/runtime/python/websocket/README.md +++ b/runtime/python/websocket/README.md @@ -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 ``` diff --git a/tests/test_docs_funasr_install_commands.py b/tests/test_docs_funasr_install_commands.py index 7a4f7bbda..b133c4447 100644 --- a/tests/test_docs_funasr_install_commands.py +++ b/tests/test_docs_funasr_install_commands.py @@ -13,6 +13,26 @@ "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