Add seed note on num.threads cross-platform dependency (#1438)

Author: erikcs

r-package/grf/DESCRIPTION

@@ -29,7 +29,7 @@ Imports:
     methods,
     Rcpp (>= 0.12.15),
     sandwich (>= 2.4-0)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2
 Suggests:
     DiagrammeR,
     MASS,

r-package/grf/R/causal_forest.R

@@ -74,7 +74,8 @@
 #' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is TRUE.
 #' @param num.threads Number of threads used in training. By default, the number of threads is set
 #'                    to the maximum hardware concurrency.
-#' @param seed The seed of the C++ random number generator.
+#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
+#'  different platforms, ensure the `num.threads` argument is set to the same value.
 #'
 #' @return A trained causal forest object. If tune.parameters is enabled,
 #'  then tuning information will be included through the `tuning.output` attribute.

r-package/grf/R/causal_survival_forest.R

@@ -89,7 +89,8 @@
 #' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is TRUE.
 #' @param num.threads Number of threads used in training. By default, the number of threads is set
 #'                    to the maximum hardware concurrency.
-#' @param seed The seed of the C++ random number generator.
+#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
+#'  different platforms, ensure the `num.threads` argument is set to the same value.
 #'
 #' @return A trained causal_survival_forest forest object.
 #'

r-package/grf/R/instrumental_forest.R

@@ -75,7 +75,8 @@
 #' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is TRUE.
 #' @param num.threads Number of threads used in training. By default, the number of threads is set
 #'                    to the maximum hardware concurrency.
-#' @param seed The seed of the C++ random number generator.
+#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
+#'  different platforms, ensure the `num.threads` argument is set to the same value.
 #'
 #' @return A trained instrumental forest object.
 #'

r-package/grf/R/ll_regression_forest.R

@@ -60,7 +60,8 @@
 #'                          to select the optimal parameters. Default is 1000.
 #' @param num.threads Number of threads used in training. By default, the number of threads is set
 #'                    to the maximum hardware concurrency.
-#' @param seed The seed of the C++ random number generator.
+#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
+#'  different platforms, ensure the `num.threads` argument is set to the same value.
 #'
 #' @return A trained local linear forest object.
 #'

r-package/grf/R/multi_arm_causal_forest.R

@@ -97,7 +97,8 @@
 #' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is TRUE.
 #' @param num.threads Number of threads used in training. By default, the number of threads is set
 #'                    to the maximum hardware concurrency.
-#' @param seed The seed of the C++ random number generator.
+#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
+#'  different platforms, ensure the `num.threads` argument is set to the same value.
 #'
 #' @return A trained multi arm causal forest object.
 #'

r-package/grf/R/multi_regression_forest.R

@@ -45,7 +45,8 @@
 #' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is TRUE.
 #' @param num.threads Number of threads used in training. By default, the number of threads is set
 #'                    to the maximum hardware concurrency.
-#' @param seed The seed of the C++ random number generator.
+#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
+#'  different platforms, ensure the `num.threads` argument is set to the same value.
 #'
 #' @return A trained multi regression forest object.
 #'

r-package/grf/R/probability_forest.R

@@ -46,7 +46,8 @@
 #' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is TRUE.
 #' @param num.threads Number of threads used in training. By default, the number of threads is set
 #'                    to the maximum hardware concurrency.
-#' @param seed The seed of the C++ random number generator.
+#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
+#'  different platforms, ensure the `num.threads` argument is set to the same value.
 #'
 #' @return A trained probability forest object.
 #'

r-package/grf/R/quantile_forest.R

@@ -46,7 +46,8 @@
 #' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is FALSE.
 #' @param num.threads Number of threads used in training. By default, the number of threads is set
 #'                    to the maximum hardware concurrency.
-#' @param seed The seed of the C++ random number generator.
+#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
+#'  different platforms, ensure the `num.threads` argument is set to the same value.
 #'
 #' @return A trained quantile forest object.
 #'

r-package/grf/R/regression_forest.R

@@ -57,7 +57,8 @@
 #' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is TRUE.
 #' @param num.threads Number of threads used in training. By default, the number of threads is set
 #'                    to the maximum hardware concurrency.
-#' @param seed The seed of the C++ random number generator.
+#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
+#'  different platforms, ensure the `num.threads` argument is set to the same value.
 #'
 #' @return A trained regression forest object. If tune.parameters is enabled,
 #'  then tuning information will be included through the `tuning.output` attribute.

r-package/grf/R/survival_forest.R

@@ -52,7 +52,8 @@
 #' Only relevant if `compute.oob.predictions` is TRUE. Default is "Kaplan-Meier".
 #' @param num.threads Number of threads used in training. By default, the number of threads is set
 #'                    to the maximum hardware concurrency.
-#' @param seed The seed of the C++ random number generator.
+#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
+#'  different platforms, ensure the `num.threads` argument is set to the same value.
 #'
 #' @return A trained survival_forest forest object.
 #'