Skip to content

Commit

Permalink
Fix docs for MVQ (#1272)
Browse files Browse the repository at this point in the history
* typo fix
  • Loading branch information
marcoyang1998 authored Sep 25, 2023
1 parent 97f9b9c commit e17f884
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The data preparation contains several stages, you can use the following two
options:

- ``--stage``
- ``--stop-stage``
- ``--stop_stage``

to control which stage(s) should be run. By default, all stages are executed.

Expand All @@ -56,8 +56,8 @@ For example,
.. code-block:: bash
$ cd egs/librispeech/ASR
$ ./prepare.sh --stage 0 --stop-stage 0 # run only stage 0
$ ./prepare.sh --stage 2 --stop-stage 5 # run from stage 2 to stage 5
$ ./prepare.sh --stage 0 --stop_stage 0 # run only stage 0
$ ./prepare.sh --stage 2 --stop_stage 5 # run from stage 2 to stage 5
.. HINT::

Expand Down Expand Up @@ -108,15 +108,15 @@ As usual, you can control the stages you want to run by specifying the following
two options:

- ``--stage``
- ``--stop-stage``
- ``--stop_stage``

For example,

.. code-block:: bash
$ cd egs/librispeech/ASR
$ ./distillation_with_hubert.sh --stage 0 --stop-stage 0 # run only stage 0
$ ./distillation_with_hubert.sh --stage 2 --stop-stage 4 # run from stage 2 to stage 5
$ ./distillation_with_hubert.sh --stage 0 --stop_stage 0 # run only stage 0
$ ./distillation_with_hubert.sh --stage 2 --stop_stage 4 # run from stage 2 to stage 5
Here are a few options in `./distillation_with_hubert.sh <https://github.com/k2-fsa/icefall/blob/master/egs/librispeech/ASR/distillation_with_hubert.sh>`_
you need to know before you proceed.
Expand All @@ -134,7 +134,7 @@ and prepares MVQ-augmented training manifests.

.. code-block:: bash
$ ./distillation_with_hubert.sh --stage 2 --stop-stage 2 # run only stage 2
$ ./distillation_with_hubert.sh --stage 2 --stop_stage 2 # run only stage 2
Please see the
following screenshot for the output of an example execution.
Expand Down Expand Up @@ -172,7 +172,7 @@ To perform training, please run stage 3 by executing the following command.

.. code-block:: bash
$ ./prepare.sh --stage 3 --stop-stage 3 # run MVQ training
$ ./prepare.sh --stage 3 --stop_stage 3 # run MVQ training
Here is the code snippet for training:

Expand Down
2 changes: 2 additions & 0 deletions egs/librispeech/ASR/distillation_with_hubert.sh
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ use_extracted_codebook=True
# "hubert_xtralarge_ll60k" -> pretrained model without fintuing
teacher_model_id=hubert_xtralarge_ll60k_finetune_ls960

. shared/parse_options.sh || exit 1

log() {
# This function is from espnet
local fname=${BASH_SOURCE[1]##*/}
Expand Down

0 comments on commit e17f884

Please sign in to comment.