"src/vscode:/vscode.git/clone" did not exist on "e55c815821f0abbb23d52a391a622a2c96e6ba14"
README.rst 2.97 KB
Newer Older
Guolin Ke's avatar
Guolin Ke committed
1
2
3
LightGBM Python Package
=======================

Guolin Ke's avatar
Guolin Ke committed
4
5
6
|PyPI version|


Guolin Ke's avatar
Guolin Ke committed
7
8
9
Installation
------------

Guolin Ke's avatar
Guolin Ke committed
10
11
12
Preparation
'''''''''''

Guolin Ke's avatar
Guolin Ke committed
13
`setuptools <https://pypi.python.org/pypi/setuptools>`_ is needed. 
Guolin Ke's avatar
Guolin Ke committed
14
15
16
17
18
19
20
21

For Mac OS X users, gcc with OpenMP support must be installed first. Refer to `wiki <https://github.com/Microsoft/LightGBM/wiki/Installation-Guide#osx>`_ for installing gcc with OpenMP support.

Note: 32-bit python is not supported. Please install 64-bit version.

Install from pip
''''''''''''''''

Guolin Ke's avatar
Guolin Ke committed
22
23
24
25
Install `wheel <http://pythonwheels.com>`_ via ``pip install wheel`` first. For windows user, `VC runtime <https://go.microsoft.com/fwlink/?LinkId=746572>`_ is needed if Visual Studio(2015 or 2017) is not installed.

Install from wheel package:

Guolin Ke's avatar
Guolin Ke committed
26
27
``pip install lightgbm``

Guolin Ke's avatar
Guolin Ke committed
28
29
30
31
32
33
34
Install from source package:

``pip install --no-binary :all: lightgbm``

Note: Installation from source package require installing `cmake <https://cmake.org/>`_ first, and Visual Studio (or `MS Build <https://www.visualstudio.com/downloads/#build-tools-for-visual-studio-2017>`_) is needed in Windows. 

For the MinGW build in Windows or GPU support, please install the latest version from GitHub.
Guolin Ke's avatar
Guolin Ke committed
35

Guolin Ke's avatar
Guolin Ke committed
36
37
Install from GitHub
'''''''''''''''''''
Guolin Ke's avatar
Guolin Ke committed
38

Guolin Ke's avatar
Guolin Ke committed
39
40
Installation from GitHub require installing `cmake <https://cmake.org/>`_ first, and Visual Studio (or `MS Build <https://www.visualstudio.com/downloads/#build-tools-for-visual-studio-2017>`_) is needed in Windows.

Guolin Ke's avatar
Guolin Ke committed
41
42
43
44
45
46
.. code:: sh

    git clone --recursive https://github.com/Microsoft/LightGBM
    cd LightGBM/python-package
    python setup.py install

Guolin Ke's avatar
Guolin Ke committed
47
``sudo`` (or administrator rights in Windows) may is needed to perform ``python setup.py install``.
Guolin Ke's avatar
Guolin Ke committed
48
49
50

Use ``python setup.py install --mingw`` to use MinGW in Windows.

Guolin Ke's avatar
Guolin Ke committed
51
Use ``python setup.py install --gpu`` to enable GPU support. Boost and OpenCL are needed: details for installation can be found in `gpu-support <https://github.com/Microsoft/LightGBM/wiki/Installation-Guide#with-gpu-support>`_.
Guolin Ke's avatar
Guolin Ke committed
52
53
54
55

Examples
--------

Guolin Ke's avatar
Guolin Ke committed
56
Refer to the walk through examples in `python-guide folder <https://github.com/Microsoft/LightGBM/tree/master/examples/python-guide>`_
wxchan's avatar
wxchan committed
57
58
59


Troubleshooting
Guolin Ke's avatar
Guolin Ke committed
60
---------------
wxchan's avatar
wxchan committed
61

Guolin Ke's avatar
Guolin Ke committed
62
Refer to `FAQ <https://github.com/Microsoft/LightGBM/tree/master/docs/FAQ.md>`_ 
wxchan's avatar
wxchan committed
63
64

Developments
Guolin Ke's avatar
Guolin Ke committed
65
------------
wxchan's avatar
wxchan committed
66

Guolin Ke's avatar
Guolin Ke committed
67
The code style of python package follows `pep8 <https://www.python.org/dev/peps/pep-0008/>`_. 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:
wxchan's avatar
wxchan committed
68

69
- E1 Indentation (check pep8 link above)
wxchan's avatar
wxchan committed
70
71
72
73
74
75
76
- E202 whitespace before and after brackets
- E225 missing whitespace around operator
- E226 missing whitespace around arithmetic operator
- E261 at least two spaces before inline comment
- E301 expected 1 blank line in front of and at the end of a method
- E302 expected 2 blank lines in front of and at the end of a function or a class

Guolin Ke's avatar
Guolin Ke committed
77
E501 can be ignored (line too long).
Guolin Ke's avatar
Guolin Ke committed
78
79
80

.. |PyPI version| image:: https://badge.fury.io/py/lightgbm.svg
    :target: https://badge.fury.io/py/lightgbm