[R-package] [gpu] Cmake version reported to be low when compiling the R package through build_r.R in Windows

[Vinnish-A]

On my Windows PC, my cmake version is 3.30

PS F:\0Local\project\LightGBM> cmake --version
cmake version 3.30.2

CMake suite maintained and supported by Kitware (kitware.com/cmake).

However, when running Rscript build_r.R --use-gpu --opencl-library="C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v11.8/lib/x64/OpenCL.lib" --boost-librarydir=G:/boost_1_85_0/lib64-msvc-14.3 command, it prompts that my cmake version is too low.

PS F:\0Local\project\LightGBM> Rscript build_r.R  --use-gpu  --opencl-library="C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v11.8/lib/x64/OpenCL.lib"  --boost-librarydir=G:/boost_1_85_0/lib64-msvc-14.3
Warning message:
In readLines(DESCRIPTION_FILE) :
  incomplete final line found on 'F:/0Local/project/LightGBM/lightgbm_r/DESCRIPTION'
* checking for file 'F:/0Local/project/LightGBM/lightgbm_r/DESCRIPTION' ... OK
* preparing 'lightgbm':
* checking DESCRIPTION meta-information ... OK
* cleaning src
* installing the package to build vignettes
      -----------------------------------
* installing *source* package 'lightgbm' ...
** using staged installation
** libs
installing via 'install.libs.R' to C:/Users/vinnish/AppData/Local/Temp/RtmpGQya0t/Rinst56cc3ebf1eaa/00LOCK-lightgbm/00new/lightgbm
Trying 'Visual Studio 17 2022'
-- Configuring incomplete, errors occurred!
CMake Error at CMakeLists.txt:26 (cmake_minimum_required):
  CMake 3.28 or higher is required.  You are running version 3.24.3


Trying 'Visual Studio 16 2019'
-- Configuring incomplete, errors occurred!
CMake Error at CMakeLists.txt:26 (cmake_minimum_required):
  CMake 3.28 or higher is required.  You are running version 3.24.3


Trying 'Visual Studio 15 2017'
-- Configuring incomplete, errors occurred!
CMake Error at CMakeLists.txt:26 (cmake_minimum_required):
  CMake 3.28 or higher is required.  You are running version 3.24.3


Trying 'Visual Studio 14 2015'
-- Configuring incomplete, errors occurred!
CMake Error at CMakeLists.txt:26 (cmake_minimum_required):
  CMake 3.28 or higher is required.  You are running version 3.24.3


Warning in eval(ei, envir) :
  Building with Visual Studio failed. Attempting with MSYS2
CMake Error: Error: generator : MSYS Makefiles
Does not match the generator used previously: Visual Studio 14 2015
Either remove the CMakeCache.txt file and CMakeFiles directory or choose a different binary directory.
CMake Error: Error: generator : MSYS Makefiles
Does not match the generator used previously: Visual Studio 14 2015
Either remove the CMakeCache.txt file and CMakeFiles directory or choose a different binary directory.
Error in .run_shell_command("cmake", c(cmake_args, "..")) :
  Command failed with exit code: 1
* removing 'C:/Users/vinnish/AppData/Local/Temp/RtmpGQya0t/Rinst56cc3ebf1eaa/lightgbm'
      -----------------------------------
ERROR: package installation failed
Error in .run_shell_command("R", r_build_args) :
  Command failed with exit code: 1
Execution halted

[jameslamb]

Thanks for using {lightgbm}, sorry about that!

To work around it, change this line to 3.18 in your local copy of LightGBM (should work for you, as the only newer CMake features we've added do not affect the R build):

LightGBM/CMakeLists.txt

Line 26 in 9a76aae

cmake_minimum_required(VERSION 3.28)

• What version of R and Rtools do you have?
• what does this print?

  •  Rscript -e "print(Sys.which('cmake'))"

I hadn't considered this in #6550 (comment) ... R builds might end up finding the CMake that's bundled with Rtools, and maybe people who have an older Rtools than the ones used in LightGBM's CI will have an older CMake that's harder to update.

If you can answer those questions above, it'll help us debug this.

[Arup-Chauhan]

@jameslamb I guess the confusion might occur due to different CMake (bundled or installed external).

What we can do is,: Add a CMake version check in the build_r.R script to verify the path and version of CMake being used. This function will ensure that the correct version of CMake (3.28 or higher) is detected before the build process begins.

If an outdated or bundled version is found, users will be prompted to update CMake or specify the correct path, preventing build failures related to CMake compatibility.

I have not tried this out but maybe this could work?

[jameslamb]

Thanks for the suggestion, but I don't want to add more complexity to build_r.R to get behavior that CMake already provides.

Let's wait to hear the answers to the questions I asked before jumping to an implementation.

[Arup-Chauhan]

Thanks for the suggestion, but I don't want to add more complexity to build_r.R to get behavior that CMake already provides.

Let's wait to hear the answers to the questions I asked before jumping to an implementation.

Hi @jameslamb understandable, would keep a lookout on this issue.

[Vinnish-A]

Thank you for your generous reply!

1. I' m using R4.3.1 and RTools43, here' s my session infomation.

PS F:\0Local\project\LightGBM> Rscript -e "sessionInfo()"
R version 4.3.1 (2023-06-16 ucrt)
Platform: x86_64-w64-mingw32/x64 (64-bit)
Running under: Windows 11 x64 (build 22631)

Matrix products: default


locale:
[1] LC_COLLATE=Chinese (Simplified)_China.utf8
[2] LC_CTYPE=Chinese (Simplified)_China.utf8
[3] LC_MONETARY=Chinese (Simplified)_China.utf8
[4] LC_NUMERIC=C
[5] LC_TIME=Chinese (Simplified)_China.utf8

time zone: Asia/Shanghai
tzcode source: internal

attached base packages:
[1] stats     graphics  grDevices utils     datasets  methods   base

other attached packages:
[1] paperTools_0.1.0

loaded via a namespace (and not attached):
 [1] compiler_4.3.1  magrittr_2.0.3  cli_3.6.1       tools_4.3.1
 [5] pillar_1.9.0    glue_1.6.2      tibble_3.2.1    utf8_1.2.4
 [9] fansi_1.0.5     vctrs_0.6.4     stringi_1.8.2   stringr_1.5.1
[13] lifecycle_1.0.4 pkgconfig_2.0.3 rlang_1.1.3     purrr_1.0.2

2. The running result in the command line is as follows:

PS F:\0Local\project\LightGBM> Rscript -e "print(Sys.which('cmake'))"
                                       cmake
"C:\\rtools43\\X86_64~1.POS\\bin\\cmake.exe"

3. After modifying the relevant content in the CMakeLists.txt file to cmake_minimum_required(VERSION 3.18), run the same commands to build, errors are:

log.txt

[Vinnish-A]

By using pip install lightgbm --config-settings=cmake.define.USE_GPU=ON --config-settings=cmake.define.OpenCL_INCLUDE_DIR="C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v11.8/include" --config-settings=cmake.define.Boost_ROOT="G:\boost_1_85_0" --config-settings=cmake.define.BOOST_LIBRARYDIR="G:\boost_1_85_0\lib64-msvc-14.3", I successfully built lightgbm in python.

But Rscript build_r.R --use-gpu --opencl-include-dir="C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v11.8/include" --opencl-library="C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v11.8/lib/x64/OpenCL.lib" --boost-librarydir="G:/boost_1_85_0/lib64-msvc-14.3" --boost-root="G:\boost_1_85_0" remained error.

[jameslamb]

Thanks for that!

Can you please try installing the latest rtools43 from https://cran.r-project.org/bin/windows/Rtools/rtools43/rtools.html and try again?

According to https://cran.r-project.org/bin/windows/Rtools/rtools43/news.html, the latest release of rtools43 contains CMake 3.28.1:

These packages have been updated:
...
cmake-host 3.24.3 to 3.28.1
...

That'd be new enough to compile the latest development version of LightGBM.

[Vinnish-A]

Thank you for your reply. I have reinstalled the latest version of rtools43 and passed the check with cmake minimum version 3.28. Now when I rerun Rscript build_r.R --no-build-vignettes --use-gpu --opencl-include-dir="C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v11.8/include" --opencl-library="C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v11.8/lib/x64/OpenCL.lib" --boost-librarydir="G:/boost_1_85_0/lib64-msvc-14.3" --boost-root="G:\boost_1_85_0", the error message is as follows:

log2.txt

These two issues are troubling me. Do I not need to install Boost externally? The specified path is not working.

-- Found Boost: C:/rtools43/x86_64-w64-mingw32.static.posix/lib/cmake/Boost-1.84.0/BoostConfig.cmake (found suitable version "1.84.0", minimum required is "1.56.0") found components: filesystem system
... ...
CMake Warning:
  Manually-specified variables were not used by the project:

    BOOST_LIBRARYDIR

[jameslamb]

Do I not need to install Boost externally?

You do not need to install it externally. It's provided as a git submodule here.

Could you try this?

git submodule update --init --recursive
Rscript build_r.R --use-gpu

If that succeeds, then we'll know that the issue you're facing has something to do with passing a custom Boost to the R build. And if that's true, we'll probably close this report and ask you to subscribe to #5960.

the error message is as follows:

Thanks for that, but the contents of that file are a bit difficult for me to read (in a text editor on my Mac).

Are the error messages you see the same ones reported at #6537?

[Vinnish-A]

Thanks for your reply!

git submodule update --init --recursive
Rscript build_r.R --use-gpu

I tried this, and it didn' t work.

And I have checked issue #6537. It seems we got the same error!