[doc] add install guide (#8)

This commit is contained in:
Binbin Zhang 2021-11-19 12:24:47 +08:00 committed by GitHub
parent 3dde87bdcd
commit 2072abeb70
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 0 deletions

View File

@ -16,6 +16,23 @@ We are going to support the following typical applications of wakeup word:
* Customizable wake-up word
* Personalized wake-up word, i.e. combination of wake-up word detection and voiceprint
## Installation
- Clone the repo
``` sh
git clone https://github.com/wenet-e2e/wenet.git
```
- Install Conda: please see https://docs.conda.io/en/latest/miniconda.html
- Create Conda env:
``` sh
conda create -n wenet python=3.8
conda activate wenet
pip install -r requirements.txt
conda install pytorch=1.10.0 torchaudio=0.10.0 cudatoolkit=11.1 -c pytorch -c conda-forge
```
## Dataset
We plan to support a variaty of open source wake-up word datasets, include but not limited to:

4
requirements.txt Normal file
View File

@ -0,0 +1,4 @@
flake8==3.8.2
pyyaml>=5.1
tensorboard
tensorboardX