diff --git a/r-package/grf/DESCRIPTION b/r-package/grf/DESCRIPTION index 0da569db1..95e134e84 100644 --- a/r-package/grf/DESCRIPTION +++ b/r-package/grf/DESCRIPTION @@ -29,7 +29,7 @@ Imports: methods, Rcpp (>= 0.12.15), sandwich (>= 2.4-0) -RoxygenNote: 7.3.2 +RoxygenNote: 7.2.3 Suggests: DiagrammeR, MASS, diff --git a/r-package/grf/R/causal_forest.R b/r-package/grf/R/causal_forest.R index 344f80305..33aca49d9 100644 --- a/r-package/grf/R/causal_forest.R +++ b/r-package/grf/R/causal_forest.R @@ -74,8 +74,7 @@ #' @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. \emph{Note}: For consistent results across -#' different platforms, ensure the `num.threads` argument is set to the same value. +#' @param seed The seed of the C++ random number generator. #' #' @return A trained causal forest object. If tune.parameters is enabled, #' then tuning information will be included through the `tuning.output` attribute. diff --git a/r-package/grf/R/causal_survival_forest.R b/r-package/grf/R/causal_survival_forest.R index 1ea69ac67..dc532cbb0 100644 --- a/r-package/grf/R/causal_survival_forest.R +++ b/r-package/grf/R/causal_survival_forest.R @@ -89,8 +89,7 @@ #' @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. \emph{Note}: For consistent results across -#' different platforms, ensure the `num.threads` argument is set to the same value. +#' @param seed The seed of the C++ random number generator. #' #' @return A trained causal_survival_forest forest object. #' diff --git a/r-package/grf/R/instrumental_forest.R b/r-package/grf/R/instrumental_forest.R index 55a673113..b885d36b7 100644 --- a/r-package/grf/R/instrumental_forest.R +++ b/r-package/grf/R/instrumental_forest.R @@ -75,8 +75,7 @@ #' @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. \emph{Note}: For consistent results across -#' different platforms, ensure the `num.threads` argument is set to the same value. +#' @param seed The seed of the C++ random number generator. #' #' @return A trained instrumental forest object. #' diff --git a/r-package/grf/R/ll_regression_forest.R b/r-package/grf/R/ll_regression_forest.R index 6b02e8855..27b6b87e0 100644 --- a/r-package/grf/R/ll_regression_forest.R +++ b/r-package/grf/R/ll_regression_forest.R @@ -60,8 +60,7 @@ #' 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. \emph{Note}: For consistent results across -#' different platforms, ensure the `num.threads` argument is set to the same value. +#' @param seed The seed of the C++ random number generator. #' #' @return A trained local linear forest object. #' diff --git a/r-package/grf/R/multi_arm_causal_forest.R b/r-package/grf/R/multi_arm_causal_forest.R index c5b8285cc..f04f1e1f9 100644 --- a/r-package/grf/R/multi_arm_causal_forest.R +++ b/r-package/grf/R/multi_arm_causal_forest.R @@ -97,8 +97,7 @@ #' @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. \emph{Note}: For consistent results across -#' different platforms, ensure the `num.threads` argument is set to the same value. +#' @param seed The seed of the C++ random number generator. #' #' @return A trained multi arm causal forest object. #' diff --git a/r-package/grf/R/multi_regression_forest.R b/r-package/grf/R/multi_regression_forest.R index 03012f643..f4e5b964b 100644 --- a/r-package/grf/R/multi_regression_forest.R +++ b/r-package/grf/R/multi_regression_forest.R @@ -45,8 +45,7 @@ #' @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. \emph{Note}: For consistent results across -#' different platforms, ensure the `num.threads` argument is set to the same value. +#' @param seed The seed of the C++ random number generator. #' #' @return A trained multi regression forest object. #' diff --git a/r-package/grf/R/probability_forest.R b/r-package/grf/R/probability_forest.R index 21062cbaf..a835b806e 100644 --- a/r-package/grf/R/probability_forest.R +++ b/r-package/grf/R/probability_forest.R @@ -46,8 +46,7 @@ #' @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. \emph{Note}: For consistent results across -#' different platforms, ensure the `num.threads` argument is set to the same value. +#' @param seed The seed of the C++ random number generator. #' #' @return A trained probability forest object. #' diff --git a/r-package/grf/R/quantile_forest.R b/r-package/grf/R/quantile_forest.R index 36fd7bfbb..ef82dc6f9 100644 --- a/r-package/grf/R/quantile_forest.R +++ b/r-package/grf/R/quantile_forest.R @@ -46,8 +46,7 @@ #' @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. \emph{Note}: For consistent results across -#' different platforms, ensure the `num.threads` argument is set to the same value. +#' @param seed The seed of the C++ random number generator. #' #' @return A trained quantile forest object. #' diff --git a/r-package/grf/R/regression_forest.R b/r-package/grf/R/regression_forest.R index 294b99bc4..d145d0a86 100644 --- a/r-package/grf/R/regression_forest.R +++ b/r-package/grf/R/regression_forest.R @@ -57,8 +57,7 @@ #' @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. \emph{Note}: For consistent results across -#' different platforms, ensure the `num.threads` argument is set to the same value. +#' @param seed The seed of the C++ random number generator. #' #' @return A trained regression forest object. If tune.parameters is enabled, #' then tuning information will be included through the `tuning.output` attribute. diff --git a/r-package/grf/R/survival_forest.R b/r-package/grf/R/survival_forest.R index 2305369ec..96a30365c 100644 --- a/r-package/grf/R/survival_forest.R +++ b/r-package/grf/R/survival_forest.R @@ -52,8 +52,7 @@ #' 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. \emph{Note}: For consistent results across -#' different platforms, ensure the `num.threads` argument is set to the same value. +#' @param seed The seed of the C++ random number generator. #' #' @return A trained survival_forest forest object. #' diff --git a/r-package/grf/man/causal_forest.Rd b/r-package/grf/man/causal_forest.Rd index 0ebcc525b..fe3b21240 100644 --- a/r-package/grf/man/causal_forest.Rd +++ b/r-package/grf/man/causal_forest.Rd @@ -124,8 +124,7 @@ to select the optimal parameters. Default is 1000.} \item{num.threads}{Number of threads used in training. By default, the number of threads is set to the maximum hardware concurrency.} -\item{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.} +\item{seed}{The seed of the C++ random number generator.} } \value{ A trained causal forest object. If tune.parameters is enabled, diff --git a/r-package/grf/man/causal_survival_forest.Rd b/r-package/grf/man/causal_survival_forest.Rd index 2f3638c64..27cfc649b 100644 --- a/r-package/grf/man/causal_survival_forest.Rd +++ b/r-package/grf/man/causal_survival_forest.Rd @@ -135,8 +135,7 @@ Default is "none" (no parameters are tuned).} \item{num.threads}{Number of threads used in training. By default, the number of threads is set to the maximum hardware concurrency.} -\item{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.} +\item{seed}{The seed of the C++ random number generator.} } \value{ A trained causal_survival_forest forest object. diff --git a/r-package/grf/man/instrumental_forest.Rd b/r-package/grf/man/instrumental_forest.Rd index a7568f34b..bf62bd3c6 100644 --- a/r-package/grf/man/instrumental_forest.Rd +++ b/r-package/grf/man/instrumental_forest.Rd @@ -133,8 +133,7 @@ to select the optimal parameters. Default is 1000.} \item{num.threads}{Number of threads used in training. By default, the number of threads is set to the maximum hardware concurrency.} -\item{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.} +\item{seed}{The seed of the C++ random number generator.} } \value{ A trained instrumental forest object. diff --git a/r-package/grf/man/ll_regression_forest.Rd b/r-package/grf/man/ll_regression_forest.Rd index 8ddc30cb0..8fb5152b6 100644 --- a/r-package/grf/man/ll_regression_forest.Rd +++ b/r-package/grf/man/ll_regression_forest.Rd @@ -114,8 +114,7 @@ to select the optimal parameters. Default is 1000.} \item{num.threads}{Number of threads used in training. By default, the number of threads is set to the maximum hardware concurrency.} -\item{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.} +\item{seed}{The seed of the C++ random number generator.} } \value{ A trained local linear forest object. diff --git a/r-package/grf/man/multi_arm_causal_forest.Rd b/r-package/grf/man/multi_arm_causal_forest.Rd index 367721732..68815a5ef 100644 --- a/r-package/grf/man/multi_arm_causal_forest.Rd +++ b/r-package/grf/man/multi_arm_causal_forest.Rd @@ -112,8 +112,7 @@ currently only supported for univariate outcomes Y).} \item{num.threads}{Number of threads used in training. By default, the number of threads is set to the maximum hardware concurrency.} -\item{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.} +\item{seed}{The seed of the C++ random number generator.} } \value{ A trained multi arm causal forest object. diff --git a/r-package/grf/man/multi_regression_forest.Rd b/r-package/grf/man/multi_regression_forest.Rd index 006524cb5..c6814d25f 100644 --- a/r-package/grf/man/multi_regression_forest.Rd +++ b/r-package/grf/man/multi_regression_forest.Rd @@ -83,8 +83,7 @@ Only applies if honesty is enabled. Default is TRUE.} \item{num.threads}{Number of threads used in training. By default, the number of threads is set to the maximum hardware concurrency.} -\item{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.} +\item{seed}{The seed of the C++ random number generator.} } \value{ A trained multi regression forest object. diff --git a/r-package/grf/man/probability_forest.Rd b/r-package/grf/man/probability_forest.Rd index 49c115830..78ebf346a 100644 --- a/r-package/grf/man/probability_forest.Rd +++ b/r-package/grf/man/probability_forest.Rd @@ -86,8 +86,7 @@ be at least 2. Default is 2.} \item{num.threads}{Number of threads used in training. By default, the number of threads is set to the maximum hardware concurrency.} -\item{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.} +\item{seed}{The seed of the C++ random number generator.} } \value{ A trained probability forest object. diff --git a/r-package/grf/man/quantile_forest.Rd b/r-package/grf/man/quantile_forest.Rd index 4f600ca9a..12daed375 100644 --- a/r-package/grf/man/quantile_forest.Rd +++ b/r-package/grf/man/quantile_forest.Rd @@ -86,8 +86,7 @@ Only applies if honesty is enabled. Default is TRUE.} \item{num.threads}{Number of threads used in training. By default, the number of threads is set to the maximum hardware concurrency.} -\item{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.} +\item{seed}{The seed of the C++ random number generator.} } \value{ A trained quantile forest object. diff --git a/r-package/grf/man/regression_forest.Rd b/r-package/grf/man/regression_forest.Rd index b20daf28b..3a25a5b21 100644 --- a/r-package/grf/man/regression_forest.Rd +++ b/r-package/grf/man/regression_forest.Rd @@ -105,8 +105,7 @@ to select the optimal parameters. Default is 1000.} \item{num.threads}{Number of threads used in training. By default, the number of threads is set to the maximum hardware concurrency.} -\item{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.} +\item{seed}{The seed of the C++ random number generator.} } \value{ A trained regression forest object. If tune.parameters is enabled, diff --git a/r-package/grf/man/survival_forest.Rd b/r-package/grf/man/survival_forest.Rd index c3e77a79b..5a2261ff9 100644 --- a/r-package/grf/man/survival_forest.Rd +++ b/r-package/grf/man/survival_forest.Rd @@ -94,8 +94,7 @@ Only relevant if `compute.oob.predictions` is TRUE. Default is "Kaplan-Meier".} \item{num.threads}{Number of threads used in training. By default, the number of threads is set to the maximum hardware concurrency.} -\item{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.} +\item{seed}{The seed of the C++ random number generator.} } \value{ A trained survival_forest forest object.