* scripts/irace_options.json (debugLevel): Mention valid values.

MLopez-Ibanez · Feb 12, 2025 · 8c2dd55 · 8c2dd55
1 parent cc590e8
commit 8c2dd55
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 9 deletions.
diff --git a/R/irace-options.R b/R/irace-options.R
@@ -96,7 +96,7 @@ NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA), description = c("Show this help
 "Enable/disable load-balancing when executing experiments in parallel. Load-balancing makes better use of computing resources, but increases communication overhead. If this overhead is large, disabling load-balancing may be faster.",
 "Enable/disable MPI. Use `Rmpi` to execute `targetRunner` in parallel (parameter `parallel` is the number of slaves).",
 "Specify how irace waits for jobs to finish when `targetRunner` submits jobs to a batch cluster: sge, pbs, torque, slurm or htcondor. `targetRunner` must submit jobs to the cluster using, for example, `qsub`.",
-"Reduce the output generated by irace to a minimum.", "Debug level of the output of `irace`. Set this to 0 to silence all debug messages. Higher values provide more verbose debug messages.",
+"Reduce the output generated by irace to a minimum.", "Debug level of the output of `irace`. Set this to 0 to silence all debug messages. Higher values (1, 2 or 3) provide more verbose debug messages.",
 "Seed of the random number generator (by default, generate a random seed).",
 "Enable/disable the soft restart strategy that avoids premature convergence of the probabilistic model.",
 "Soft restart threshold value for numerical parameters.", "Enable/disable elitist irace.",

diff --git a/R/scenario.R b/R/scenario.R
@@ -556,7 +556,7 @@ printScenario <- function(scenario)
 #'      \item{`execDir`}{Directory where the programs will be run. (Default: `"./"`)}
 #'      \item{`logFile`}{File to save tuning results as an R dataset, either absolute path or relative to execDir. (Default: `"./irace.Rdata"`)}
 #'      \item{`quiet`}{Reduce the output generated by irace to a minimum. (Default: `0`)}
-#'      \item{`debugLevel`}{Debug level of the output of `irace`. Set this to 0 to silence all debug messages. Higher values provide more verbose debug messages. (Default: `0`)}
+#'      \item{`debugLevel`}{Debug level of the output of `irace`. Set this to 0 to silence all debug messages. Higher values (1, 2 or 3) provide more verbose debug messages. (Default: `0`)}
 #'      \item{`seed`}{Seed of the random number generator (by default, generate a random seed). (Default: `NA`)}
 #'      \item{`repairConfiguration`}{User-defined R function that takes a configuration generated by irace and repairs it. (Default: `""`)}
 #'      \item{`postselection`}{Perform a postselection race after the execution of irace to consume all remaining budget. Value 0 disables the postselection race. (Default: `1`)}

diff --git a/inst/templates/scenario.txt.tmpl b/inst/templates/scenario.txt.tmpl
@@ -160,7 +160,7 @@
 # quiet = 0
 
 ## Debug level of the output of `irace`. Set this to 0 to silence all debug
-## messages. Higher values provide more verbose debug messages.
+## messages. Higher values (1, 2 or 3) provide more verbose debug messages.
 # debugLevel = 0
 
 ## Seed of the random number generator (by default, generate a random seed).

diff --git a/man/defaultScenario.Rd b/man/defaultScenario.Rd
diff --git a/man/irace_cmdline.Rd b/man/irace_cmdline.Rd
diff --git a/scripts/irace_options.json b/scripts/irace_options.json
@@ -448,9 +448,9 @@
     "short": "",
     "long": "--debug-level",
     "default": 0,
-    "vignettes": "Level of information to display in the text output of \\irace. A value of 0 silences all debug messages. Higher values provide more verbose debug messages. Details about the text output of \\irace are given in \\autoref{sec:output text}.",
+    "vignettes": "Level of information to display in the text output of \\irace. A value of 0 silences all debug messages. Higher values (1, 2 or 3) provide more verbose debug messages. Details about the text output of \\irace are given in \\autoref{sec:output text}.",
     "section": "General options",
-    "description": "Debug level of the output of \\code{irace}. Set this to 0 to silence all debug messages. Higher values provide more verbose debug messages."
+    "description": "Debug level of the output of \\code{irace}. Set this to 0 to silence all debug messages. Higher values (1, 2 or 3) provide more verbose debug messages."
   },
   {
     "name": "seed",

diff --git a/vignettes/section/irace-options.Rnw b/vignettes/section/irace-options.Rnw
@@ -31,7 +31,7 @@
  Reduce the output generated by irace to a minimum.
 
  \defparameter{debugLevel}{debug-level}{0}%
- Level of information to display in the text output of \irace. A value of 0 silences all debug messages. Higher values provide more verbose debug messages. Details about the text output of \irace are given in \autoref{sec:output text}.
+ Level of information to display in the text output of \irace. A value of 0 silences all debug messages. Higher values (1, 2 or 3) provide more verbose debug messages. Details about the text output of \irace are given in \autoref{sec:output text}.
 
  \defparameter{seed}{seed}{}%
  Seed to initiallize the random number generator. The seed must be a positive integer. If the seed is \code{""} or \code{NULL}, a random seed will be generated.