chore: import upstream snapshot with attribution
This commit is contained in:
@@ -0,0 +1,72 @@
|
||||
([简体中文](./docker_zh.md)|English)
|
||||
|
||||
# Docker
|
||||
|
||||
## Install Docker
|
||||
|
||||
### Ubuntu
|
||||
```shell
|
||||
curl -fsSL https://test.docker.com -o test-docker.sh
|
||||
sudo sh test-docker.sh
|
||||
```
|
||||
### Debian
|
||||
```shell
|
||||
curl -fsSL https://get.docker.com -o get-docker.sh
|
||||
sudo sh get-docker.sh
|
||||
```
|
||||
|
||||
### CentOS
|
||||
```shell
|
||||
curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun
|
||||
```
|
||||
|
||||
### MacOS
|
||||
```shell
|
||||
brew install --cask --appdir=/Applications docker
|
||||
```
|
||||
|
||||
### Windows
|
||||
Ref to [docs](https://docs.docker.com/desktop/install/windows-install/)
|
||||
|
||||
## Start Docker
|
||||
```shell
|
||||
sudo systemctl start docker
|
||||
```
|
||||
## Download image
|
||||
|
||||
### Image Hub
|
||||
|
||||
#### CPU
|
||||
`registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.1`
|
||||
|
||||
#### GPU
|
||||
|
||||
`registry.cn-hangzhou.aliyuncs.com/modelscope-repo/modelscope:ubuntu20.04-py38-torch1.11.0-tf1.15.5-1.8.1`
|
||||
|
||||
### Pull Image
|
||||
```shell
|
||||
sudo docker pull <image-name>:<tag>
|
||||
```
|
||||
|
||||
### Check Image
|
||||
```shell
|
||||
sudo docker images
|
||||
```
|
||||
|
||||
## Run Docker
|
||||
```shell
|
||||
# cpu
|
||||
sudo docker run -itd --name funasr -v <local_dir:dir_in_docker> <image-name>:<tag> /bin/bash
|
||||
# gpu
|
||||
sudo docker run -itd --gpus all --name funasr -v <local_dir:dir_in_docker> <image-name>:<tag> /bin/bash
|
||||
|
||||
sudo docker exec -it funasr /bin/bash
|
||||
```
|
||||
|
||||
## Stop Docker
|
||||
```shell
|
||||
exit
|
||||
sudo docker ps
|
||||
sudo docker stop funasr
|
||||
```
|
||||
|
||||
@@ -0,0 +1,72 @@
|
||||
(简体中文|[English](./docker.md))
|
||||
|
||||
# Docker
|
||||
|
||||
## 安装Docker
|
||||
|
||||
### Ubuntu
|
||||
```shell
|
||||
curl -fsSL https://test.docker.com -o test-docker.sh
|
||||
sudo sh test-docker.sh
|
||||
```
|
||||
### Debian
|
||||
```shell
|
||||
curl -fsSL https://get.docker.com -o get-docker.sh
|
||||
sudo sh get-docker.sh
|
||||
```
|
||||
|
||||
### CentOS
|
||||
```shell
|
||||
curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun
|
||||
```
|
||||
|
||||
### MacOS
|
||||
```shell
|
||||
brew install --cask --appdir=/Applications docker
|
||||
```
|
||||
|
||||
### Windows
|
||||
请参考[文档](https://docs.docker.com/desktop/install/windows-install/)
|
||||
|
||||
## 启动Docker
|
||||
```shell
|
||||
sudo systemctl start docker
|
||||
```
|
||||
## 下载Docker镜像
|
||||
|
||||
### 镜像仓库
|
||||
|
||||
#### CPU
|
||||
`registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.4.1`
|
||||
|
||||
#### GPU
|
||||
|
||||
`registry.cn-hangzhou.aliyuncs.com/modelscope-repo/modelscope:ubuntu20.04-py38-torch1.11.0-tf1.15.5-1.8.1`
|
||||
|
||||
### 拉取镜像
|
||||
```shell
|
||||
sudo docker pull <image-name>:<tag>
|
||||
```
|
||||
|
||||
### 查看镜像
|
||||
```shell
|
||||
sudo docker images
|
||||
```
|
||||
|
||||
## 运行Docker
|
||||
```shell
|
||||
# cpu
|
||||
sudo docker run -itd --name funasr -v <local_dir:dir_in_docker> <image-name>:<tag> /bin/bash
|
||||
# gpu
|
||||
sudo docker run -itd --gpus all --name funasr -v <local_dir:dir_in_docker> <image-name>:<tag> /bin/bash
|
||||
|
||||
sudo docker exec -it funasr /bin/bash
|
||||
```
|
||||
|
||||
## 停止Docker
|
||||
```shell
|
||||
exit
|
||||
sudo docker ps
|
||||
sudo docker stop funasr
|
||||
```
|
||||
|
||||
Executable
+74
@@ -0,0 +1,74 @@
|
||||
([简体中文](./installation_zh.md)|English)
|
||||
|
||||
<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.8,<=3.13-aff.svg"></a>
|
||||
<a href=""><img src="https://img.shields.io/badge/Pytorch-%3E%3D1.11-blue"></a>
|
||||
</p>
|
||||
|
||||
## 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
|
||||
source ~/.bashrc
|
||||
conda create -n funasr python=3.8
|
||||
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.11.0):
|
||||
|
||||
```sh
|
||||
pip3 install torch torchaudio
|
||||
```
|
||||
If there exists CUDAs in your environments, you should install the pytorch with the version matching the CUDA. The matching list could be found in [docs](https://pytorch.org/get-started/previous-versions/).
|
||||
### Install funasr
|
||||
|
||||
#### Install from pip
|
||||
|
||||
```shell
|
||||
pip3 install -U funasr
|
||||
# For the users in China, you could install with the command:
|
||||
# pip3 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
|
||||
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
|
||||
```
|
||||
|
||||
### Install modelscope (Optional)
|
||||
If you want to use the pretrained models in ModelScope, you should install the modelscope:
|
||||
|
||||
```shell
|
||||
pip3 install -U modelscope
|
||||
# For the users in China, you could install with the command:
|
||||
# pip3 install -U modelscope -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
|
||||
```
|
||||
Executable
+75
@@ -0,0 +1,75 @@
|
||||
(简体中文|[English](./installation.md))
|
||||
|
||||
<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.8,<=3.13-aff.svg"></a>
|
||||
<a href=""><img src="https://img.shields.io/badge/Pytorch-%3E%3D1.11-blue"></a>
|
||||
</p>
|
||||
|
||||
## 安装
|
||||
|
||||
### 安装Conda(可选):
|
||||
|
||||
#### Linux
|
||||
```sh
|
||||
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
|
||||
sh Miniconda3-latest-Linux-x86_64.sh
|
||||
source ~/.bashrc
|
||||
conda create -n funasr python=3.8
|
||||
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)
|
||||
|
||||
### 安装Pytorch(版本 >= 1.11.0):
|
||||
|
||||
```sh
|
||||
pip3 install torch torchaudio
|
||||
```
|
||||
如果您的环境中存在CUDAs,则应安装与CUDA匹配版本的pytorch,匹配列表可在文档中找到([文档](https://pytorch.org/get-started/previous-versions/))。
|
||||
### 安装funasr
|
||||
|
||||
#### 从pip安装
|
||||
|
||||
```shell
|
||||
pip3 install -U funasr
|
||||
# 对于中国大陆用户,可以使用以下命令进行安装:
|
||||
# pip3 install -U funasr -i https://mirror.sjtu.edu.cn/pypi/web/simple
|
||||
```
|
||||
|
||||
#### 或者从源代码安装
|
||||
|
||||
``` sh
|
||||
git clone https://github.com/alibaba/FunASR.git && cd FunASR
|
||||
pip3 install -e ./
|
||||
# 对于中国大陆用户,可以使用以下命令进行安装:
|
||||
# pip3 install -e ./ -i https://mirror.sjtu.edu.cn/pypi/web/simple
|
||||
```
|
||||
|
||||
### 安装modelscope(可选)
|
||||
|
||||
如果您想要使用ModelScope中的预训练模型,则应安装modelscope:
|
||||
|
||||
```shell
|
||||
pip3 install -U modelscope
|
||||
# 对于中国大陆用户,可以使用以下命令进行安装:
|
||||
# pip3 install -U modelscope -i https://mirror.sjtu.edu.cn/pypi/web/simple
|
||||
```
|
||||
|
||||
### 常见问题解答
|
||||
- 在MAC M1芯片上安装时,可能会出现以下错误:
|
||||
- - _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
|
||||
```
|
||||
Reference in New Issue
Block a user