readme

游雁

2023-04-15 8dd0c9d36f8b5b6a3b59cc7ebe1da6937fe4d724

readme

 README.md

@@ -30,7 +30,9 @@

Install from pip
```shell
pip install -U funasr -i https://pypi.Python.org/simple
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
@@ -39,6 +41,9 @@
``` 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:

@@ -50,8 +55,10 @@

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


 funasr/export/README.md

@@ -7,7 +7,7 @@

## Install modelscope and funasr

The installation is the same as [funasr](../../README.md)
The installation is the same as [funasr](https://github.com/alibaba-damo-academy/FunASR/blob/main/README.md#installation)

## Export model
   `Tips`: torch>=1.11.0

 funasr/runtime/python/libtorch/README.md

@@ -23,7 +23,10 @@
    
    install from pip
    ```shell
    pip install -U funasr_torch -i https://pypi.Python.org/simple
    pip install -U funasr_torch
    # For the users in China, you could install with the command:
    # pip install -U funasr_torch -i https://mirror.sjtu.edu.cn/pypi/web/simple

    ```
    or install from source code

@@ -31,6 +34,9 @@
    git clone https://github.com/alibaba/FunASR.git && cd FunASR
    cd funasr/runtime/python/libtorch
    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

    ```

3. Run the demo.

 funasr/runtime/python/onnxruntime/README.md

@@ -21,7 +21,10 @@

install from pip
```shell
pip install -U funasr_onnx -i https://pypi.Python.org/simple
pip install -U funasr_onnx
# For the users in China, you could install with the command:
# pip install -U funasr_onnx -i https://mirror.sjtu.edu.cn/pypi/web/simple

```

or install from source code
@@ -30,6 +33,9 @@
git clone https://github.com/alibaba/FunASR.git && cd FunASR
cd funasr/runtime/python/onnxruntime
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

```

3. Run the demo.