From 66cb4afc6cce10a81088d9eaae7ef5f87007caaa Mon Sep 17 00:00:00 2001 From: Philip Hyunsu Cho Date: Wed, 23 Mar 2022 02:20:01 -0700 Subject: [PATCH] Update install doc (#7747) --- doc/install.rst | 41 ++++++++++++++++++++++++++++------------- 1 file changed, 28 insertions(+), 13 deletions(-) diff --git a/doc/install.rst b/doc/install.rst index 222686b19..a5ffad85a 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -16,7 +16,7 @@ Stable Release Python ------ -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). +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, Apple Silicon). .. code-block:: bash @@ -29,24 +29,39 @@ into permission errors. Python pre-built binary capability for each platform: .. |tick| unicode:: U+2714 .. |cross| unicode:: U+2718 -+-------------------+---------+----------------------+ -| Platform | GPU | Multi-Node-Multi-GPU | -+===================+=========+======================+ -| Linux x86_64 | |tick| | |tick| | -+-------------------+---------+----------------------+ -| Linux aarch64 | |cross| | |cross| | -+-------------------+---------+----------------------+ -| MacOS | |cross| | |cross| | -+-------------------+---------+----------------------+ -| Windows | |tick| | |cross| | -+-------------------+---------+----------------------+ ++---------------------+---------+----------------------+ +| Platform | GPU | Multi-Node-Multi-GPU | ++=====================+=========+======================+ +| Linux x86_64 | |tick| | |tick| | ++---------------------+---------+----------------------+ +| Linux aarch64 | |cross| | |cross| | ++---------------------+---------+----------------------+ +| MacOS x86_64 | |cross| | |cross| | ++---------------------+---------+----------------------+ +| MacOS Apple Silicon | |cross| | |cross| | ++---------------------+---------+----------------------+ +| Windows | |tick| | |cross| | ++---------------------+---------+----------------------+ -If you are using **Apple Silicon**, please use the Conda packaging manager to install XGBoost: +Conda +***** + +You may use the Conda packaging manager to install XGBoost: .. code-block:: bash conda install -c conda-forge py-xgboost +Conda should be able to detect the existence of a GPU on your machine and install the correct variant of XGBoost. If you run into issues, try indicating the variant explicitly: + +.. code-block:: bash + + # CPU only + conda install -c conda-forge py-xgboost-cpu + # Use NVIDIA GPU + conda install -c conda-forge py-xgboost-gpu + + Visit the `Miniconda website `_ to obtain Conda. R