inference-engine/samples/speech_recognition_offline_demo/speech_sample.hpp

   1 // Copyright (C) 2018-2019 Intel Corporation
   2 // SPDX-License-Identifier: Apache-2.0
   3 //
   4
   5 #pragma once
   6
   7 #include <string>
   8 #include <vector>
   9 #include <gflags/gflags.h>
  10 #include <iostream>
  11
  12
  13 /// @brief message for help argument
  14 static const char help_message[] = "Print a usage message.";
  15
  16 /// @brief message for images argument
  17 static const char input_message[] = "Required. Paths to an .ark files. Example of usage: <file1.ark,file2.ark> or <file.ark>.";
  18 /// @brief message for model argument
  19 static const char model_message[] = "Required. Path to an .xml file with a trained model (required if -rg is missing).";
  20
  21 /// @brief message for plugin argument
  22 static const char plugin_message[] = "Plugin name. For example MKLDNNPlugin. If this parameter is pointed, " \
  23                                      "the sample will look for this plugin only";
  24
  25 /// @brief message for assigning cnn calculation to device
  26 static const char target_device_message[] = "Specify a target device to infer on. CPU, GPU, GNA_AUTO, GNA_HW, GNA_SW, GNA_SW_FP32 "
  27                                             "GNA_SW_EXACT and HETERO with combination of GNA as the primary device and CPU"
  28                                             " as a secondary (e.g. HETERO:GNA,CPU) are supported. The sample will look "
  29                                             "for a suitable plugin for device specified.";
  30
  31 /// @brief message for performance counters
  32 static const char performance_counter_message[] = "Enables per-layer performance report";
  33
  34 /// @brief message for user library argument
  35 static const char custom_cpu_library_message[] = "Required for MKLDNN (CPU)-targeted custom layers." \
  36 "Absolute path to a shared library with the kernels impl.";
  37
  38 /// @brief message for score output argument
  39 static const char output_message[] = "Output file name (default name is scores.ark).";
  40
  41 /// @brief message for reference score file argument
  42 static const char reference_score_message[] = "Read reference score .ark file and compare scores.";
  43
  44 /// @brief message for read GNA model argument
  45 static const char read_gna_model_message[] = "Read GNA model from file using path/filename provided (required if -m is missing).";
  46
  47 /// @brief message for write GNA model argument
  48 static const char write_gna_model_message[] = "Write GNA model to file using path/filename provided.";
  49
  50 /// @brief message for write GNA embedded model argument
  51 static const char write_embedded_model_message[] = "Write GNA embedded model to file using path/filename provided.";
  52
  53 /// @brief message for quantization argument
  54 static const char quantization_message[] = "Input quantization mode:  static (default), dynamic, or user (use with -sf).";
  55
  56 /// @brief message for quantization bits argument
  57 static const char quantization_bits_message[] = "Weight bits for quantization:  8 or 16 (default)";
  58
  59 /// @brief message for scale factor argument
  60 static const char scale_factor_message[] = "Optional user-specified input scale factor for quantization (use with -q user).";
  61
  62 /// @brief message for batch size argument
  63 static const char batch_size_message[] = "Batch size 1-8 (default 1)";
  64
  65 /// @brief message for #threads for CPU inference
  66 static const char infer_num_threads_message[] = "Optional. Number of threads to use for concurrent async" \
  67 " inference requests on the GNA.";
  68
  69 /// @brief message for context window argument
  70 static const char context_window_message_l[] = "Optional. Number of frames for left context windows (default is 0). " \
  71                                                "Works only with context window networks."
  72                                                " If you use the cw_l or cw_r flag, then batch size and nthreads arguments are ignored.";
  73
  74 /// @brief message for right context window argument
  75 static const char context_window_message_r[] = "Optional. Number of frames for right context windows (default is 0). " \
  76                                                "Works only with context window networks."
  77                                                " If you use the cw_r or cw_l flag, then batch size and nthreads arguments are ignored.";
  78
  79 /// @brief message for RH HMM model argument
  80 static const char rh_hmm_model_message[] = "Required. Path to RH .hmm file.";
  81
  82 /// @brief message for RH model argument
  83 static const char rh_labels_message[] = "Required. Path to RH labels file.";
  84
  85 /// @brief message for RH LM: G model argument
  86 static const char rh_g_model_message[] = "Required. Path to RH LM: G .fst model file.";
  87
  88 /// @brief message for RH LM: CL model argument
  89 static const char rh_cl_model_message[] = "Required. Path to RH LM: CL .fst model file.";
  90
  91 /// @brief message for RH acoustic model scale factor argument
  92 static const char rh_am_scale_factor_message[] = "Optional. RH acoustic model scale factor.";
  93
  94 /// @brief message for RH beam width argument
  95 static const char rh_beam_width_message[] = "Optional. RH beam width.";
  96
  97 /// @brief message for RH N-best result argument
  98 static const char rh_nbest_message[] = "Optional. RH N-best results.";
  99
 100 /// @brief message for RH G-cache log size argument
 101 static const char rh_g_cache_log_size_message[] = "Optional. RH G-cache log size.";
 102
 103 /// @brief message for RH trace back log size argument
 104 static const char rh_trace_back_log_size_message[] = "Optional. RH trace back log size.";
 105
 106 /// @brief message for RH minimum number of stable frames to attribute result as final
 107 static const char rh_min_stable_frames_message[] = "Optional. Minimum number of stable frames to attribute result as final.";
 108
 109 /// @brief message for RH token buffer size argument
 110 static const char rh_token_buffer_size_message[] = "Optional. RH token buffer size.";
 111
 112
 113 /// @brief Define flag for showing help message <br>
 114 DEFINE_bool(h, false, help_message);
 115
 116 /// @brief Define parameter for set image file <br>
 117 /// It is a required parameter
 118 DEFINE_string(i, "", input_message);
 119
 120 /// @brief Define parameter for set model file <br>
 121 /// It is a required parameter
 122 DEFINE_string(m, "", model_message);
 123
 124 /// @brief Define parameter for set plugin name <br>
 125 /// It is a required parameter
 126 DEFINE_string(p, "", plugin_message);
 127
 128 /// @brief device the target device to infer on <br>
 129 DEFINE_string(d, "GNA_AUTO", target_device_message);
 130
 131 /// @brief Enable per-layer performance report
 132 DEFINE_bool(pc, false, performance_counter_message);
 133
 134 /// @brief Absolute path to CPU library with user layers <br>
 135 /// It is a optional parameter
 136 DEFINE_string(l, "", custom_cpu_library_message);
 137
 138 /// @brief Write model to file (model.bin)
 139 DEFINE_string(o, "", output_message);
 140
 141 /// @brief Read reference score file
 142 DEFINE_string(r, "", reference_score_message);
 143
 144 /// @brief Read GNA model from file (model.bin)
 145 DEFINE_string(rg, "", read_gna_model_message);
 146
 147 /// @brief Write GNA model to file (model.bin)
 148 DEFINE_string(wg, "", write_gna_model_message);
 149
 150 /// @brief Write GNA embedded model to file (model.bin)
 151 DEFINE_string(we, "", write_embedded_model_message);
 152
 153 /// @brief Input quantization mode (default static)
 154 DEFINE_string(q, "static", quantization_message);
 155
 156 /// @brief Input quantization bits (default 16)
 157 DEFINE_int32(qb, 16, quantization_bits_message);
 158
 159 /// @brief Scale factor for quantization (default 1.0)
 160 DEFINE_double(sf, 1.0, scale_factor_message);
 161
 162 /// @brief Batch size (default 1)
 163 DEFINE_int32(bs, 1, batch_size_message);
 164
 165 /// @brief Number of threads to use for inference on the CPU (also affects Hetero cases)
 166 DEFINE_int32(nthreads, 1, infer_num_threads_message);
 167
 168 /// @brief Right context window size (default 0)
 169 DEFINE_int32(cw_r, 0, context_window_message_r);
 170
 171 /// @brief Left context window size (default 0)
 172 DEFINE_int32(cw_l, 0, context_window_message_l);
 173
 174 /// @brief Define parameter for set RH HMM model file
 175 /// It is a required parameter
 176 DEFINE_string(hmm, "rh.hmm", rh_hmm_model_message);
 177
 178 /// @brief Define parameter for set RH labels file
 179 /// It is a required parameter
 180 DEFINE_string(labels, "labels.bin", rh_labels_message);
 181
 182 /// @brief Define parameter for set RH LM: G model file
 183 /// It is a required parameter
 184 DEFINE_string(g, "g.fst", rh_g_model_message);
 185
 186 /// @brief Define parameter for set RH LM: CL model file
 187 /// It is a required parameter
 188 DEFINE_string(cl, "cl.fst", rh_cl_model_message);
 189
 190 /// @brief RH Acoustic model scale factor (default 1.0)
 191 DEFINE_double(amsf, 1.0, rh_am_scale_factor_message);
 192
 193 /// @brief RH beam width (default 14.0)
 194 DEFINE_double(beam_width, 14.0, rh_beam_width_message);
 195
 196 /// @brief RH N-best (default 1)
 197 DEFINE_int32(nbest, 1, rh_nbest_message);
 198
 199 /// @brief RH G cache log size (default 19)
 200 DEFINE_int32(gcls, 19, rh_g_cache_log_size_message);
 201
 202 /// @brief RH trace back log size (default 19)
 203 DEFINE_int32(tbls, 19, rh_trace_back_log_size_message);
 204
 205 /// @brief RH minimum stable frames (default -1)
 206 DEFINE_int32(msf, -1, rh_min_stable_frames_message);
 207
 208 /// @brief RH token buffer size (default 150000)
 209 DEFINE_int32(tbs, 150000, rh_token_buffer_size_message);
 210
 211
 212 /**
 213  * @brief This function show a help message
 214  */
 215 static void showUsage() {
 216     std::cout << std::endl;
 217     std::cout << "speech_recognition_offline_demo [OPTION]" << std::endl;
 218     std::cout << "Options:" << std::endl;
 219     std::cout << std::endl;
 220     std::cout << "    -h                        " << help_message << std::endl;
 221     std::cout << "    -i \"<path>\"             " << input_message << std::endl;
 222     std::cout << "    -m \"<path>\"             " << model_message << std::endl;
 223     std::cout << "    -o \"<path>\"             " << output_message << std::endl;
 224     std::cout << "    -l \"<absolute_path>\"    " << custom_cpu_library_message << std::endl;
 225     std::cout << "    -d \"<device>\"           " << target_device_message << std::endl;
 226     std::cout << "    -p                        " << plugin_message << std::endl;
 227     std::cout << "    -pc                       " << performance_counter_message << std::endl;
 228     std::cout << "    -q \"<mode>\"             " << quantization_message << std::endl;
 229     std::cout << "    -qb \"<integer>\"         " << quantization_bits_message << std::endl;
 230     std::cout << "    -sf \"<double>\"          " << scale_factor_message << std::endl;
 231     std::cout << "    -bs \"<integer>\"         " << batch_size_message << std::endl;
 232     std::cout << "    -r \"<path>\"             " << reference_score_message << std::endl;
 233     std::cout << "    -rg \"<path>\"            " << read_gna_model_message << std::endl;
 234     std::cout << "    -wg \"<path>\"            " << write_gna_model_message << std::endl;
 235     std::cout << "    -we \"<path>\"            " << write_embedded_model_message << std::endl;
 236     std::cout << "    -nthreads \"<integer>\"   " << infer_num_threads_message << std::endl;
 237     std::cout << "    -cw_l \"<integer>\"         " << context_window_message_l << std::endl;
 238     std::cout << "    -cw_r \"<integer>\"         " << context_window_message_r << std::endl;
 239     std::cout << "    -hmm \"<path>\"           " << rh_hmm_model_message << std::endl;
 240     std::cout << "    -labels \"<path>\"        " << rh_labels_message << std::endl;
 241     std::cout << "    -g \"<path>\"             " << rh_g_model_message << std::endl;
 242     std::cout << "    -cl \"<path>\"            " << rh_cl_model_message << std::endl;
 243     std::cout << "    -amsf \"<double>\"        " << rh_am_scale_factor_message << std::endl;
 244     std::cout << "    -beam_width \"<double>\"  " << rh_beam_width_message << std::endl;
 245     std::cout << "    -nbest \"<integer>\"      " << rh_nbest_message << std::endl;
 246     std::cout << "    -gcls \"<integer>\"       " << rh_g_cache_log_size_message << std::endl;
 247     std::cout << "    -tbls \"<integer>\"       " << rh_trace_back_log_size_message << std::endl;
 248     std::cout << "    -msf \"<integer>\"        " << rh_min_stable_frames_message << std::endl;
 249     std::cout << "    -tbs \"<integer>\"        " << rh_token_buffer_size_message << std::endl;
 250 }
 251