Skip to content

Commit 706ef6c

Browse files
authored
Revert "Add seed note on num.threads cross-platform dependency" (#1449)
1 parent b5ff046 commit 706ef6c

21 files changed

+21
-41
lines changed

r-package/grf/DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Imports:
2929
methods,
3030
Rcpp (>= 0.12.15),
3131
sandwich (>= 2.4-0)
32-
RoxygenNote: 7.3.2
32+
RoxygenNote: 7.2.3
3333
Suggests:
3434
DiagrammeR,
3535
MASS,

r-package/grf/R/causal_forest.R

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,7 @@
7474
#' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is TRUE.
7575
#' @param num.threads Number of threads used in training. By default, the number of threads is set
7676
#' to the maximum hardware concurrency.
77-
#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
78-
#' different platforms, ensure the `num.threads` argument is set to the same value.
77+
#' @param seed The seed of the C++ random number generator.
7978
#'
8079
#' @return A trained causal forest object. If tune.parameters is enabled,
8180
#' then tuning information will be included through the `tuning.output` attribute.

r-package/grf/R/causal_survival_forest.R

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,7 @@
8989
#' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is TRUE.
9090
#' @param num.threads Number of threads used in training. By default, the number of threads is set
9191
#' to the maximum hardware concurrency.
92-
#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
93-
#' different platforms, ensure the `num.threads` argument is set to the same value.
92+
#' @param seed The seed of the C++ random number generator.
9493
#'
9594
#' @return A trained causal_survival_forest forest object.
9695
#'

r-package/grf/R/instrumental_forest.R

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,7 @@
7575
#' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is TRUE.
7676
#' @param num.threads Number of threads used in training. By default, the number of threads is set
7777
#' to the maximum hardware concurrency.
78-
#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
79-
#' different platforms, ensure the `num.threads` argument is set to the same value.
78+
#' @param seed The seed of the C++ random number generator.
8079
#'
8180
#' @return A trained instrumental forest object.
8281
#'

r-package/grf/R/ll_regression_forest.R

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@
6060
#' to select the optimal parameters. Default is 1000.
6161
#' @param num.threads Number of threads used in training. By default, the number of threads is set
6262
#' to the maximum hardware concurrency.
63-
#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
64-
#' different platforms, ensure the `num.threads` argument is set to the same value.
63+
#' @param seed The seed of the C++ random number generator.
6564
#'
6665
#' @return A trained local linear forest object.
6766
#'

r-package/grf/R/multi_arm_causal_forest.R

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,7 @@
9797
#' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is TRUE.
9898
#' @param num.threads Number of threads used in training. By default, the number of threads is set
9999
#' to the maximum hardware concurrency.
100-
#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
101-
#' different platforms, ensure the `num.threads` argument is set to the same value.
100+
#' @param seed The seed of the C++ random number generator.
102101
#'
103102
#' @return A trained multi arm causal forest object.
104103
#'

r-package/grf/R/multi_regression_forest.R

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,7 @@
4545
#' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is TRUE.
4646
#' @param num.threads Number of threads used in training. By default, the number of threads is set
4747
#' to the maximum hardware concurrency.
48-
#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
49-
#' different platforms, ensure the `num.threads` argument is set to the same value.
48+
#' @param seed The seed of the C++ random number generator.
5049
#'
5150
#' @return A trained multi regression forest object.
5251
#'

r-package/grf/R/probability_forest.R

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,7 @@
4646
#' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is TRUE.
4747
#' @param num.threads Number of threads used in training. By default, the number of threads is set
4848
#' to the maximum hardware concurrency.
49-
#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
50-
#' different platforms, ensure the `num.threads` argument is set to the same value.
49+
#' @param seed The seed of the C++ random number generator.
5150
#'
5251
#' @return A trained probability forest object.
5352
#'

r-package/grf/R/quantile_forest.R

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,7 @@
4646
#' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is FALSE.
4747
#' @param num.threads Number of threads used in training. By default, the number of threads is set
4848
#' to the maximum hardware concurrency.
49-
#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
50-
#' different platforms, ensure the `num.threads` argument is set to the same value.
49+
#' @param seed The seed of the C++ random number generator.
5150
#'
5251
#' @return A trained quantile forest object.
5352
#'

r-package/grf/R/regression_forest.R

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,7 @@
5757
#' @param compute.oob.predictions Whether OOB predictions on training set should be precomputed. Default is TRUE.
5858
#' @param num.threads Number of threads used in training. By default, the number of threads is set
5959
#' to the maximum hardware concurrency.
60-
#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
61-
#' different platforms, ensure the `num.threads` argument is set to the same value.
60+
#' @param seed The seed of the C++ random number generator.
6261
#'
6362
#' @return A trained regression forest object. If tune.parameters is enabled,
6463
#' then tuning information will be included through the `tuning.output` attribute.

r-package/grf/R/survival_forest.R

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@
5252
#' Only relevant if `compute.oob.predictions` is TRUE. Default is "Kaplan-Meier".
5353
#' @param num.threads Number of threads used in training. By default, the number of threads is set
5454
#' to the maximum hardware concurrency.
55-
#' @param seed The seed of the C++ random number generator. \emph{Note}: For consistent results across
56-
#' different platforms, ensure the `num.threads` argument is set to the same value.
55+
#' @param seed The seed of the C++ random number generator.
5756
#'
5857
#' @return A trained survival_forest forest object.
5958
#'

r-package/grf/man/causal_forest.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

r-package/grf/man/causal_survival_forest.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

r-package/grf/man/instrumental_forest.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

r-package/grf/man/ll_regression_forest.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

r-package/grf/man/multi_arm_causal_forest.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

r-package/grf/man/multi_regression_forest.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

r-package/grf/man/probability_forest.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

r-package/grf/man/quantile_forest.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

r-package/grf/man/regression_forest.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

r-package/grf/man/survival_forest.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)