mirrors/icefall
1
0
Fork 0
mirror of https://github.com/k2-fsa/icefall.git synced 2025-08-09 10:02:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix typos

Browse Source
This commit is contained in:
Fangjun Kuang 2021-08-10 20:20:30 +08:00
parent dec6ecf4da
commit b7133f30bd
2 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -7,7 +7,6 @@
* [Install icefall](#install-icefall) * [Install icefall](#install-icefall)
- [Run recipes](#run-recipes) - [Run recipes](#run-recipes)
## Installation ## Installation
`icefall` depends on [k2][k2] for FSA operations and [lhotse][lhotse] for `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 cd k2
mkdir build_release mkdir build_release
cd build_release cd build_release
cmake -DCMAKE_BUILD_TYPE=Release cmake -DCMAKE_BUILD_TYPE=Release ..
make -j _k2 make -j _k2
export PYTHONPATH=$HOME/open-source/k2/k2/python:$PYTHONPATH export PYTHONPATH=$HOME/open-source/k2/k2/python:$PYTHONPATH
export PYTHONPATH=$HOME/open-source/k2/build_release/lib:$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 To check that k2 is installed successfully, please run
``` ```bash
python3 -m k2.version 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 `icefall` is a set of Python scripts. What you need to do is just to set
the environment variable `PYTHONPATH`: the environment variable `PYTHONPATH`:
``` ```bash
cd $HOME/open-source cd $HOME/open-source
git clone https://github.com/k2-fsa/icefall git clone https://github.com/k2-fsa/icefall
cd icefall cd icefall
@ -67,17 +66,16 @@ export PYTHONPATH=$HOME/open-source/icefall:$PYTHONPATHON
To verify `icefall` was installed successfully, you can run: To verify `icefall` was installed successfully, you can run:
``` ```bash
python3 -c "import icefall; print(icefall.__file__)" python3 -c "import icefall; print(icefall.__file__)"
``` ```
It should print the path to `icefall`. It should print the path to `icefall`.
## Run recipes ## Run recipes
Currently only the LibriSpeech recipe is provided. Please At present, only LibriSpeech recipe is provided. Please
follow the [egs/librispeech/ASR/README.md][LibriSpeech] to run it. follow [egs/librispeech/ASR/README.md][LibriSpeech] to run it.
[LibriSpeech]: egs/librispeech/ASR/README.md [LibriSpeech]: egs/librispeech/ASR/README.md
[k2-install]: https://k2.readthedocs.io/en/latest/installation/index.html# [k2-install]: https://k2.readthedocs.io/en/latest/installation/index.html#

6
egs/librispeech/ASR/README.md
View File

@ -1,7 +1,7 @@
## Data preparation ## 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 you can just run
``` ```
@ -17,7 +17,7 @@ please run
./prepare.sh ./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`. All generated files are saved in the folder `./data`.
HINT: `./prepare.sh` support options `--stage` and `--stop-stage`. 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` `get_params()` within `tdnn_lstm_ctc/train.py`
and `tdnn_lstm_ctc/decode.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 ./tdnn_lstm_ctc/train.py --help