fix doc of install

pull/975/head
Hui Zhang 3 years ago
parent dd075b07bc
commit 67cb3004a3

@ -109,7 +109,7 @@ If you are from China, we strongly recommend you join our PaddleSpeech WeChat gr
The base environment in this page is The base environment in this page is
- Ubuntu 16.04 - Ubuntu 16.04
- python>=3.7 - python>=3.7
- paddlepaddle==2.1.2 - paddlepaddle>=2.2.0-rc
If you want to set up PaddleSpeech in other environment, please see the [installation](./docs/source/install.md) documents for all the alternatives. If you want to set up PaddleSpeech in other environment, please see the [installation](./docs/source/install.md) documents for all the alternatives.
@ -347,3 +347,4 @@ howpublished = {\url{https://github.com/PaddlePaddle/DeepSpeech}},
year={2021} year={2021}
} }
``` ```

@ -6,51 +6,21 @@ To avoid the trouble of environment setup, [running in Docker container](#runnin
- Python >= 3.7 - Python >= 3.7
- PaddlePaddle latest version (please refer to the [Installation Guide](https://www.paddlepaddle.org.cn/documentation/docs/en/beginners_guide/index_en.html)) - PaddlePaddle latest version (please refer to the [Installation Guide](https://www.paddlepaddle.org.cn/documentation/docs/en/beginners_guide/index_en.html))
## Setup (Important) ## Simple Setup
- Make sure these libraries or tools installed: `pkg-config`, `flac`, `ogg`, `vorbis`, `boost`, `sox`, and `swig`, e.g. installing them via `apt-get`:
```bash
sudo apt-get install -y sox pkg-config libflac-dev libogg-dev libvorbis-dev libboost-dev swig python3-dev
```
The version of `swig` should >= 3.0
or, installing them via `yum`:
```bash
sudo yum install pkgconfig libogg-devel libvorbis-devel boost-devel python3-devel
wget https://ftp.osuosl.org/pub/xiph/releases/flac/flac-1.3.1.tar.xz
xz -d flac-1.3.1.tar.xz
tar -xvf flac-1.3.1.tar
cd flac-1.3.1
./configure
make
make install
```
- Run the setup script for the remaining dependencies For user who working on `Ubuntu` with `root` privilege.
```bash ```python
git clone https://github.com/PaddlePaddle/DeepSpeech.git git clone https://github.com/PaddlePaddle/DeepSpeech.git
cd DeepSpeech cd DeepSpeech
pushd tools; make virtualenv.done:; popd
source tools/venv/bin/activate
pip install -e . pip install -e .
``` ```
- Source venv before do experiment. ## Setup (Other Platform)
```bash - Make sure these libraries or tools in [dependencies](./dependencies.md) installed. More information please see: `setup.py `and ` tools/Makefile`.
source tools/venv/bin/activate - The version of `swig` should >= 3.0
``` - we will do more to simplify the install process.
## Simple Setup
```python
git clone https://github.com/PaddlePaddle/DeepSpeech.git
cd DeepSpeech
pip install -e .
```
## Running in Docker Container (optional) ## Running in Docker Container (optional)

@ -20,9 +20,9 @@ PaddleSpeech ASR provides you with a complete ASR pipeline, including:
- fbank (also support kaldi feature) - fbank (also support kaldi feature)
- mfcc - mfcc
- Acoustic Models - Acoustic Models
- Deepspeech2 (online and offline) - Deepspeech2 (Streaming and Non-Streaming)
- Transformer (online and offline) - Transformer (Streaming and Non-Streaming)
- Conformer (online and offline) - Conformer (Streaming and Non-Streaming)
- Decoder - Decoder
- ctc greedy search (used in DeepSpeech2, Transformer and Conformer) - ctc greedy search (used in DeepSpeech2, Transformer and Conformer)
- ctc beam search (used in DeepSpeech2, Transformer and Conformer) - ctc beam search (used in DeepSpeech2, Transformer and Conformer)

Loading…
Cancel
Save