[egs] Fixed some issues in the multilingual BABEL example scripts (#1850)
[processor-sdk/kaldi.git] / egs / wsj / s5 / steps / nnet3 / decode.sh
1 #!/bin/bash
3 # Copyright 2012-2015  Johns Hopkins University (Author: Daniel Povey).
4 # Apache 2.0.
6 # This script does decoding with a neural-net.  If the neural net was built on
7 # top of fMLLR transforms from a conventional system, you should provide the
8 # --transform-dir option.
10 # Begin configuration section.
11 stage=1
12 transform_dir=    # dir to find fMLLR transforms.
13 nj=4 # number of decoding jobs.  If --transform-dir set, must match that number!
14 acwt=0.1  # Just a default value, used for adaptation and beam-pruning..
15 post_decode_acwt=1.0  # can be used in 'chain' systems to scale acoustics by 10 so the
16                       # regular scoring script works.
17 cmd=run.pl
18 beam=15.0
19 frames_per_chunk=50
20 max_active=7000
21 min_active=200
22 ivector_scale=1.0
23 lattice_beam=8.0 # Beam we use in lattice generation.
24 iter=final
25 num_threads=1 # if >1, will use gmm-latgen-faster-parallel
26 scoring_opts=
27 skip_diagnostics=false
28 skip_scoring=false
29 extra_left_context=0
30 extra_right_context=0
31 extra_left_context_initial=-1
32 extra_right_context_final=-1
33 online_ivector_dir=
34 minimize=false
35 # End configuration section.
37 echo "$0 $@"  # Print the command line for logging
39 [ -f ./path.sh ] && . ./path.sh; # source the path.
40 . parse_options.sh || exit 1;
42 if [ $# -ne 3 ]; then
43   echo "Usage: $0 [options] <graph-dir> <data-dir> <decode-dir>"
44   echo "e.g.:   steps/nnet3/decode.sh --nj 8 \\"
45   echo "--online-ivector-dir exp/nnet2_online/ivectors_test_eval92 \\"
46   echo "    exp/tri4b/graph_bg data/test_eval92_hires $dir/decode_bg_eval92"
47   echo "main options (for others, see top of script file)"
48   echo "  --transform-dir <decoding-dir>           # directory of previous decoding"
49   echo "                                           # where we can find transforms for SAT systems."
50   echo "  --config <config-file>                   # config containing options"
51   echo "  --nj <nj>                                # number of parallel jobs"
52   echo "  --cmd <cmd>                              # Command to run in parallel with"
53   echo "  --beam <beam>                            # Decoding beam; default 15.0"
54   echo "  --iter <iter>                            # Iteration of model to decode; default is final."
55   echo "  --scoring-opts <string>                  # options to local/score.sh"
56   echo "  --num-threads <n>                        # number of threads to use, default 1."
57   exit 1;
58 fi
60 graphdir=$1
61 data=$2
62 dir=$3
63 srcdir=`dirname $dir`; # Assume model directory one level up from decoding directory.
64 model=$srcdir/$iter.mdl
67 extra_files=
68 if [ ! -z "$online_ivector_dir" ]; then
69   steps/nnet2/check_ivectors_compatible.sh $srcdir $online_ivector_dir || exit 1
70   extra_files="$online_ivector_dir/ivector_online.scp $online_ivector_dir/ivector_period"
71 fi
73 for f in $graphdir/HCLG.fst $data/feats.scp $model $extra_files; do
74   [ ! -f $f ] && echo "$0: no such file $f" && exit 1;
75 done
77 sdata=$data/split$nj;
78 cmvn_opts=`cat $srcdir/cmvn_opts` || exit 1;
79 thread_string=
80 [ $num_threads -gt 1 ] && thread_string="-parallel --num-threads=$num_threads"
82 mkdir -p $dir/log
83 [[ -d $sdata && $data/feats.scp -ot $sdata ]] || split_data.sh $data $nj || exit 1;
84 echo $nj > $dir/num_jobs
87 ## Set up features.
88 echo "$0: feature type is raw"
90 feats="ark,s,cs:apply-cmvn $cmvn_opts --utt2spk=ark:$sdata/JOB/utt2spk scp:$sdata/JOB/cmvn.scp scp:$sdata/JOB/feats.scp ark:- |"
91 if [ ! -z "$transform_dir" ]; then
92   echo "$0: using transforms from $transform_dir"
93   [ ! -s $transform_dir/num_jobs ] && \
94     echo "$0: expected $transform_dir/num_jobs to contain the number of jobs." && exit 1;
95   nj_orig=$(cat $transform_dir/num_jobs)
97   if [ ! -f $transform_dir/raw_trans.1 ]; then
98     echo "$0: expected $transform_dir/raw_trans.1 to exist (--transform-dir option)"
99     exit 1;
100   fi
101   if [ $nj -ne $nj_orig ]; then
102     # Copy the transforms into an archive with an index.
103     for n in $(seq $nj_orig); do cat $transform_dir/raw_trans.$n; done | \
104        copy-feats ark:- ark,scp:$dir/raw_trans.ark,$dir/raw_trans.scp || exit 1;
105     feats="$feats transform-feats --utt2spk=ark:$sdata/JOB/utt2spk scp:$dir/raw_trans.scp ark:- ark:- |"
106   else
107     # number of jobs matches with alignment dir.
108     feats="$feats transform-feats --utt2spk=ark:$sdata/JOB/utt2spk ark:$transform_dir/raw_trans.JOB ark:- ark:- |"
109   fi
110 elif grep 'transform-feats --utt2spk' $srcdir/log/train.1.log >&/dev/null; then
111   echo "$0: **WARNING**: you seem to be using a neural net system trained with transforms,"
112   echo "  but you are not providing the --transform-dir option in test time."
113 fi
114 ##
116 if [ ! -z "$online_ivector_dir" ]; then
117   ivector_period=$(cat $online_ivector_dir/ivector_period) || exit 1;
118   ivector_opts="--online-ivectors=scp:$online_ivector_dir/ivector_online.scp --online-ivector-period=$ivector_period"
119 fi
121 if [ "$post_decode_acwt" == 1.0 ]; then
122   lat_wspecifier="ark:|gzip -c >$dir/lat.JOB.gz"
123 else
124   lat_wspecifier="ark:|lattice-scale --acoustic-scale=$post_decode_acwt ark:- ark:- | gzip -c >$dir/lat.JOB.gz"
125 fi
127 frame_subsampling_opt=
128 if [ -f $srcdir/frame_subsampling_factor ]; then
129   # e.g. for 'chain' systems
130   frame_subsampling_opt="--frame-subsampling-factor=$(cat $srcdir/frame_subsampling_factor)"
131 fi
133 if [ $stage -le 1 ]; then
134   $cmd --num-threads $num_threads JOB=1:$nj $dir/log/decode.JOB.log \
135     nnet3-latgen-faster$thread_string $ivector_opts $frame_subsampling_opt \
136      --frames-per-chunk=$frames_per_chunk \
137      --extra-left-context=$extra_left_context \
138      --extra-right-context=$extra_right_context \
139      --extra-left-context-initial=$extra_left_context_initial \
140      --extra-right-context-final=$extra_right_context_final \
141      --minimize=$minimize --max-active=$max_active --min-active=$min_active --beam=$beam \
142      --lattice-beam=$lattice_beam --acoustic-scale=$acwt --allow-partial=true \
143      --word-symbol-table=$graphdir/words.txt "$model" \
144      $graphdir/HCLG.fst "$feats" "$lat_wspecifier" || exit 1;
145 fi
148 if [ $stage -le 2 ]; then
149   if ! $skip_diagnostics ; then
150     [ ! -z $iter ] && iter_opt="--iter $iter"
151     steps/diagnostic/analyze_lats.sh --cmd "$cmd" $iter_opt $graphdir $dir
152   fi
153 fi
156 # The output of this script is the files "lat.*.gz"-- we'll rescore this at
157 # different acoustic scales to get the final output.
158 if [ $stage -le 3 ]; then
159   if ! $skip_scoring ; then
160     [ ! -x local/score.sh ] && \
161       echo "Not scoring because local/score.sh does not exist or not executable." && exit 1;
162     echo "score best paths"
163     [ "$iter" != "final" ] && iter_opt="--iter $iter"
164     local/score.sh $iter_opt $scoring_opts --cmd "$cmd" $data $graphdir $dir
165     echo "score confidence and timing with sclite"
166   fi
167 fi
168 echo "Decoding done."
169 exit 0;