From 937e507977cc9e49ce323f8b2933087d0fe52698 Mon Sep 17 00:00:00 2001 From: zhifu gao <zhifu.gzf@alibaba-inc.com> Date: 星期日, 16 四月 2023 22:29:32 +0800 Subject: [PATCH] Merge pull request #363 from alibaba-damo-academy/main --- README.md | 37 +++++++++++++++++++++++++++++-------- 1 files changed, 29 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 23f1abe..af38341 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,11 @@ [**News**](https://github.com/alibaba-damo-academy/FunASR#whats-new) | [**Highlights**](#highlights) | [**Installation**](#installation) -| [**Docs_CN**](https://alibaba-damo-academy.github.io/FunASR/cn/index.html) | [**Docs_EN**](https://alibaba-damo-academy.github.io/FunASR/en/index.html) | [**Tutorial**](https://github.com/alibaba-damo-academy/FunASR/wiki#funasr%E7%94%A8%E6%88%B7%E6%89%8B%E5%86%8C) | [**Papers**](https://github.com/alibaba-damo-academy/FunASR#citations) | [**Runtime**](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/runtime) -| [**Model Zoo**](https://www.modelscope.cn/models/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch/summary) +| [**Model Zoo**](https://github.com/alibaba-damo-academy/FunASR/blob/main/docs/modelscope_models.md) | [**Contact**](#contact) @@ -29,15 +28,37 @@ ## Installation -``` sh -pip install "modelscope[audio_asr]" --upgrade -f https://modelscope.oss-cn-beijing.aliyuncs.com/releases/repo.html -git clone https://github.com/alibaba/FunASR.git && cd FunASR -pip install --editable ./ +Install from pip +```shell +pip install -U funasr +# For the users in China, you could install with the command: +# pip install -U funasr -i https://mirror.sjtu.edu.cn/pypi/web/simple ``` + +Or install from source code + + +``` sh +git clone https://github.com/alibaba/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 + +``` +If you want to use the pretrained models in ModelScope, you should install the modelscope: + +```shell +pip install -U modelscope +# For the users in China, you could install with the command: +# pip install -U modelscope -f https://modelscope.oss-cn-beijing.aliyuncs.com/releases/repo.html -i https://mirror.sjtu.edu.cn/pypi/web/simple +``` + For more details, please ref to [installation](https://github.com/alibaba-damo-academy/FunASR/wiki) -## Usage -For users who are new to FunASR and ModelScope, please refer to FunASR Docs([CN](https://alibaba-damo-academy.github.io/FunASR/cn/index.html) / [EN](https://alibaba-damo-academy.github.io/FunASR/en/index.html)) +[//]: # () +[//]: # (## Usage) + +[//]: # (For users who are new to FunASR and ModelScope, please refer to FunASR Docs([CN](https://alibaba-damo-academy.github.io/FunASR/cn/index.html) / [EN](https://alibaba-damo-academy.github.io/FunASR/en/index.html))) ## Contact -- Gitblit v1.9.1