Fix docs for MVQ (#1272)

* typo fix
This commit is contained in:
marcoyang1998 2023-09-25 15:36:40 +08:00 committed by GitHub
parent 97f9b9c33b
commit e17f884ace
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 8 deletions

View File

@ -47,7 +47,7 @@ The data preparation contains several stages, you can use the following two
options: options:
- ``--stage`` - ``--stage``
- ``--stop-stage`` - ``--stop_stage``
to control which stage(s) should be run. By default, all stages are executed. to control which stage(s) should be run. By default, all stages are executed.
@ -56,8 +56,8 @@ For example,
.. code-block:: bash .. code-block:: bash
$ cd egs/librispeech/ASR $ cd egs/librispeech/ASR
$ ./prepare.sh --stage 0 --stop-stage 0 # run only stage 0 $ ./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 2 --stop_stage 5 # run from stage 2 to stage 5
.. HINT:: .. HINT::
@ -108,15 +108,15 @@ As usual, you can control the stages you want to run by specifying the following
two options: two options:
- ``--stage`` - ``--stage``
- ``--stop-stage`` - ``--stop_stage``
For example, For example,
.. code-block:: bash .. code-block:: bash
$ cd egs/librispeech/ASR $ cd egs/librispeech/ASR
$ ./distillation_with_hubert.sh --stage 0 --stop-stage 0 # run only stage 0 $ ./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 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>`_ 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. you need to know before you proceed.
@ -134,7 +134,7 @@ and prepares MVQ-augmented training manifests.
.. code-block:: bash .. 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 Please see the
following screenshot for the output of an example execution. following screenshot for the output of an example execution.
@ -172,7 +172,7 @@ To perform training, please run stage 3 by executing the following command.
.. code-block:: bash .. 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: Here is the code snippet for training:

View File

@ -56,6 +56,8 @@ use_extracted_codebook=True
# "hubert_xtralarge_ll60k" -> pretrained model without fintuing # "hubert_xtralarge_ll60k" -> pretrained model without fintuing
teacher_model_id=hubert_xtralarge_ll60k_finetune_ls960 teacher_model_id=hubert_xtralarge_ll60k_finetune_ls960
. shared/parse_options.sh || exit 1
log() { log() {
# This function is from espnet # This function is from espnet
local fname=${BASH_SOURCE[1]##*/} local fname=${BASH_SOURCE[1]##*/}