Skip to content

Commit 773ee24

Browse files
JohannesGaesslerJohannesGaessler
authored
CLI args use - instead of _, backwards compatible (#1416)
1 parent 553fd4d commit 773ee24

File tree

1 file changed

+30
-26
lines changed

1 file changed

+30
-26
lines changed

‎examples/common.cpp‎

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,13 @@ bool gpt_params_parse(int argc, char ** argv, gpt_params & params) {
9191
bool escape_prompt = false;
9292
std::string arg;
9393
gpt_params default_params;
94+
const std::string arg_prefix = "--";
9495

9596
for (int i = 1; i < argc; i++) {
9697
arg = argv[i];
98+
if (arg.compare(0, arg_prefix.size(), arg_prefix) == 0) {
99+
std::replace(arg.begin(), arg.end(), '_', '-');
100+
}
97101

98102
if (arg == "-s" || arg == "--seed") {
99103
#if defined(GGML_USE_CUBLAS)
@@ -141,27 +145,27 @@ bool gpt_params_parse(int argc, char ** argv, gpt_params & params) {
141145
if (params.prompt.back() == '\n') {
142146
params.prompt.pop_back();
143147
}
144-
} else if (arg == "-n" || arg == "--n_predict") {
148+
} else if (arg == "-n" || arg == "--n-predict") {
145149
if (++i >= argc) {
146150
invalid_param = true;
147151
break;
148152
}
149153
params.n_predict = std::stoi(argv[i]);
150-
} else if (arg == "--top_k") {
154+
} else if (arg == "--top-k") {
151155
if (++i >= argc) {
152156
invalid_param = true;
153157
break;
154158
}
155159
params.top_k = std::stoi(argv[i]);
156-
} else if (arg == "-c" || arg == "--ctx_size") {
160+
} else if (arg == "-c" || arg == "--ctx-size") {
157161
if (++i >= argc) {
158162
invalid_param = true;
159163
break;
160164
}
161165
params.n_ctx = std::stoi(argv[i]);
162-
} else if (arg == "--memory_f32") {
166+
} else if (arg == "--memory-f32") {
163167
params.memory_f16 = false;
164-
} else if (arg == "--top_p") {
168+
} else if (arg == "--top-p") {
165169
if (++i >= argc) {
166170
invalid_param = true;
167171
break;
@@ -185,25 +189,25 @@ bool gpt_params_parse(int argc, char ** argv, gpt_params & params) {
185189
break;
186190
}
187191
params.typical_p = std::stof(argv[i]);
188-
} else if (arg == "--repeat_last_n") {
192+
} else if (arg == "--repeat-last-n") {
189193
if (++i >= argc) {
190194
invalid_param = true;
191195
break;
192196
}
193197
params.repeat_last_n = std::stoi(argv[i]);
194-
} else if (arg == "--repeat_penalty") {
198+
} else if (arg == "--repeat-penalty") {
195199
if (++i >= argc) {
196200
invalid_param = true;
197201
break;
198202
}
199203
params.repeat_penalty = std::stof(argv[i]);
200-
} else if (arg == "--frequency_penalty") {
204+
} else if (arg == "--frequency-penalty") {
201205
if (++i >= argc) {
202206
invalid_param = true;
203207
break;
204208
}
205209
params.frequency_penalty = std::stof(argv[i]);
206-
} else if (arg == "--presence_penalty") {
210+
} else if (arg == "--presence-penalty") {
207211
if (++i >= argc) {
208212
invalid_param = true;
209213
break;
@@ -215,19 +219,19 @@ bool gpt_params_parse(int argc, char ** argv, gpt_params & params) {
215219
break;
216220
}
217221
params.mirostat = std::stoi(argv[i]);
218-
} else if (arg == "--mirostat_lr") {
222+
} else if (arg == "--mirostat-lr") {
219223
if (++i >= argc) {
220224
invalid_param = true;
221225
break;
222226
}
223227
params.mirostat_eta = std::stof(argv[i]);
224-
} else if (arg == "--mirostat_ent") {
228+
} else if (arg == "--mirostat-ent") {
225229
if (++i >= argc) {
226230
invalid_param = true;
227231
break;
228232
}
229233
params.mirostat_tau = std::stof(argv[i]);
230-
} else if (arg == "-b" || arg == "--batch_size") {
234+
} else if (arg == "-b" || arg == "--batch-size") {
231235
if (++i >= argc) {
232236
invalid_param = true;
233237
break;
@@ -310,7 +314,7 @@ bool gpt_params_parse(int argc, char ** argv, gpt_params & params) {
310314
invalid_param = true;
311315
break;
312316
}
313-
} else if (arg == "--n_parts") {
317+
} else if (arg == "--n-parts") {
314318
if (++i >= argc) {
315319
invalid_param = true;
316320
break;
@@ -384,31 +388,31 @@ void gpt_print_usage(int /*argc*/, char ** argv, const gpt_params & params) {
384388
fprintf(stderr, " --in-suffix STRING string to suffix after user inputs with (default: empty)\n");
385389
fprintf(stderr, " -f FNAME, --file FNAME\n");
386390
fprintf(stderr, " prompt file to start generation.\n");
387-
fprintf(stderr, " -n N, --n_predict N number of tokens to predict (default: %d, -1 = infinity)\n", params.n_predict);
388-
fprintf(stderr, " --top_k N top-k sampling (default: %d, 0 = disabled)\n", params.top_k);
389-
fprintf(stderr, " --top_p N top-p sampling (default: %.1f, 1.0 = disabled)\n", (double)params.top_p);
391+
fprintf(stderr, " -n N, --n-predict N number of tokens to predict (default: %d, -1 = infinity)\n", params.n_predict);
392+
fprintf(stderr, " --top-k N top-k sampling (default: %d, 0 = disabled)\n", params.top_k);
393+
fprintf(stderr, " --top-p N top-p sampling (default: %.1f, 1.0 = disabled)\n", (double)params.top_p);
390394
fprintf(stderr, " --tfs N tail free sampling, parameter z (default: %.1f, 1.0 = disabled)\n", (double)params.tfs_z);
391395
fprintf(stderr, " --typical N locally typical sampling, parameter p (default: %.1f, 1.0 = disabled)\n", (double)params.typical_p);
392-
fprintf(stderr, " --repeat_last_n N last n tokens to consider for penalize (default: %d, 0 = disabled, -1 = ctx_size)\n", params.repeat_last_n);
393-
fprintf(stderr, " --repeat_penalty N penalize repeat sequence of tokens (default: %.1f, 1.0 = disabled)\n", (double)params.repeat_penalty);
394-
fprintf(stderr, " --presence_penalty N repeat alpha presence penalty (default: %.1f, 0.0 = disabled)\n", (double)params.presence_penalty);
395-
fprintf(stderr, " --frequency_penalty N repeat alpha frequency penalty (default: %.1f, 0.0 = disabled)\n", (double)params.frequency_penalty);
396+
fprintf(stderr, " --repeat-last-n N last n tokens to consider for penalize (default: %d, 0 = disabled, -1 = ctx_size)\n", params.repeat_last_n);
397+
fprintf(stderr, " --repeat-penalty N penalize repeat sequence of tokens (default: %.1f, 1.0 = disabled)\n", (double)params.repeat_penalty);
398+
fprintf(stderr, " --presence-penalty N repeat alpha presence penalty (default: %.1f, 0.0 = disabled)\n", (double)params.presence_penalty);
399+
fprintf(stderr, " --frequency-penalty N repeat alpha frequency penalty (default: %.1f, 0.0 = disabled)\n", (double)params.frequency_penalty);
396400
fprintf(stderr, " --mirostat N use Mirostat sampling.\n");
397401
fprintf(stderr, " Top K, Nucleus, Tail Free and Locally Typical samplers are ignored if used.\n");
398402
fprintf(stderr, " (default: %d, 0 = disabled, 1 = Mirostat, 2 = Mirostat 2.0)\n", params.mirostat);
399-
fprintf(stderr, " --mirostat_lr N Mirostat learning rate, parameter eta (default: %.1f)\n", (double)params.mirostat_eta);
400-
fprintf(stderr, " --mirostat_ent N Mirostat target entropy, parameter tau (default: %.1f)\n", (double)params.mirostat_tau);
403+
fprintf(stderr, " --mirostat-lr N Mirostat learning rate, parameter eta (default: %.1f)\n", (double)params.mirostat_eta);
404+
fprintf(stderr, " --mirostat-ent N Mirostat target entropy, parameter tau (default: %.1f)\n", (double)params.mirostat_tau);
401405
fprintf(stderr, " -l TOKEN_ID(+/-)BIAS, --logit-bias TOKEN_ID(+/-)BIAS\n");
402406
fprintf(stderr, " modifies the likelihood of token appearing in the completion,\n");
403407
fprintf(stderr, " i.e. `--logit-bias 15043+1` to increase likelihood of token ' Hello',\n");
404408
fprintf(stderr, " or `--logit-bias 15043-1` to decrease likelihood of token ' Hello'\n");
405-
fprintf(stderr, " -c N, --ctx_size N size of the prompt context (default: %d)\n", params.n_ctx);
409+
fprintf(stderr, " -c N, --ctx-size N size of the prompt context (default: %d)\n", params.n_ctx);
406410
fprintf(stderr, " --ignore-eos ignore end of stream token and continue generating (implies --logit-bias 2-inf)\n");
407411
fprintf(stderr, " --no-penalize-nl do not penalize newline token\n");
408-
fprintf(stderr, " --memory_f32 use f32 instead of f16 for memory key+value\n");
412+
fprintf(stderr, " --memory-f32 use f32 instead of f16 for memory key+value\n");
409413
fprintf(stderr, " --temp N temperature (default: %.1f)\n", (double)params.temp);
410-
fprintf(stderr, " --n_parts N number of model parts (default: -1 = determine from dimensions)\n");
411-
fprintf(stderr, " -b N, --batch_size N batch size for prompt processing (default: %d)\n", params.n_batch);
414+
fprintf(stderr, " --n-parts N number of model parts (default: -1 = determine from dimensions)\n");
415+
fprintf(stderr, " -b N, --batch-size N batch size for prompt processing (default: %d)\n", params.n_batch);
412416
fprintf(stderr, " --perplexity compute perplexity over the prompt\n");
413417
fprintf(stderr, " --keep number of tokens to keep from the initial prompt (default: %d, -1 = all)\n", params.n_keep);
414418
if (llama_mlock_supported()) {

0 commit comments

Comments
 (0)