From e92a28ed0033f097632f9fc7564ac446142e8adc Mon Sep 17 00:00:00 2001 From: James Lamb Date: Thu, 23 Sep 2021 21:04:09 -0500 Subject: [PATCH] update docs --- R-package/DESCRIPTION | 2 +- R-package/R/lgb.Dataset.R | 2 +- R-package/man/getinfo.Rd | 6 +++--- R-package/man/set_field.Rd | 2 +- R-package/man/setinfo.Rd | 6 +++--- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/R-package/DESCRIPTION b/R-package/DESCRIPTION index b03bc56d5298..ded208356c61 100755 --- a/R-package/DESCRIPTION +++ b/R-package/DESCRIPTION @@ -58,4 +58,4 @@ Imports: utils SystemRequirements: C++11 -RoxygenNote: 7.1.1 +RoxygenNote: 7.1.2 diff --git a/R-package/R/lgb.Dataset.R b/R-package/R/lgb.Dataset.R index df82730a6a0e..91f729188a1f 100644 --- a/R-package/R/lgb.Dataset.R +++ b/R-package/R/lgb.Dataset.R @@ -586,7 +586,7 @@ Dataset <- R6::R6Class( , paste(names(additional_keyword_args), collapse = ", ") , ". These are ignored and should be removed. " , "To change the parameters of a Dataset produced by Dataset$slice(), use Dataset$set_params(). " - , "To modify attributes like 'init_score', use Dataset$setinfo(). " + , "To modify attributes like 'init_score', use Dataset$set_field(). " , "In future releases of lightgbm, this warning will become an error." )) } diff --git a/R-package/man/getinfo.Rd b/R-package/man/getinfo.Rd index 4d94a8dd7e50..33c75e92da21 100644 --- a/R-package/man/getinfo.Rd +++ b/R-package/man/getinfo.Rd @@ -43,10 +43,10 @@ train <- agaricus.train dtrain <- lgb.Dataset(train$data, label = train$label) lgb.Dataset.construct(dtrain) -labels <- lightgbm::get_field(dtrain, "label") -lightgbm::set_field(dtrain, "label", 1 - labels) +labels <- lightgbm::getinfo(dtrain, "label") +lightgbm::setinfo(dtrain, "label", 1 - labels) -labels2 <- lightgbm::get_field(dtrain, "label") +labels2 <- lightgbm::getinfo(dtrain, "label") stopifnot(all(labels2 == 1 - labels)) } } diff --git a/R-package/man/set_field.Rd b/R-package/man/set_field.Rd index 24be7b7295ea..f9901e27eefd 100644 --- a/R-package/man/set_field.Rd +++ b/R-package/man/set_field.Rd @@ -12,7 +12,7 @@ set_field(dataset, field_name, data) \arguments{ \item{dataset}{Object of class \code{lgb.Dataset}} -\item{field_name}{String with the name of the attribute to get. One of the following. +\item{field_name}{String with the name of the attribute to set. One of the following. \itemize{ \item \code{label}: label lightgbm learns from ; \item \code{weight}: to do a weight rescale ; diff --git a/R-package/man/setinfo.Rd b/R-package/man/setinfo.Rd index 3f975c77b9c6..a6918eb6a13a 100644 --- a/R-package/man/setinfo.Rd +++ b/R-package/man/setinfo.Rd @@ -45,10 +45,10 @@ train <- agaricus.train dtrain <- lgb.Dataset(train$data, label = train$label) lgb.Dataset.construct(dtrain) -labels <- lightgbm::get_field(dtrain, "label") -lightgbm::set_field(dtrain, "label", 1 - labels) +labels <- lightgbm::getinfo(dtrain, "label") +lightgbm::setinfo(dtrain, "label", 1 - labels) -labels2 <- lightgbm::get_field(dtrain, "label") +labels2 <- lightgbm::getinfo(dtrain, "label") stopifnot(all.equal(labels2, 1 - labels)) } }