From b7133f30bdfeb7a286fa66e4468d467a9bbb78ef Mon Sep 17 00:00:00 2001 From: Fangjun Kuang Date: Tue, 10 Aug 2021 20:20:30 +0800 Subject: [PATCH] fix typos --- README.md | 14 ++++++-------- egs/librispeech/ASR/README.md | 6 +++--- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 04d40ed78..2453a60eb 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,6 @@ * [Install icefall](#install-icefall) - [Run recipes](#run-recipes) - ## Installation `icefall` depends on [k2][k2] for FSA operations and [lhotse][lhotse] for @@ -32,7 +31,7 @@ git clone https://github.com/k2-fsa/k2.git cd k2 mkdir build_release cd build_release -cmake -DCMAKE_BUILD_TYPE=Release +cmake -DCMAKE_BUILD_TYPE=Release .. make -j _k2 export PYTHONPATH=$HOME/open-source/k2/k2/python:$PYTHONPATH export PYTHONPATH=$HOME/open-source/k2/build_release/lib:$PYTHONPATH @@ -40,7 +39,7 @@ export PYTHONPATH=$HOME/open-source/k2/build_release/lib:$PYTHONPATH To check that k2 is installed successfully, please run -``` +```bash python3 -m k2.version ``` @@ -57,7 +56,7 @@ lhotse. `icefall` is a set of Python scripts. What you need to do is just to set the environment variable `PYTHONPATH`: -``` +```bash cd $HOME/open-source git clone https://github.com/k2-fsa/icefall cd icefall @@ -67,17 +66,16 @@ export PYTHONPATH=$HOME/open-source/icefall:$PYTHONPATHON To verify `icefall` was installed successfully, you can run: -``` +```bash python3 -c "import icefall; print(icefall.__file__)" ``` It should print the path to `icefall`. - ## Run recipes -Currently only the LibriSpeech recipe is provided. Please -follow the [egs/librispeech/ASR/README.md][LibriSpeech] to run it. +At present, only LibriSpeech recipe is provided. Please +follow [egs/librispeech/ASR/README.md][LibriSpeech] to run it. [LibriSpeech]: egs/librispeech/ASR/README.md [k2-install]: https://k2.readthedocs.io/en/latest/installation/index.html# diff --git a/egs/librispeech/ASR/README.md b/egs/librispeech/ASR/README.md index 6637a2fd5..3d3a3b267 100644 --- a/egs/librispeech/ASR/README.md +++ b/egs/librispeech/ASR/README.md @@ -1,7 +1,7 @@ ## Data preparation -If you want to `./prepare.sh` to download everything for you, +If you want to use `./prepare.sh` to download everything for you, you can just run ``` @@ -17,7 +17,7 @@ please run ./prepare.sh ``` -The script `./prepare.sh` prepare features, lexicon, LMs, etc. +The script `./prepare.sh` prepares features, lexicon, LMs, etc. All generated files are saved in the folder `./data`. HINT: `./prepare.sh` support options `--stage` and `--stop-stage`. @@ -31,7 +31,7 @@ Pre-configured parameters for training and decoding are set in the function `get_params()` within `tdnn_lstm_ctc/train.py` and `tdnn_lstm_ctc/decode.py`. -Parameters that can be passed from commandlin can be found by +Parameters that can be passed from the commandline can be found by ``` ./tdnn_lstm_ctc/train.py --help