Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize the installation documents. #6877

Merged
merged 8 commits into from
Apr 21, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions doc/build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Building From Source
####################

This page gives instructions on how to build and install XGBoost from scratch on various
This page gives instructions on how to build and install XGBoost from the source code on various
systems. If the instructions do not work for you, please feel free to ask questions at
`the user forum <https://discuss.xgboost.ai>`_.

Expand Down Expand Up @@ -44,7 +44,8 @@ This section describes the procedure to build the shared library and CLI interfa
independently. For building language specific package, see corresponding sections in this
document.

- On Linux/OSX the target library is ``libxgboost.so``
- On Linux and other UNIX-like systems, the target library is ``libxgboost.so``
- On MacOS, the target library is ``libxgboost.dylib``
- On Windows the target library is ``xgboost.dll``

This shared library is used by different language bindings (with some additions depending
Expand All @@ -56,10 +57,10 @@ on the binding you choose). The minimal building requirement is
For a list of CMake options like GPU support, see ``#-- Options`` in CMakeLists.txt on top
level of source tree.

Building on Linux distributions
Building on Linux and other UNIX-like systems
===============================
trivialfis marked this conversation as resolved.
Show resolved Hide resolved

On Ubuntu, after obtaining the source code, one builds XGBoost by running CMake:
After obtaining the source code, one builds XGBoost by running CMake:

.. code-block:: bash

Expand All @@ -69,10 +70,10 @@ On Ubuntu, after obtaining the source code, one builds XGBoost by running CMake:
cmake ..
make -j$(nproc)

Building on OSX
Building on MacOS
===============
trivialfis marked this conversation as resolved.
Show resolved Hide resolved

Obtain ``libomp`` from Homebrew:
Obtain ``libomp`` from `Homebrew <https://brew.sh/>`_:

.. code-block:: bash

Expand Down Expand Up @@ -447,7 +448,7 @@ You might find the exact location by running ``.libPaths()`` in R GUI or RStudio
Building JVM Packages
*********************

Building XGBoost4J using Maven requires Maven 3 or newer, Java 7+ and CMake 3.13+ for compiling the JNI bindings.
Building XGBoost4J using Maven requires Maven 3 or newer, Java 7+ and CMake 3.13+ for compiling Java code as well as the Java Native Interface (JNI) bindings.

Before you install XGBoost4J, you need to define environment variable ``JAVA_HOME`` as your JDK directory to ensure that your compiler can find ``jni.h`` correctly, since XGBoost4J relies on JNI to implement the interaction between the JVM and native libraries.

Expand Down
11 changes: 5 additions & 6 deletions doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ XGBoost provides binary packages for some language bindings. The binary package
the GPU algorithm (``gpu_hist``) on machines with NVIDIA GPUs. Please note that **training
with multiple GPUs is only supported for Linux platform**. See :doc:`gpu/index`. Also we
have both stable releases and nightly builds, see below for how to install them. For
building from source, checkout :doc:`here </build>`.
building from source, visit :doc:`this page </build>`.

.. contents:: Contents

Expand All @@ -16,8 +16,7 @@ Stable Release
Python
------

Pre-built binary are uploaded to Pypi for each release. Supported platforms are Linux
with x86_64, aarch, Windows x86_64 and OSX.
Pre-built binary are uploaded to PyPI (Python Package Index) for each release. Supported platforms are Linux (x86_64, aarch64), Windows (x86_64) and MacOS (x86_64).

.. code-block:: bash

Expand All @@ -37,7 +36,7 @@ into permission errors. Python pre-built binary capability for each platform:
+-------------------+---------+----------------------+
| Linux aarch64 | |cross| | |cross| |
+-------------------+---------+----------------------+
| OSX | |cross| | |cross| |
| MacOS | |cross| | |cross| |
+-------------------+---------+----------------------+
| Windows | |tick| | |cross| |
+-------------------+---------+----------------------+
Expand Down Expand Up @@ -69,7 +68,7 @@ R
.. code-block:: bash

# Install dependencies
R -q -e "install.packages(c('data.table', 'magrittr', 'jsonlite', 'remotes'))"
R -q -e "install.packages(c('data.table', 'magrittr', 'jsonlite'))"
# Install XGBoost
R CMD INSTALL ./xgboost_r_gpu_linux.tar.gz

Expand Down Expand Up @@ -129,7 +128,7 @@ Python
------

Nightly builds are available. You can go to `this page <https://s3-us-west-2.amazonaws.com/xgboost-nightly-builds/list.html>`_,
find the wheel with the commit id you want and install it with pip:
find the wheel with the commit ID you want and install it with pip:

.. code-block:: bash

Expand Down