diff --git a/README.md b/README.md index 15ca86b..ebf8988 100644 --- a/README.md +++ b/README.md @@ -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: diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..b010971 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +flake8==3.8.2 +pyyaml>=5.1 +tensorboard +tensorboardX