From bcde49f5b32230dcf36d6ce17c7911bc877b76bb Mon Sep 17 00:00:00 2001 From: James Lamb Date: Mon, 10 Aug 2020 22:03:07 -0500 Subject: [PATCH 01/10] [R-package] DESCRIPTION changes to address CRAN feedback --- R-package/.Rbuildignore | 1 + R-package/DESCRIPTION | 7 +++---- R-package/cran-comments.md | 25 +++++++++++++++++++++++++ 3 files changed, 29 insertions(+), 4 deletions(-) create mode 100644 R-package/cran-comments.md diff --git a/R-package/.Rbuildignore b/R-package/.Rbuildignore index 301b5c86a7a1..f32e3a160a47 100644 --- a/R-package/.Rbuildignore +++ b/R-package/.Rbuildignore @@ -2,6 +2,7 @@ \.gitkeep$ ^docs$ ^pkgdown$ +^cran-comments\.md$ # Objects created by compilation ^.*\.o diff --git a/R-package/DESCRIPTION b/R-package/DESCRIPTION index 202fc0fb0627..def1cf9ac2d6 100755 --- a/R-package/DESCRIPTION +++ b/R-package/DESCRIPTION @@ -9,21 +9,20 @@ Authors@R: c( person("Yachen", "Yan", role = c("ctb")), person("James", "Lamb", email="jaylamb20@gmail.com", role = c("ctb")) ) -Description: Tree based algorithms can be improved by introducing boosting frameworks. LightGBM is one such framework, and this package offers an R interface to work with it. +Description: Tree based algorithms can be improved by introducing boosting frameworks. "LightGBM" is one such framework, and this package offers an R interface to work with it. It is designed to be distributed and efficient with the following advantages: 1. Faster training speed and higher efficiency. 2. Lower memory usage. 3. Better accuracy. 4. Parallel learning supported. 5. Capable of handling large-scale data. - In recognition of these advantages, LightGBM has been widely-used in many winning solutions of machine learning competitions. - Comparison experiments on public datasets suggest that LightGBM can outperform existing boosting frameworks on both efficiency and accuracy, with significantly lower memory consumption. In addition, parallel experiments suggest that in certain circumstances, LightGBM can achieve a linear speed-up in training time by using multiple machines. + In recognition of these advantages, "LightGBM" has been widely-used in many winning solutions of machine learning competitions. + Comparison experiments on public datasets suggest that "LightGBM" can outperform existing boosting frameworks on both efficiency and accuracy, with significantly lower memory consumption. In addition, parallel experiments suggest that in certain circumstances, "LightGBM" can achieve a linear speed-up in training time by using multiple machines. Encoding: UTF-8 License: MIT + file LICENSE URL: https://github.com/Microsoft/LightGBM BugReports: https://github.com/Microsoft/LightGBM/issues NeedsCompilation: yes -Biarch: false Suggests: processx, testthat diff --git a/R-package/cran-comments.md b/R-package/cran-comments.md new file mode 100644 index 000000000000..6a5849450bc7 --- /dev/null +++ b/R-package/cran-comments.md @@ -0,0 +1,25 @@ +# CRAN Submission History + +## v3.0.0-1 - Submission 1 - (August 9, 2020) + +### CRAN Response + +* Debian: 1 NOTE + + ```text + Possibly mis-spelled words in DESCRIPTION: + LightGBM (12:88, 19:41, 20:60, 20:264) + ``` + +* Windows: 1 ERROR, 1 NOTE + + ```text + Possibly mis-spelled words in DESCRIPTION: + LightGBM (12:88, 19:41, 20:60, 20:264) + + ** checking whether the package can be loaded ... ERROR + Loading this package had a fatal error status code 1 + Loading log: + Error: package 'lightgbm' is not installed for 'arch = i386' + Execution halted + ``` From 85a1882243f0d594cd00a5ba02572cde4aed90c2 Mon Sep 17 00:00:00 2001 From: James Lamb Date: Mon, 10 Aug 2020 22:22:03 -0500 Subject: [PATCH 02/10] CRAN likes single quotes --- R-package/DESCRIPTION | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/R-package/DESCRIPTION b/R-package/DESCRIPTION index def1cf9ac2d6..1f4eef11c8f4 100755 --- a/R-package/DESCRIPTION +++ b/R-package/DESCRIPTION @@ -9,15 +9,15 @@ Authors@R: c( person("Yachen", "Yan", role = c("ctb")), person("James", "Lamb", email="jaylamb20@gmail.com", role = c("ctb")) ) -Description: Tree based algorithms can be improved by introducing boosting frameworks. "LightGBM" is one such framework, and this package offers an R interface to work with it. +Description: Tree based algorithms can be improved by introducing boosting frameworks. 'LightGBM' is one such framework, and this package offers an R interface to work with it. It is designed to be distributed and efficient with the following advantages: 1. Faster training speed and higher efficiency. 2. Lower memory usage. 3. Better accuracy. 4. Parallel learning supported. 5. Capable of handling large-scale data. - In recognition of these advantages, "LightGBM" has been widely-used in many winning solutions of machine learning competitions. - Comparison experiments on public datasets suggest that "LightGBM" can outperform existing boosting frameworks on both efficiency and accuracy, with significantly lower memory consumption. In addition, parallel experiments suggest that in certain circumstances, "LightGBM" can achieve a linear speed-up in training time by using multiple machines. + In recognition of these advantages, 'LightGBM' has been widely-used in many winning solutions of machine learning competitions. + Comparison experiments on public datasets suggest that 'LightGBM' can outperform existing boosting frameworks on both efficiency and accuracy, with significantly lower memory consumption. In addition, parallel experiments suggest that in certain circumstances, 'LightGBM' can achieve a linear speed-up in training time by using multiple machines. Encoding: UTF-8 License: MIT + file LICENSE URL: https://github.com/Microsoft/LightGBM From 44e523c91fd9b29a2cdde9e33f84eea3fc3265f9 Mon Sep 17 00:00:00 2001 From: James Lamb Date: Mon, 10 Aug 2020 22:42:13 -0500 Subject: [PATCH 03/10] the regex rules for Rbuildignore are weird --- R-package/.Rbuildignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R-package/.Rbuildignore b/R-package/.Rbuildignore index f32e3a160a47..6514d6a9c6b2 100644 --- a/R-package/.Rbuildignore +++ b/R-package/.Rbuildignore @@ -2,7 +2,7 @@ \.gitkeep$ ^docs$ ^pkgdown$ -^cran-comments\.md$ +^cran-comments.md$ # Objects created by compilation ^.*\.o From f957e4b6654eddea1165aeb6d6b2a4d96df06d0a Mon Sep 17 00:00:00 2001 From: James Lamb Date: Mon, 10 Aug 2020 22:59:20 -0500 Subject: [PATCH 04/10] ugh Rbuildignore --- R-package/.Rbuildignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R-package/.Rbuildignore b/R-package/.Rbuildignore index 6514d6a9c6b2..7089cc9ea0ee 100644 --- a/R-package/.Rbuildignore +++ b/R-package/.Rbuildignore @@ -2,7 +2,7 @@ \.gitkeep$ ^docs$ ^pkgdown$ -^cran-comments.md$ +cran-comments.md # Objects created by compilation ^.*\.o From 8edef1ea7d21b990bbfeb4626385b277684531ab Mon Sep 17 00:00:00 2001 From: James Lamb Date: Mon, 10 Aug 2020 23:19:37 -0500 Subject: [PATCH 05/10] how does this wooork --- R-package/.Rbuildignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R-package/.Rbuildignore b/R-package/.Rbuildignore index 7089cc9ea0ee..f32e3a160a47 100644 --- a/R-package/.Rbuildignore +++ b/R-package/.Rbuildignore @@ -2,7 +2,7 @@ \.gitkeep$ ^docs$ ^pkgdown$ -cran-comments.md +^cran-comments\.md$ # Objects created by compilation ^.*\.o From 5a97a96e8b121d61a0f97dd1dd839dc839b6e009 Mon Sep 17 00:00:00 2001 From: James Lamb Date: Mon, 10 Aug 2020 23:32:20 -0500 Subject: [PATCH 06/10] just remove cran-comments.md in script --- build-cran-package.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/build-cran-package.sh b/build-cran-package.sh index 777f7e6d9a8c..564ecb91fe1d 100755 --- a/build-cran-package.sh +++ b/build-cran-package.sh @@ -30,6 +30,7 @@ cd ${TEMP_R_DIR} rm -r src/cmake/ rm -r inst/ rm -r pkgdown/ + rm cran-comments.md rm AUTOCONF_UBUNTU_VERSION rm recreate-configure.sh From 47b8e718b8adca921b1111398b3bf563067adaa5 Mon Sep 17 00:00:00 2001 From: James Lamb Date: Tue, 11 Aug 2020 09:51:04 -0500 Subject: [PATCH 07/10] adding Biarch back --- R-package/.Rbuildignore | 2 +- R-package/DESCRIPTION | 1 + R-package/cran-comments.md | 67 +++++++++++++++++++++++++++++++++++++- 3 files changed, 68 insertions(+), 2 deletions(-) diff --git a/R-package/.Rbuildignore b/R-package/.Rbuildignore index f32e3a160a47..ff326187a59e 100644 --- a/R-package/.Rbuildignore +++ b/R-package/.Rbuildignore @@ -1,6 +1,6 @@ ^build_r.R$ \.gitkeep$ -^docs$ +^docs/.*$ ^pkgdown$ ^cran-comments\.md$ diff --git a/R-package/DESCRIPTION b/R-package/DESCRIPTION index 1f4eef11c8f4..30500b82a5c1 100755 --- a/R-package/DESCRIPTION +++ b/R-package/DESCRIPTION @@ -23,6 +23,7 @@ License: MIT + file LICENSE URL: https://github.com/Microsoft/LightGBM BugReports: https://github.com/Microsoft/LightGBM/issues NeedsCompilation: yes +Biarch: true Suggests: processx, testthat diff --git a/R-package/cran-comments.md b/R-package/cran-comments.md index 6a5849450bc7..bf0d4e111028 100644 --- a/R-package/cran-comments.md +++ b/R-package/cran-comments.md @@ -1,8 +1,67 @@ # CRAN Submission History +## v3.0.0-1 - Submission 2 - (August 10, 2020) + +### CRAN response + +Failing pre-checks. + +### `R CMD check` results + +* Debian: 2 NOTEs + + ```text + * checking CRAN incoming feasibility ... NOTE + Maintainer: ‘Guolin Ke ’ + + New submission + + License components with restrictions and base license permitting such: + MIT + file LICENSE + + Non-standard files/directories found at top level: + ‘cran-comments.md’ ‘docs’ + ``` + +* Windows: 1 ERROR, 2 NOTEs + + ```text + * checking CRAN incoming feasibility ... NOTE + Maintainer: 'Guolin Ke ' + + New submission + + License components with restrictions and base license permitting such: + MIT + file LICENSE + + * checking top-level files ... NOTE + Non-standard files/directories found at top level: + 'cran-comments.md' 'docs' + + ** checking whether the package can be loaded ... ERROR + Loading this package had a fatal error status code 1 + Loading log: + Error: package 'lightgbm' is not installed for 'arch = i386' + Execution halted + ``` + +### Maintainer Notes + +Seems removing `Biarch` field did't work. Noticed this in the install logs: + +> Warning: this package has a non-empty 'configure.win' file, so building only the main architecture + +Tried adding `Biarch: true` to `DESCRIPTION` to overcome this. + +NOTE about non-standard files was the result of a mistake in `.Rbuildignore` syntax, and something strange with how `cran-comments.md` line in `.Rbuildignore` was treated. Updated `.Rbuildignore` and added an `rm cran-comments.md` to `build-cran-package.sh`. + ## v3.0.0-1 - Submission 1 - (August 9, 2020) -### CRAN Response +### CRAN response + +Failing pre-checks. + +### `R CMD check` results * Debian: 1 NOTE @@ -23,3 +82,9 @@ Error: package 'lightgbm' is not installed for 'arch = i386' Execution halted ``` + +### Maintainer Notes + +Thought the issue on Windows was caused by `Biarch: false` in `DESCRIPTION`. Removed `Biarch` field. + +Thought the "misspellings" issue could be resolved by adding single quotes around LightGBM, like `'LightGBM'`. From 69ab6d276253056b5543c518344fee6ac623bbf7 Mon Sep 17 00:00:00 2001 From: James Lamb Date: Tue, 11 Aug 2020 16:10:02 +0100 Subject: [PATCH 08/10] Update R-package/cran-comments.md Co-authored-by: Nikita Titov --- R-package/cran-comments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R-package/cran-comments.md b/R-package/cran-comments.md index bf0d4e111028..da29e1117726 100644 --- a/R-package/cran-comments.md +++ b/R-package/cran-comments.md @@ -47,7 +47,7 @@ Failing pre-checks. ### Maintainer Notes -Seems removing `Biarch` field did't work. Noticed this in the install logs: +Seems removing `Biarch` field didn't work. Noticed this in the install logs: > Warning: this package has a non-empty 'configure.win' file, so building only the main architecture From f7eac6000d20ddb3a2f692261d238eb21de217d9 Mon Sep 17 00:00:00 2001 From: James Lamb Date: Wed, 12 Aug 2020 11:28:00 -0500 Subject: [PATCH 09/10] add submission 3 notes --- R-package/cran-comments.md | 57 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) diff --git a/R-package/cran-comments.md b/R-package/cran-comments.md index da29e1117726..6523e18290a8 100644 --- a/R-package/cran-comments.md +++ b/R-package/cran-comments.md @@ -1,5 +1,62 @@ # CRAN Submission History +## v3.0.0-1 - Submission 3 - (August 13, 2020) + +### CRAN response + +Failing pre-checks. + +### `R CMD check` results + +* Debian: 1 NOTE + + ```text + * checking CRAN incoming feasibility ... NOTE + Maintainer: ‘Guolin Ke ’ + + New submission + + License components with restrictions and base license permitting such: + MIT + file LICENSE + ``` + +* Windows: 1 ERROR, 1 NOTE + + ```text + * checking CRAN incoming feasibility ... NOTE + Maintainer: ‘Guolin Ke ’ + + New submission + + License components with restrictions and base license permitting such: + MIT + file LICENSE + + ** running tests for arch 'i386' ... [9s] ERROR + Running 'testthat.R' [8s] + Running the tests in 'tests/testthat.R' failed. + Complete output: + > library(testthat) + > library(lightgbm) + Loading required package: R6 + > + > test_check( + + package = "lightgbm" + + , stop_on_failure = TRUE + + , stop_on_warning = FALSE + + ) + -- 1. Error: predictions do not fail for integer input (@test_Predictor.R#7) -- + lgb.Dataset.construct: cannot create Dataset handle + Backtrace: + 1. lightgbm::lgb.train(...) + 2. data$construct() + ``` + +### Maintainer Notes + +The "checking CRAN incoming feasibility" NOTE can be safely ignored. It only shows up the first time you submit a package to CRAN. + +So the only thing I see broken right now is the test error on 32-bit Windows. This is documented in https://github.com/microsoft/LightGBM/issues/3187. + ## v3.0.0-1 - Submission 2 - (August 10, 2020) ### CRAN response From 2022868c51ee280c91400f55e833baafae193493 Mon Sep 17 00:00:00 2001 From: James Lamb Date: Wed, 12 Aug 2020 23:23:09 +0100 Subject: [PATCH 10/10] Update R-package/cran-comments.md --- R-package/cran-comments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R-package/cran-comments.md b/R-package/cran-comments.md index 6523e18290a8..a405da6a792b 100644 --- a/R-package/cran-comments.md +++ b/R-package/cran-comments.md @@ -1,6 +1,6 @@ # CRAN Submission History -## v3.0.0-1 - Submission 3 - (August 13, 2020) +## v3.0.0-1 - Submission 3 - (August 12, 2020) ### CRAN response