Skip to content

Commit

Permalink
Revert "Add seed note on num.threads cross-platform dependency" (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
erikcs authored Sep 24, 2024
1 parent b5ff046 commit 706ef6c
Show file tree
Hide file tree
Showing 21 changed files with 21 additions and 41 deletions.
2 changes: 1 addition & 1 deletion r-package/grf/DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
3 changes: 1 addition & 2 deletions r-package/grf/R/causal_forest.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 1 addition & 2 deletions r-package/grf/R/causal_survival_forest.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
#'
Expand Down
3 changes: 1 addition & 2 deletions r-package/grf/R/instrumental_forest.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
#'
Expand Down
3 changes: 1 addition & 2 deletions r-package/grf/R/ll_regression_forest.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
#'
Expand Down
3 changes: 1 addition & 2 deletions r-package/grf/R/multi_arm_causal_forest.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
#'
Expand Down
3 changes: 1 addition & 2 deletions r-package/grf/R/multi_regression_forest.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
#'
Expand Down
3 changes: 1 addition & 2 deletions r-package/grf/R/probability_forest.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
#'
Expand Down
3 changes: 1 addition & 2 deletions r-package/grf/R/quantile_forest.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
#'
Expand Down
3 changes: 1 addition & 2 deletions r-package/grf/R/regression_forest.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 1 addition & 2 deletions r-package/grf/R/survival_forest.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
#'
Expand Down
3 changes: 1 addition & 2 deletions r-package/grf/man/causal_forest.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions r-package/grf/man/causal_survival_forest.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions r-package/grf/man/instrumental_forest.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions r-package/grf/man/ll_regression_forest.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions r-package/grf/man/multi_arm_causal_forest.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions r-package/grf/man/multi_regression_forest.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions r-package/grf/man/probability_forest.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions r-package/grf/man/quantile_forest.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions r-package/grf/man/regression_forest.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions r-package/grf/man/survival_forest.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 706ef6c

Please sign in to comment.