From 49a0895b81de55e4c7faef26226fcd488c92ec74 Mon Sep 17 00:00:00 2001 From: Guolin Ke Date: Sun, 25 Jun 2017 10:21:19 +0800 Subject: [PATCH] update python install doc. --- VERSION.txt | 2 +- python-package/README.rst | 27 ++++++++++++++++++--------- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/VERSION.txt b/VERSION.txt index f93ea0ca3330..6acdb442890d 100644 --- a/VERSION.txt +++ b/VERSION.txt @@ -1 +1 @@ -2.0.2 \ No newline at end of file +2.0.3 \ No newline at end of file diff --git a/python-package/README.rst b/python-package/README.rst index 1e2805b8f17b..9f12e3efb7fe 100644 --- a/python-package/README.rst +++ b/python-package/README.rst @@ -10,9 +10,7 @@ Installation Preparation ''''''''''' -You need to install `cmake `_ and `setuptools `_ first. - -For Windows users, Visual Studio (or `MS Build `_) is needed. You also can use MinGW instead if installing from GitHub. +`setuptools `_ is needed. For Mac OS X users, gcc with OpenMP support must be installed first. Refer to `wiki `_ for installing gcc with OpenMP support. @@ -21,24 +19,36 @@ Note: 32-bit python is not supported. Please install 64-bit version. Install from pip '''''''''''''''' +Install `wheel `_ via ``pip install wheel`` first. For windows user, `VC runtime `_ is needed if Visual Studio(2015 or 2017) is not installed. + +Install from wheel package: + ``pip install lightgbm`` -For the MinGW build in Windows and GPU support, please install the latest version from GitHub. +Install from source package: + +``pip install --no-binary :all: lightgbm`` + +Note: Installation from source package require installing `cmake `_ first, and Visual Studio (or `MS Build `_) is needed in Windows. + +For the MinGW build in Windows or GPU support, please install the latest version from GitHub. Install from GitHub ''''''''''''''''''' +Installation from GitHub require installing `cmake `_ first, and Visual Studio (or `MS Build `_) is needed in Windows. + .. code:: sh git clone --recursive https://github.com/Microsoft/LightGBM cd LightGBM/python-package python setup.py install -You may need to use ``sudo`` (or administrator rights in Windows) to perform ``python setup.py install``. +``sudo`` (or administrator rights in Windows) may is needed to perform ``python setup.py install``. Use ``python setup.py install --mingw`` to use MinGW in Windows. -Use ``python setup.py install --gpu`` to enable GPU support. You will need to install Boost and OpenCL first: details for installation can be found in `gpu-support `_. +Use ``python setup.py install --gpu`` to enable GPU support. Boost and OpenCL are needed: details for installation can be found in `gpu-support `_. Examples -------- @@ -54,7 +64,7 @@ Refer to `FAQ `_ Developments ------------ -The code style of python package follows `pep8 `_. If you would like to make a contribution and not familiar with pep-8, please check the pep8 style guide first. Otherwise, you won't pass the check. You should be careful about: +The code style of python package follows `pep8 `_. If you would like to make a contribution and not familiar with pep-8, please check the pep8 style guide first. Otherwise, the check won't pass. You should be careful about: - E1 Indentation (check pep8 link above) - E202 whitespace before and after brackets @@ -64,8 +74,7 @@ The code style of python package follows `pep8