| | |
| | | # Installation |
| | | FunASR is easy to install. The detailed installation steps are as follows: |
| | | <p align="left"> |
| | | <a href=""><img src="https://img.shields.io/badge/OS-Linux%2C%20Win%2C%20Mac-brightgreen.svg"></a> |
| | | <a href=""><img src="https://img.shields.io/badge/Python->=3.7,<=3.10-aff.svg"></a> |
| | | <a href=""><img src="https://img.shields.io/badge/Pytorch-%3E%3D1.11-blue"></a> |
| | | </p> |
| | | |
| | | - Install Conda and create virtual environment: |
| | | ## Installation |
| | | |
| | | ### Install Conda (Optional): |
| | | |
| | | #### Linux |
| | | ```sh |
| | | wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh |
| | | sh Miniconda3-latest-Linux-x86_64.sh |
| | |
| | | conda create -n funasr python=3.7 |
| | | conda activate funasr |
| | | ``` |
| | | #### Mac |
| | | ```sh |
| | | wget https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh |
| | | # For M1 chip |
| | | # wget https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.sh |
| | | sh Miniconda3-latest-MacOSX* |
| | | source ~/.zashrc |
| | | conda create -n funasr python=3.8 |
| | | conda activate funasr |
| | | ``` |
| | | #### Windows |
| | | Ref to [docs](https://docs.conda.io/en/latest/miniconda.html#windows-installers) |
| | | |
| | | - Install Pytorch (version >= 1.7.0): |
| | | ### Install Pytorch (version >= 1.11.0): |
| | | |
| | | ```sh |
| | | pip install torch torchaudio |
| | | ``` |
| | | |
| | | For more versions, please see [https://pytorch.org/get-started/locally](https://pytorch.org/get-started/locally) |
| | | For more details about torch, please see [https://pytorch.org/get-started/locally](https://pytorch.org/get-started/locally) |
| | | |
| | | - Install ModelScope |
| | | ### Install funasr |
| | | |
| | | For users in China, you can configure the following mirror source to speed up the downloading: |
| | | ``` sh |
| | | pip config set global.index-url https://mirror.sjtu.edu.cn/pypi/web/simple |
| | | ``` |
| | | Install or update ModelScope |
| | | ```sh |
| | | pip install "modelscope[audio_asr]" --upgrade -f https://modelscope.oss-cn-beijing.aliyuncs.com/releases/repo.html |
| | | #### 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 |
| | | ``` |
| | | |
| | | - Clone the repo and install other packages |
| | | #### Or install from source code |
| | | |
| | | ``` sh |
| | | git clone https://github.com/alibaba/FunASR.git && cd FunASR |
| | | pip install --editable ./ |
| | | ``` |
| | | 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 |
| | | ``` |
| | | |
| | | ### Install modelscope (Optional) |
| | | 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 |
| | | ``` |
| | | |
| | | ### FQA |
| | | - For installation on MAC M1 chip, the following error may happen: |
| | | - - _cffi_backend.cpython-38-darwin.so' (mach-o file, but is an incompatible architecture (have (x86_64), need (arm64e))) |
| | | ```shell |
| | | pip uninstall cffi pycparser |
| | | ARCHFLAGS="-arch arm64" pip install cffi pycparser --compile --no-cache-dir |
| | | ``` |