Unverified Commit 94fbe5bb authored by Guolin Ke's avatar Guolin Ke Committed by GitHub
Browse files

[docs] updated Microsoft GitHub URL (#2152)

* fix travis badge

* updated GitHub Microsoft URL
parent f46f8b2a
version: 2.2.4.{build} version: 2.2.4.{build}
image: Visual Studio 2015 image: Visual Studio 2015
platform: x64 platform: x64
...@@ -44,7 +44,7 @@ test_script: ...@@ -44,7 +44,7 @@ test_script:
- pytest %APPVEYOR_BUILD_FOLDER%\tests\python_package_test - pytest %APPVEYOR_BUILD_FOLDER%\tests\python_package_test
- cd %APPVEYOR_BUILD_FOLDER%\examples\python-guide - cd %APPVEYOR_BUILD_FOLDER%\examples\python-guide
- ps: >- - ps: >-
@("import matplotlib", "matplotlib.use('Agg')") + (Get-Content "plot_example.py") | Set-Content "plot_example.py" # prevent interactive window mode @("import matplotlib", "matplotlib.use('Agg')") +(Get-Content "plot_example.py") | Set-Content"plot_example.py" # prevent interactive window mode
(Get-Content "plot_example.py").replace('graph.render(view=True)', 'graph.render(view=False)') | Set-Content "plot_example.py" (Get-Content "plot_example.py").replace('graph.render(view=True)', 'graph.render(view=False)') | Set-Content "plot_example.py"
- ps: >- - ps: >-
foreach ($file in @(Get-ChildItem *.py)) { foreach ($file in @(Get-ChildItem *.py)) {
......
...@@ -34,7 +34,7 @@ else # Linux ...@@ -34,7 +34,7 @@ else # Linux
sudo apt-get update sudo apt-get update
sudo apt-get install --no-install-recommends -y libboost1.68-dev ocl-icd-opencl-dev sudo apt-get install --no-install-recommends -y libboost1.68-dev ocl-icd-opencl-dev
cd $BUILD_DIRECTORY # to avoid permission errors cd $BUILD_DIRECTORY # to avoid permission errors
wget -q https://github.com/Microsoft/LightGBM/releases/download/v2.0.12/AMD-APP-SDKInstaller-v3.0.130.136-GA-linux64.tar.bz2 wget -q https://github.com/microsoft/LightGBM/releases/download/v2.0.12/AMD-APP-SDKInstaller-v3.0.130.136-GA-linux64.tar.bz2
tar -xjf AMD-APP-SDK*.tar.bz2 tar -xjf AMD-APP-SDK*.tar.bz2
mkdir -p $OPENCL_VENDOR_PATH mkdir -p $OPENCL_VENDOR_PATH
mkdir -p $AMDAPPSDK_PATH mkdir -p $AMDAPPSDK_PATH
......
...@@ -34,8 +34,8 @@ if __name__ == "__main__": ...@@ -34,8 +34,8 @@ if __name__ == "__main__":
<version>%s</version> <version>%s</version>
<authors>Guolin Ke</authors> <authors>Guolin Ke</authors>
<owners>Guolin Ke</owners> <owners>Guolin Ke</owners>
<licenseUrl>https://github.com/Microsoft/LightGBM/blob/master/LICENSE</licenseUrl> <licenseUrl>https://github.com/microsoft/LightGBM/blob/master/LICENSE</licenseUrl>
<projectUrl>https://github.com/Microsoft/LightGBM</projectUrl> <projectUrl>https://github.com/microsoft/LightGBM</projectUrl>
<requireLicenseAcceptance>false</requireLicenseAcceptance> <requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>A fast, distributed, high performance gradient boosting framework</description> <description>A fast, distributed, high performance gradient boosting framework</description>
<copyright>Copyright %d @ Microsoft</copyright> <copyright>Copyright %d @ Microsoft</copyright>
......
...@@ -24,7 +24,7 @@ For users who wants to install online with GPU or want to choose a specific comp ...@@ -24,7 +24,7 @@ For users who wants to install online with GPU or want to choose a specific comp
#### Mac OS Preparation #### Mac OS Preparation
You can perform installation either with **Apple Clang** or **gcc**. In case you prefer **Apple Clang**, you should install **OpenMP** (details for installation can be found in [Installation Guide](https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#apple-clang)) first and **CMake** version 3.12 or higher is required. In case you prefer **gcc**, you need to install it (details for installation can be found in [Installation Guide](https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#gcc)) and set some environment variables to tell R to use `gcc` and `g++`. If you install these from Homebrew, your versions of `g++` and `gcc` are most likely in `/usr/local/bin`, as shown below. You can perform installation either with **Apple Clang** or **gcc**. In case you prefer **Apple Clang**, you should install **OpenMP** (details for installation can be found in [Installation Guide](https://github.com/microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#apple-clang)) first and **CMake** version 3.12 or higher is required. In case you prefer **gcc**, you need to install it (details for installation can be found in [Installation Guide](https://github.com/microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#gcc)) and set some environment variables to tell R to use `gcc` and `g++`. If you install these from Homebrew, your versions of `g++` and `gcc` are most likely in `/usr/local/bin`, as shown below.
``` ```
# replace 8 with version of gcc installed on your machine # replace 8 with version of gcc installed on your machine
...@@ -36,7 +36,7 @@ export CXX=/usr/local/bin/g++-8 CC=/usr/local/bin/gcc-8 ...@@ -36,7 +36,7 @@ export CXX=/usr/local/bin/g++-8 CC=/usr/local/bin/gcc-8
Build and install R-package with the following commands: Build and install R-package with the following commands:
```sh ```sh
git clone --recursive https://github.com/Microsoft/LightGBM git clone --recursive https://github.com/microsoft/LightGBM
cd LightGBM cd LightGBM
Rscript build_r.R Rscript build_r.R
``` ```
...@@ -47,7 +47,7 @@ Note: for the build with Visual Studio/VS Build Tools in Windows, you should use ...@@ -47,7 +47,7 @@ Note: for the build with Visual Studio/VS Build Tools in Windows, you should use
Windows users may need to run with administrator rights (either R or the command prompt, depending on the way you are installing this package). Linux users might require the appropriate user write permissions for packages. Windows users may need to run with administrator rights (either R or the command prompt, depending on the way you are installing this package). Linux users might require the appropriate user write permissions for packages.
Set `use_gpu` to `TRUE` in `R-package/src/install.libs.R` to enable the build with GPU support. You will need to install Boost and OpenCL first: details for installation can be found in [Installation-Guide](https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version). Set `use_gpu` to `TRUE` in `R-package/src/install.libs.R` to enable the build with GPU support. You will need to install Boost and OpenCL first: details for installation can be found in [Installation-Guide](https://github.com/microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#build-gpu-version).
If you are using a precompiled dll/lib locally, you can move the dll/lib into LightGBM root folder, modify `LightGBM/R-package/src/install.libs.R`'s 2nd line (change `use_precompile <- FALSE` to `use_precompile <- TRUE`), and install R-package as usual. **NOTE: If your R version is not smaller than 3.5.0, you should set `DUSE_R35=ON` in cmake options when build precompiled dll/lib**. If you are using a precompiled dll/lib locally, you can move the dll/lib into LightGBM root folder, modify `LightGBM/R-package/src/install.libs.R`'s 2nd line (change `use_precompile <- FALSE` to `use_precompile <- TRUE`), and install R-package as usual. **NOTE: If your R version is not smaller than 3.5.0, you should set `DUSE_R35=ON` in cmake options when build precompiled dll/lib**.
...@@ -89,7 +89,7 @@ For instance, you can install the R-package from LightGBM master commit of GitHu ...@@ -89,7 +89,7 @@ For instance, you can install the R-package from LightGBM master commit of GitHu
```r ```r
lgb.dl(commit = "master", lgb.dl(commit = "master",
compiler = "vs", compiler = "vs",
repo = "https://github.com/Microsoft/LightGBM") repo = "https://github.com/microsoft/LightGBM")
``` ```
You may also install using a precompiled dll/lib using the following from R: You may also install using a precompiled dll/lib using the following from R:
...@@ -97,7 +97,7 @@ You may also install using a precompiled dll/lib using the following from R: ...@@ -97,7 +97,7 @@ You may also install using a precompiled dll/lib using the following from R:
```r ```r
lgb.dl(commit = "master", lgb.dl(commit = "master",
libdll = "C:\\LightGBM\\windows\\x64\\DLL\\lib_lightgbm.dll", # YOUR PRECOMPILED DLL libdll = "C:\\LightGBM\\windows\\x64\\DLL\\lib_lightgbm.dll", # YOUR PRECOMPILED DLL
repo = "https://github.com/Microsoft/LightGBM") repo = "https://github.com/microsoft/LightGBM")
``` ```
You may also install online using a LightGBM with proper GPU support using Visual Studio (as an example here) using the following from R: You may also install online using a LightGBM with proper GPU support using Visual Studio (as an example here) using the following from R:
...@@ -105,13 +105,13 @@ You may also install online using a LightGBM with proper GPU support using Visua ...@@ -105,13 +105,13 @@ You may also install online using a LightGBM with proper GPU support using Visua
```r ```r
lgb.dl(commit = "master", lgb.dl(commit = "master",
compiler = "vs", # Remove this for MinGW + GPU installation compiler = "vs", # Remove this for MinGW + GPU installation
repo = "https://github.com/Microsoft/LightGBM", repo = "https://github.com/microsoft/LightGBM",
use_gpu = TRUE) use_gpu = TRUE)
``` ```
For more details about options, please check [Laurae2/lgbdl](https://github.com/Laurae2/lgbdl/) R-package. For more details about options, please check [Laurae2/lgbdl](https://github.com/Laurae2/lgbdl/) R-package.
You may also read [Microsoft/LightGBM#912](https://github.com/Microsoft/LightGBM/issues/912#issuecomment-329496254) for a visual example for LightGBM installation in Windows with Visual Studio. You may also read [Microsoft/LightGBM#912](https://github.com/microsoft/LightGBM/issues/912#issuecomment-329496254) for a visual example for LightGBM installation in Windows with Visual Studio.
Examples Examples
-------- --------
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
# In the case of many trainings (like 100+ models), RAM will be eaten very quickly # In the case of many trainings (like 100+ models), RAM will be eaten very quickly
# Therefore, it is essential to know a strategy to deal with such issue # Therefore, it is essential to know a strategy to deal with such issue
# More results can be found here: https://github.com/Microsoft/LightGBM/issues/879#issuecomment-326656580 # More results can be found here: https://github.com/microsoft/LightGBM/issues/879#issuecomment-326656580
# Quote: "@Laurae2 Thanks for nice easily reproducible example (unlike mine). # Quote: "@Laurae2 Thanks for nice easily reproducible example (unlike mine).
# With reset=FALSE you get after 500 iterations (not 1000): OS reports 27GB usage, while R gc() reports 1.5GB. # With reset=FALSE you get after 500 iterations (not 1000): OS reports 27GB usage, while R gc() reports 1.5GB.
# Just doing reset=TRUE will already improve things: OS reports 4.6GB. # Just doing reset=TRUE will already improve things: OS reports 4.6GB.
......
...@@ -19,7 +19,7 @@ valids <- list(train = dtrain, test = dtest) ...@@ -19,7 +19,7 @@ valids <- list(train = dtrain, test = dtest)
# Method 1 of training with built-in multiclass objective # Method 1 of training with built-in multiclass objective
# Note: need to turn off boost from average to match custom objective # Note: need to turn off boost from average to match custom objective
# (https://github.com/Microsoft/LightGBM/issues/1846) # (https://github.com/microsoft/LightGBM/issues/1846)
model_builtin <- lgb.train(list(), model_builtin <- lgb.train(list(),
dtrain, dtrain,
boost_from_average = FALSE, boost_from_average = FALSE,
......
...@@ -3,10 +3,10 @@ LightGBM, Light Gradient Boosting Machine ...@@ -3,10 +3,10 @@ LightGBM, Light Gradient Boosting Machine
[![Azure Pipelines Build Status](https://lightgbm-ci.visualstudio.com/lightgbm-ci/_apis/build/status/Microsoft.LightGBM?branchName=master)](https://lightgbm-ci.visualstudio.com/lightgbm-ci/_build/latest?definitionId=1) [![Azure Pipelines Build Status](https://lightgbm-ci.visualstudio.com/lightgbm-ci/_apis/build/status/Microsoft.LightGBM?branchName=master)](https://lightgbm-ci.visualstudio.com/lightgbm-ci/_build/latest?definitionId=1)
[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/1ys5ot401m0fep6l/branch/master?svg=true)](https://ci.appveyor.com/project/guolinke/lightgbm/branch/master) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/1ys5ot401m0fep6l/branch/master?svg=true)](https://ci.appveyor.com/project/guolinke/lightgbm/branch/master)
[![Travis Build Status](https://travis-ci.org/Microsoft/LightGBM.svg?branch=master)](https://travis-ci.org/Microsoft/LightGBM) [![Travis Build Status](https://travis-ci.org/microsoft/LightGBM.svg?branch=master)](https://travis-ci.org/microsoft/LightGBM)
[![Documentation Status](https://readthedocs.org/projects/lightgbm/badge/?version=latest)](https://lightgbm.readthedocs.io/) [![Documentation Status](https://readthedocs.org/projects/lightgbm/badge/?version=latest)](https://lightgbm.readthedocs.io/)
[![GitHub Issues](https://img.shields.io/github/issues/Microsoft/LightGBM.svg)](https://github.com/Microsoft/LightGBM/issues) [![GitHub Issues](https://img.shields.io/github/issues/Microsoft/LightGBM.svg)](https://github.com/microsoft/LightGBM/issues)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Microsoft/LightGBM/blob/master/LICENSE) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/microsoft/LightGBM/blob/master/LICENSE)
[![Python Versions](https://img.shields.io/pypi/pyversions/lightgbm.svg)](https://pypi.org/project/lightgbm) [![Python Versions](https://img.shields.io/pypi/pyversions/lightgbm.svg)](https://pypi.org/project/lightgbm)
[![PyPI Version](https://img.shields.io/pypi/v/lightgbm.svg)](https://pypi.org/project/lightgbm) [![PyPI Version](https://img.shields.io/pypi/v/lightgbm.svg)](https://pypi.org/project/lightgbm)
[![Join the chat at https://gitter.im/Microsoft/LightGBM](https://badges.gitter.im/Microsoft/LightGBM.svg)](https://gitter.im/Microsoft/LightGBM?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Join the chat at https://gitter.im/Microsoft/LightGBM](https://badges.gitter.im/Microsoft/LightGBM.svg)](https://gitter.im/Microsoft/LightGBM?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
...@@ -20,11 +20,11 @@ LightGBM is a gradient boosting framework that uses tree based learning algorith ...@@ -20,11 +20,11 @@ LightGBM is a gradient boosting framework that uses tree based learning algorith
- Support of parallel and GPU learning. - Support of parallel and GPU learning.
- Capable of handling large-scale data. - Capable of handling large-scale data.
For further details, please refer to [Features](https://github.com/Microsoft/LightGBM/blob/master/docs/Features.rst). For further details, please refer to [Features](https://github.com/microsoft/LightGBM/blob/master/docs/Features.rst).
Benefitting from these advantages, LightGBM is being widely-used in many [winning solutions](https://github.com/Microsoft/LightGBM/blob/master/examples/README.md#machine-learning-challenge-winning-solutions) of machine learning competitions. Benefitting from these advantages, LightGBM is being widely-used in many [winning solutions](https://github.com/microsoft/LightGBM/blob/master/examples/README.md#machine-learning-challenge-winning-solutions) of machine learning competitions.
[Comparison experiments](https://github.com/Microsoft/LightGBM/blob/master/docs/Experiments.rst#comparison-experiment) on public datasets show that LightGBM can outperform existing boosting frameworks on both efficiency and accuracy, with significantly lower memory consumption. What's more, [parallel experiments](https://github.com/Microsoft/LightGBM/blob/master/docs/Experiments.rst#parallel-experiment) show that LightGBM can achieve a linear speed-up by using multiple machines for training in specific settings. [Comparison experiments](https://github.com/microsoft/LightGBM/blob/master/docs/Experiments.rst#comparison-experiment) on public datasets show that LightGBM can outperform existing boosting frameworks on both efficiency and accuracy, with significantly lower memory consumption. What's more, [parallel experiments](https://github.com/microsoft/LightGBM/blob/master/docs/Experiments.rst#parallel-experiment) show that LightGBM can achieve a linear speed-up by using multiple machines for training in specific settings.
News News
---- ----
...@@ -45,13 +45,13 @@ News ...@@ -45,13 +45,13 @@ News
02/12/2017 : LightGBM v1 stable release. 02/12/2017 : LightGBM v1 stable release.
01/08/2017 : Release [**R-package**](https://github.com/Microsoft/LightGBM/tree/master/R-package) beta version, welcome to have a try and provide feedback. 01/08/2017 : Release [**R-package**](https://github.com/microsoft/LightGBM/tree/master/R-package) beta version, welcome to have a try and provide feedback.
12/05/2016 : **Categorical Features as input directly** (without one-hot coding). 12/05/2016 : **Categorical Features as input directly** (without one-hot coding).
12/02/2016 : Release [**Python-package**](https://github.com/Microsoft/LightGBM/tree/master/python-package) beta version, welcome to have a try and provide feedback. 12/02/2016 : Release [**Python-package**](https://github.com/microsoft/LightGBM/tree/master/python-package) beta version, welcome to have a try and provide feedback.
More detailed update logs : [Key Events](https://github.com/Microsoft/LightGBM/blob/master/docs/Key-Events.md). More detailed update logs : [Key Events](https://github.com/microsoft/LightGBM/blob/master/docs/Key-Events.md).
External (Unofficial) Repositories External (Unofficial) Repositories
---------------------------------- ----------------------------------
...@@ -77,22 +77,22 @@ Dask-LightGBM (distributed and parallel Python-package): https://github.com/dask ...@@ -77,22 +77,22 @@ Dask-LightGBM (distributed and parallel Python-package): https://github.com/dask
Get Started and Documentation Get Started and Documentation
----------------------------- -----------------------------
Install by following [guide](https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst) for the command line program, [Python-package](https://github.com/Microsoft/LightGBM/tree/master/python-package) or [R-package](https://github.com/Microsoft/LightGBM/tree/master/R-package). Then please see the [Quick Start](https://github.com/Microsoft/LightGBM/blob/master/docs/Quick-Start.rst) guide. Install by following [guide](https://github.com/microsoft/LightGBM/blob/master/docs/Installation-Guide.rst) for the command line program, [Python-package](https://github.com/microsoft/LightGBM/tree/master/python-package) or [R-package](https://github.com/microsoft/LightGBM/tree/master/R-package). Then please see the [Quick Start](https://github.com/microsoft/LightGBM/blob/master/docs/Quick-Start.rst) guide.
Our primary documentation is at https://lightgbm.readthedocs.io/ and is generated from this repository. Our primary documentation is at https://lightgbm.readthedocs.io/ and is generated from this repository.
Next you may want to read: Next you may want to read:
* [**Examples**](https://github.com/Microsoft/LightGBM/tree/master/examples) showing command line usage of common tasks. * [**Examples**](https://github.com/microsoft/LightGBM/tree/master/examples) showing command line usage of common tasks.
* [**Features**](https://github.com/Microsoft/LightGBM/blob/master/docs/Features.rst) and algorithms supported by LightGBM. * [**Features**](https://github.com/microsoft/LightGBM/blob/master/docs/Features.rst) and algorithms supported by LightGBM.
* [**Parameters**](https://github.com/Microsoft/LightGBM/blob/master/docs/Parameters.rst) is an exhaustive list of customization you can make. * [**Parameters**](https://github.com/microsoft/LightGBM/blob/master/docs/Parameters.rst) is an exhaustive list of customization you can make.
* [**Parallel Learning**](https://github.com/Microsoft/LightGBM/blob/master/docs/Parallel-Learning-Guide.rst) and [**GPU Learning**](https://github.com/Microsoft/LightGBM/blob/master/docs/GPU-Tutorial.rst) can speed up computation. * [**Parallel Learning**](https://github.com/microsoft/LightGBM/blob/master/docs/Parallel-Learning-Guide.rst) and [**GPU Learning**](https://github.com/microsoft/LightGBM/blob/master/docs/GPU-Tutorial.rst) can speed up computation.
* [**Laurae++ interactive documentation**](https://sites.google.com/view/lauraepp/parameters) is a detailed guide for hyperparameters. * [**Laurae++ interactive documentation**](https://sites.google.com/view/lauraepp/parameters) is a detailed guide for hyperparameters.
Documentation for contributors: Documentation for contributors:
* [**How we update readthedocs.io**](https://github.com/Microsoft/LightGBM/blob/master/docs/README.rst). * [**How we update readthedocs.io**](https://github.com/microsoft/LightGBM/blob/master/docs/README.rst).
* Check out the [**Development Guide**](https://github.com/Microsoft/LightGBM/blob/master/docs/Development-Guide.rst). * Check out the [**Development Guide**](https://github.com/microsoft/LightGBM/blob/master/docs/Development-Guide.rst).
Support Support
------- -------
...@@ -101,18 +101,18 @@ Support ...@@ -101,18 +101,18 @@ Support
* Discuss on the [LightGBM Gitter](https://gitter.im/Microsoft/LightGBM). * Discuss on the [LightGBM Gitter](https://gitter.im/Microsoft/LightGBM).
* Discuss on the [LightGBM Slack team](https://lightgbm.slack.com). * Discuss on the [LightGBM Slack team](https://lightgbm.slack.com).
* Use [this invite link](https://lightgbm-slack-autojoin.herokuapp.com/) to join the team. * Use [this invite link](https://lightgbm-slack-autojoin.herokuapp.com/) to join the team.
* Open **bug reports** and **feature requests** (not questions) on [GitHub issues](https://github.com/Microsoft/LightGBM/issues). * Open **bug reports** and **feature requests** (not questions) on [GitHub issues](https://github.com/microsoft/LightGBM/issues).
How to Contribute How to Contribute
----------------- -----------------
LightGBM has been developed and used by many active community members. Your help is very valuable to make it better for everyone. LightGBM has been developed and used by many active community members. Your help is very valuable to make it better for everyone.
- Check out [call for contributions](https://github.com/Microsoft/LightGBM/issues?q=is%3Aissue+is%3Aopen+label%3Acall-for-contribution) to see what can be improved, or open an issue if you want something. - Check out [call for contributions](https://github.com/microsoft/LightGBM/issues?q=is%3Aissue+is%3Aopen+label%3Acall-for-contribution) to see what can be improved, or open an issue if you want something.
- Contribute to the [tests](https://github.com/Microsoft/LightGBM/tree/master/tests) to make it more reliable. - Contribute to the [tests](https://github.com/microsoft/LightGBM/tree/master/tests) to make it more reliable.
- Contribute to the [documents](https://github.com/Microsoft/LightGBM/tree/master/docs) to make it clearer for everyone. - Contribute to the [documents](https://github.com/microsoft/LightGBM/tree/master/docs) to make it clearer for everyone.
- Contribute to the [examples](https://github.com/Microsoft/LightGBM/tree/master/examples) to share your experience with other users. - Contribute to the [examples](https://github.com/microsoft/LightGBM/tree/master/examples) to share your experience with other users.
- Add your stories and experience to [Awesome LightGBM](https://github.com/Microsoft/LightGBM/blob/master/examples/README.md). - Add your stories and experience to [Awesome LightGBM](https://github.com/microsoft/LightGBM/blob/master/examples/README.md).
- Open issue if you met problems during development. - Open issue if you met problems during development.
Microsoft Open Source Code of Conduct Microsoft Open Source Code of Conduct
...@@ -132,4 +132,4 @@ Huan Zhang, Si Si and Cho-Jui Hsieh. "[GPU Acceleration for Large-scale Tree Boo ...@@ -132,4 +132,4 @@ Huan Zhang, Si Si and Cho-Jui Hsieh. "[GPU Acceleration for Large-scale Tree Boo
License License
------- -------
This project is licensed under the terms of the MIT license. See [LICENSE](https://github.com/Microsoft/LightGBM/blob/master/LICENSE) for additional details. This project is licensed under the terms of the MIT license. See [LICENSE](https://github.com/microsoft/LightGBM/blob/master/LICENSE) for additional details.
...@@ -82,7 +82,7 @@ RUN conda create -q -n py3 python=3.5 mkl numpy scipy scikit-learn jupyter noteb ...@@ -82,7 +82,7 @@ RUN conda create -q -n py3 python=3.5 mkl numpy scipy scikit-learn jupyter noteb
################################################################################################################# #################################################################################################################
RUN cd /usr/local/src && mkdir lightgbm && cd lightgbm && \ RUN cd /usr/local/src && mkdir lightgbm && cd lightgbm && \
git clone --recursive https://github.com/Microsoft/LightGBM && \ git clone --recursive https://github.com/microsoft/LightGBM && \
cd LightGBM && mkdir build && cd build && \ cd LightGBM && mkdir build && cd build && \
cmake -DUSE_GPU=1 -DOpenCL_LIBRARY=/usr/local/cuda/lib64/libOpenCL.so -DOpenCL_INCLUDE_DIR=/usr/local/cuda/include/ .. && \ cmake -DUSE_GPU=1 -DOpenCL_LIBRARY=/usr/local/cuda/lib64/libOpenCL.so -DOpenCL_INCLUDE_DIR=/usr/local/cuda/include/ .. && \
make OPENCL_HEADERS=/usr/local/cuda-8.0/targets/x86_64-linux/include LIBOPENCL=/usr/local/cuda-8.0/targets/x86_64-linux/lib make OPENCL_HEADERS=/usr/local/cuda-8.0/targets/x86_64-linux/include LIBOPENCL=/usr/local/cuda-8.0/targets/x86_64-linux/lib
......
...@@ -73,16 +73,16 @@ Refer to `docs README <./README.rst>`__. ...@@ -73,16 +73,16 @@ Refer to `docs README <./README.rst>`__.
C API C API
----- -----
Refer to `C API <./C-API.rst>`__ or the comments in `c\_api.h <https://github.com/Microsoft/LightGBM/blob/master/include/LightGBM/c_api.h>`__ file, from which the documentation is generated. Refer to `C API <./C-API.rst>`__ or the comments in `c\_api.h <https://github.com/microsoft/LightGBM/blob/master/include/LightGBM/c_api.h>`__ file, from which the documentation is generated.
High Level Language Package High Level Language Package
--------------------------- ---------------------------
See the implementations at `Python-package <https://github.com/Microsoft/LightGBM/tree/master/python-package>`__ and `R-package <https://github.com/Microsoft/LightGBM/tree/master/R-package>`__. See the implementations at `Python-package <https://github.com/microsoft/LightGBM/tree/master/python-package>`__ and `R-package <https://github.com/microsoft/LightGBM/tree/master/R-package>`__.
Questions Questions
--------- ---------
Refer to `FAQ <./FAQ.rst>`__. Refer to `FAQ <./FAQ.rst>`__.
Also feel free to open `issues <https://github.com/Microsoft/LightGBM/issues>`__ if you met problems. Also feel free to open `issues <https://github.com/microsoft/LightGBM/issues>`__ if you met problems.
...@@ -16,7 +16,7 @@ LightGBM FAQ ...@@ -16,7 +16,7 @@ LightGBM FAQ
Critical Critical
~~~~~~~~ ~~~~~~~~
Please post an issue in `Microsoft/LightGBM repository <https://github.com/Microsoft/LightGBM/issues>`__ for any Please post an issue in `Microsoft/LightGBM repository <https://github.com/microsoft/LightGBM/issues>`__ for any
LightGBM issues you encounter. For critical issues (crash, prediction error, nonsense outputs...), you may also ping a LightGBM issues you encounter. For critical issues (crash, prediction error, nonsense outputs...), you may also ping a
member of the core team according to the relevant area of expertise by mentioning them with the arobase (@) symbol: member of the core team according to the relevant area of expertise by mentioning them with the arobase (@) symbol:
...@@ -65,20 +65,20 @@ LightGBM ...@@ -65,20 +65,20 @@ LightGBM
- **Question 3**: When running LightGBM on a large dataset, my computer runs out of RAM. - **Question 3**: When running LightGBM on a large dataset, my computer runs out of RAM.
- **Solution 3**: Multiple solutions: set the ``histogram_pool_size`` parameter to the MB you want to use for LightGBM (histogram\_pool\_size + dataset size = approximately RAM used), - **Solution 3**: Multiple solutions: set the ``histogram_pool_size`` parameter to the MB you want to use for LightGBM (histogram\_pool\_size + dataset size = approximately RAM used),
lower ``num_leaves`` or lower ``max_bin`` (see `Microsoft/LightGBM#562 <https://github.com/Microsoft/LightGBM/issues/562>`__). lower ``num_leaves`` or lower ``max_bin`` (see `Microsoft/LightGBM#562 <https://github.com/microsoft/LightGBM/issues/562>`__).
-------------- --------------
- **Question 4**: I am using Windows. Should I use Visual Studio or MinGW for compiling LightGBM? - **Question 4**: I am using Windows. Should I use Visual Studio or MinGW for compiling LightGBM?
- **Solution 4**: Visual Studio `performs best for LightGBM <https://github.com/Microsoft/LightGBM/issues/542>`__. - **Solution 4**: Visual Studio `performs best for LightGBM <https://github.com/microsoft/LightGBM/issues/542>`__.
-------------- --------------
- **Question 5**: When using LightGBM GPU, I cannot reproduce results over several runs. - **Question 5**: When using LightGBM GPU, I cannot reproduce results over several runs.
- **Solution 5**: This is normal and expected behaviour, but you may try to use ``gpu_use_dp = true`` for reproducibility - **Solution 5**: This is normal and expected behaviour, but you may try to use ``gpu_use_dp = true`` for reproducibility
(see `Microsoft/LightGBM#560 <https://github.com/Microsoft/LightGBM/pull/560#issuecomment-304561654>`__). (see `Microsoft/LightGBM#560 <https://github.com/microsoft/LightGBM/pull/560#issuecomment-304561654>`__).
You may also use the CPU version. You may also use the CPU version.
-------------- --------------
...@@ -86,7 +86,7 @@ LightGBM ...@@ -86,7 +86,7 @@ LightGBM
- **Question 6**: Bagging is not reproducible when changing the number of threads. - **Question 6**: Bagging is not reproducible when changing the number of threads.
- **Solution 6**: LightGBM bagging is multithreaded, so its output depends on the number of threads used. - **Solution 6**: LightGBM bagging is multithreaded, so its output depends on the number of threads used.
There is `no workaround currently <https://github.com/Microsoft/LightGBM/issues/632>`__. There is `no workaround currently <https://github.com/microsoft/LightGBM/issues/632>`__.
-------------- --------------
...@@ -94,14 +94,14 @@ LightGBM ...@@ -94,14 +94,14 @@ LightGBM
- **Solution 7**: This is expected behaviour for arbitrary parameters. To enable Random Forest, - **Solution 7**: This is expected behaviour for arbitrary parameters. To enable Random Forest,
you must use ``bagging_fraction`` and ``feature_fraction`` different from 1, along with a ``bagging_freq``. you must use ``bagging_fraction`` and ``feature_fraction`` different from 1, along with a ``bagging_freq``.
`This thread <https://github.com/Microsoft/LightGBM/issues/691>`__ includes an example. `This thread <https://github.com/microsoft/LightGBM/issues/691>`__ includes an example.
-------------- --------------
- **Question 8**: CPU usage is low (like 10%) in Windows when using LightGBM on very large datasets with many-core systems. - **Question 8**: CPU usage is low (like 10%) in Windows when using LightGBM on very large datasets with many-core systems.
- **Solution 8**: Please use `Visual Studio <https://visualstudio.microsoft.com/downloads/>`__ - **Solution 8**: Please use `Visual Studio <https://visualstudio.microsoft.com/downloads/>`__
as it may be `10x faster than MinGW <https://github.com/Microsoft/LightGBM/issues/749>`__ especially for very large trees. as it may be `10x faster than MinGW <https://github.com/microsoft/LightGBM/issues/749>`__ especially for very large trees.
-------------- --------------
...@@ -115,7 +115,7 @@ LightGBM ...@@ -115,7 +115,7 @@ LightGBM
- **Solution 9**: The column you're trying to pass via ``categorical_feature`` likely contains very large values. - **Solution 9**: The column you're trying to pass via ``categorical_feature`` likely contains very large values.
Categorical features in LightGBM are limited by int32 range, Categorical features in LightGBM are limited by int32 range,
so you cannot pass values that are greater than ``Int32.MaxValue`` (2147483647) as categorical features (see `Microsoft/LightGBM#1359 <https://github.com/Microsoft/LightGBM/issues/1359>`__). so you cannot pass values that are greater than ``Int32.MaxValue`` (2147483647) as categorical features (see `Microsoft/LightGBM#1359 <https://github.com/microsoft/LightGBM/issues/1359>`__).
You should convert them to integers ranging from zero to the number of categories first. You should convert them to integers ranging from zero to the number of categories first.
-------------- --------------
...@@ -145,7 +145,7 @@ LightGBM ...@@ -145,7 +145,7 @@ LightGBM
- **Question 11**: LightGBM hangs when multithreading (OpenMP) and using forking in Linux at the same time. - **Question 11**: LightGBM hangs when multithreading (OpenMP) and using forking in Linux at the same time.
- **Solution 11**: Use ``nthreads=1`` to disable multithreading of LightGBM. There is a bug with OpenMP which hangs forked sessions with multithreading activated. A more expensive solution is to use new processes instead of using fork, however, keep in mind it is creating new processes where you have to copy memory and load libraries (example: if you want to fork 16 times your current process, then you will require to make 16 copies of your dataset in memory) (see `Microsoft/LightGBM#1789 <https://github.com/Microsoft/LightGBM/issues/1789#issuecomment-433713383>`__). - **Solution 11**: Use ``nthreads=1`` to disable multithreading of LightGBM. There is a bug with OpenMP which hangs forked sessions with multithreading activated. A more expensive solution is to use new processes instead of using fork, however, keep in mind it is creating new processes where you have to copy memory and load libraries (example: if you want to fork 16 times your current process, then you will require to make 16 copies of your dataset in memory) (see `Microsoft/LightGBM#1789 <https://github.com/microsoft/LightGBM/issues/1789#issuecomment-433713383>`__).
An alternative, if multithreading is really necessary inside the forked sessions, would be to compile LightGBM with Intel toolchain. Intel compilers are unaffected by this bug. An alternative, if multithreading is really necessary inside the forked sessions, would be to compile LightGBM with Intel toolchain. Intel compilers are unaffected by this bug.
...@@ -160,14 +160,14 @@ R-package ...@@ -160,14 +160,14 @@ R-package
- **Solution 1**: Run ``lgb.unloader(wipe = TRUE)`` in the R console, and recreate the LightGBM datasets (this will wipe all LightGBM-related variables). - **Solution 1**: Run ``lgb.unloader(wipe = TRUE)`` in the R console, and recreate the LightGBM datasets (this will wipe all LightGBM-related variables).
Due to the pointers, choosing to not wipe variables will not fix the error. Due to the pointers, choosing to not wipe variables will not fix the error.
This is a known issue: `Microsoft/LightGBM#698 <https://github.com/Microsoft/LightGBM/issues/698>`__. This is a known issue: `Microsoft/LightGBM#698 <https://github.com/microsoft/LightGBM/issues/698>`__.
-------------- --------------
- **Question 2**: I used ``setinfo``, tried to print my ``lgb.Dataset``, and now the R console froze! - **Question 2**: I used ``setinfo``, tried to print my ``lgb.Dataset``, and now the R console froze!
- **Solution 2**: Avoid printing the ``lgb.Dataset`` after using ``setinfo``. - **Solution 2**: Avoid printing the ``lgb.Dataset`` after using ``setinfo``.
This is a known bug: `Microsoft/LightGBM#539 <https://github.com/Microsoft/LightGBM/issues/539>`__. This is a known bug: `Microsoft/LightGBM#539 <https://github.com/microsoft/LightGBM/issues/539>`__.
-------------- --------------
...@@ -226,9 +226,9 @@ Python-package ...@@ -226,9 +226,9 @@ Python-package
- **Question 3**: I encounter segmentation faults (segfaults) randomly after installing LightGBM from PyPI using ``pip install lightgbm``. - **Question 3**: I encounter segmentation faults (segfaults) randomly after installing LightGBM from PyPI using ``pip install lightgbm``.
- **Solution 3**: We are doing our best to provide universal wheels which have high running speed and are compatible with any hardware, OS, compiler, etc. at the same time. - **Solution 3**: We are doing our best to provide universal wheels which have high running speed and are compatible with any hardware, OS, compiler, etc. at the same time.
However, sometimes it's just impossible to guarantee the possibility of usage of LightGBM in any specific environment (see `Microsoft/LightGBM#1743 <https://github.com/Microsoft/LightGBM/issues/1743>`__). However, sometimes it's just impossible to guarantee the possibility of usage of LightGBM in any specific environment (see `Microsoft/LightGBM#1743 <https://github.com/microsoft/LightGBM/issues/1743>`__).
Therefore, the first thing you should try in case of segfaults is **compiling from the source** using ``pip install --no-binary :all: lightgbm``. Therefore, the first thing you should try in case of segfaults is **compiling from the source** using ``pip install --no-binary :all: lightgbm``.
For the OS-specific prerequisites see `this guide <https://github.com/Microsoft/LightGBM/blob/master/python-package/README.rst#build-from-sources>`__. For the OS-specific prerequisites see `this guide <https://github.com/microsoft/LightGBM/blob/master/python-package/README.rst#build-from-sources>`__.
Also, feel free to post a new issue in our GitHub repository. We always look at each case individually and try to find a root cause. Also, feel free to post a new issue in our GitHub repository. We always look at each case individually and try to find a root cause.
...@@ -208,6 +208,6 @@ Huan Zhang, Si Si and Cho-Jui Hsieh. `GPU Acceleration for Large-scale Tree Boos ...@@ -208,6 +208,6 @@ Huan Zhang, Si Si and Cho-Jui Hsieh. `GPU Acceleration for Large-scale Tree Boos
.. _link6: http://stat-computing.org/dataexpo/2009/ .. _link6: http://stat-computing.org/dataexpo/2009/
.. _0bb4a82: https://github.com/Microsoft/LightGBM/commit/0bb4a82 .. _0bb4a82: https://github.com/microsoft/LightGBM/commit/0bb4a82
.. _GPU Acceleration for Large-scale Tree Boosting: https://arxiv.org/abs/1706.08359 .. _GPU Acceleration for Large-scale Tree Boosting: https://arxiv.org/abs/1706.08359
...@@ -159,7 +159,7 @@ Known issues: ...@@ -159,7 +159,7 @@ Known issues:
.. _ROCm: https://rocm.github.io/ .. _ROCm: https://rocm.github.io/
.. _our GitHub repo: https://github.com/Microsoft/LightGBM/releases/download/v2.0.12/AMD-APP-SDKInstaller-v3.0.130.136-GA-linux64.tar.bz2 .. _our GitHub repo: https://github.com/microsoft/LightGBM/releases/download/v2.0.12/AMD-APP-SDKInstaller-v3.0.130.136-GA-linux64.tar.bz2
.. _NVIDIA CUDA Toolkit: https://developer.nvidia.com/cuda-downloads .. _NVIDIA CUDA Toolkit: https://developer.nvidia.com/cuda-downloads
......
...@@ -57,7 +57,7 @@ Now we are ready to checkout LightGBM and compile it with GPU support: ...@@ -57,7 +57,7 @@ Now we are ready to checkout LightGBM and compile it with GPU support:
:: ::
git clone --recursive https://github.com/Microsoft/LightGBM git clone --recursive https://github.com/microsoft/LightGBM
cd LightGBM cd LightGBM
mkdir build ; cd build mkdir build ; cd build
cmake -DUSE_GPU=1 .. cmake -DUSE_GPU=1 ..
...@@ -194,7 +194,7 @@ Huan Zhang, Si Si and Cho-Jui Hsieh. "`GPU Acceleration for Large-scale Tree Boo ...@@ -194,7 +194,7 @@ Huan Zhang, Si Si and Cho-Jui Hsieh. "`GPU Acceleration for Large-scale Tree Boo
.. _AMDGPU-Pro: https://www.amd.com/en/support .. _AMDGPU-Pro: https://www.amd.com/en/support
.. _Python-package Examples: https://github.com/Microsoft/LightGBM/tree/master/examples/python-guide .. _Python-package Examples: https://github.com/microsoft/LightGBM/tree/master/examples/python-guide
.. _GPU Acceleration for Large-scale Tree Boosting: https://arxiv.org/abs/1706.08359 .. _GPU Acceleration for Large-scale Tree Boosting: https://arxiv.org/abs/1706.08359
......
...@@ -257,7 +257,7 @@ Now, we can fetch LightGBM repository for GitHub. Run Git Bash and the following ...@@ -257,7 +257,7 @@ Now, we can fetch LightGBM repository for GitHub. Run Git Bash and the following
cd C:/ cd C:/
mkdir github_repos mkdir github_repos
cd github_repos cd github_repos
git clone --recursive https://github.com/Microsoft/LightGBM git clone --recursive https://github.com/microsoft/LightGBM
Your LightGBM repository copy should now be under ``C:\github_repos\LightGBM``. Your LightGBM repository copy should now be under ``C:\github_repos\LightGBM``.
You are free to use any folder you want, but you have to adapt. You are free to use any folder you want, but you have to adapt.
...@@ -597,6 +597,6 @@ And open an issue in GitHub `here`_ with that log. ...@@ -597,6 +597,6 @@ And open an issue in GitHub `here`_ with that log.
.. _CMake: https://cmake.org/download/ .. _CMake: https://cmake.org/download/
.. _here: https://github.com/Microsoft/LightGBM/issues .. _here: https://github.com/microsoft/LightGBM/issues
.. _GPUCapsViewer: http://www.ozone3d.net/gpu_caps_viewer/ .. _GPUCapsViewer: http://www.ozone3d.net/gpu_caps_viewer/
...@@ -65,7 +65,7 @@ From Command Line ...@@ -65,7 +65,7 @@ From Command Line
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM git clone --recursive https://github.com/microsoft/LightGBM
cd LightGBM cd LightGBM
mkdir build mkdir build
cd build cd build
...@@ -83,7 +83,7 @@ MinGW-w64 ...@@ -83,7 +83,7 @@ MinGW-w64
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM git clone --recursive https://github.com/microsoft/LightGBM
cd LightGBM cd LightGBM
mkdir build mkdir build
cd build cd build
...@@ -109,7 +109,7 @@ On Linux LightGBM can be built using **CMake** and **gcc** or **Clang**. ...@@ -109,7 +109,7 @@ On Linux LightGBM can be built using **CMake** and **gcc** or **Clang**.
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM ; cd LightGBM git clone --recursive https://github.com/microsoft/LightGBM ; cd LightGBM
mkdir build ; cd build mkdir build ; cd build
cmake .. cmake ..
make -j4 make -j4
...@@ -144,7 +144,7 @@ Only **Apple Clang** version 8.1 or higher is supported. ...@@ -144,7 +144,7 @@ Only **Apple Clang** version 8.1 or higher is supported.
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM ; cd LightGBM git clone --recursive https://github.com/microsoft/LightGBM ; cd LightGBM
mkdir build ; cd build mkdir build ; cd build
# For Mojave (10.14) # For Mojave (10.14)
...@@ -180,7 +180,7 @@ gcc ...@@ -180,7 +180,7 @@ gcc
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM ; cd LightGBM git clone --recursive https://github.com/microsoft/LightGBM ; cd LightGBM
export CXX=g++-7 CC=gcc-7 # replace "7" with version of gcc installed on your machine export CXX=g++-7 CC=gcc-7 # replace "7" with version of gcc installed on your machine
mkdir build ; cd build mkdir build ; cd build
cmake .. cmake ..
...@@ -191,7 +191,7 @@ Also, you may want to read `gcc Tips <./gcc-Tips.rst>`__. ...@@ -191,7 +191,7 @@ Also, you may want to read `gcc Tips <./gcc-Tips.rst>`__.
Docker Docker
~~~~~~ ~~~~~~
Refer to `Docker folder <https://github.com/Microsoft/LightGBM/tree/master/docker>`__. Refer to `Docker folder <https://github.com/microsoft/LightGBM/tree/master/docker>`__.
Build Threadless Version (not Recommended) Build Threadless Version (not Recommended)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
...@@ -241,7 +241,7 @@ From Command Line ...@@ -241,7 +241,7 @@ From Command Line
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM git clone --recursive https://github.com/microsoft/LightGBM
cd LightGBM cd LightGBM
mkdir build mkdir build
cd build cd build
...@@ -259,7 +259,7 @@ MinGW-w64 ...@@ -259,7 +259,7 @@ MinGW-w64
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM git clone --recursive https://github.com/microsoft/LightGBM
cd LightGBM cd LightGBM
mkdir build mkdir build
cd build cd build
...@@ -281,7 +281,7 @@ On Linux version of LightGBM without OpenMP support can be built using **CMake** ...@@ -281,7 +281,7 @@ On Linux version of LightGBM without OpenMP support can be built using **CMake**
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM ; cd LightGBM git clone --recursive https://github.com/microsoft/LightGBM ; cd LightGBM
mkdir build ; cd build mkdir build ; cd build
cmake -DUSE_OPENMP=OFF .. cmake -DUSE_OPENMP=OFF ..
make -j4 make -j4
...@@ -308,7 +308,7 @@ Only **Apple Clang** version 8.1 or higher is supported. ...@@ -308,7 +308,7 @@ Only **Apple Clang** version 8.1 or higher is supported.
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM ; cd LightGBM git clone --recursive https://github.com/microsoft/LightGBM ; cd LightGBM
mkdir build ; cd build mkdir build ; cd build
cmake -DUSE_OPENMP=OFF .. cmake -DUSE_OPENMP=OFF ..
make -j4 make -j4
...@@ -332,7 +332,7 @@ gcc ...@@ -332,7 +332,7 @@ gcc
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM ; cd LightGBM git clone --recursive https://github.com/microsoft/LightGBM ; cd LightGBM
export CXX=g++-7 CC=gcc-7 # replace "7" with version of gcc installed on your machine export CXX=g++-7 CC=gcc-7 # replace "7" with version of gcc installed on your machine
mkdir build ; cd build mkdir build ; cd build
cmake -DUSE_OPENMP=OFF .. cmake -DUSE_OPENMP=OFF ..
...@@ -383,7 +383,7 @@ From Command Line ...@@ -383,7 +383,7 @@ From Command Line
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM git clone --recursive https://github.com/microsoft/LightGBM
cd LightGBM cd LightGBM
mkdir build mkdir build
cd build cd build
...@@ -407,7 +407,7 @@ On Linux MPI version of LightGBM can be built using **Open MPI**, **CMake** and ...@@ -407,7 +407,7 @@ On Linux MPI version of LightGBM can be built using **Open MPI**, **CMake** and
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM ; cd LightGBM git clone --recursive https://github.com/microsoft/LightGBM ; cd LightGBM
mkdir build ; cd build mkdir build ; cd build
cmake -DUSE_MPI=ON .. cmake -DUSE_MPI=ON ..
make -j4 make -j4
...@@ -446,7 +446,7 @@ Only **Apple Clang** version 8.1 or higher is supported. ...@@ -446,7 +446,7 @@ Only **Apple Clang** version 8.1 or higher is supported.
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM ; cd LightGBM git clone --recursive https://github.com/microsoft/LightGBM ; cd LightGBM
mkdir build ; cd build mkdir build ; cd build
# For Mojave (10.14) # For Mojave (10.14)
...@@ -489,7 +489,7 @@ gcc ...@@ -489,7 +489,7 @@ gcc
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM ; cd LightGBM git clone --recursive https://github.com/microsoft/LightGBM ; cd LightGBM
export CXX=g++-7 CC=gcc-7 # replace "7" with version of gcc installed on your machine export CXX=g++-7 CC=gcc-7 # replace "7" with version of gcc installed on your machine
mkdir build ; cd build mkdir build ; cd build
cmake -DUSE_MPI=ON .. cmake -DUSE_MPI=ON ..
...@@ -521,7 +521,7 @@ To build LightGBM GPU version, run the following commands: ...@@ -521,7 +521,7 @@ To build LightGBM GPU version, run the following commands:
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM ; cd LightGBM git clone --recursive https://github.com/microsoft/LightGBM ; cd LightGBM
mkdir build ; cd build mkdir build ; cd build
cmake -DUSE_GPU=1 .. cmake -DUSE_GPU=1 ..
# if you have installed NVIDIA CUDA to a customized location, you should specify paths to OpenCL headers and library like the following: # if you have installed NVIDIA CUDA to a customized location, you should specify paths to OpenCL headers and library like the following:
...@@ -563,7 +563,7 @@ Following procedure is for the **MSVC** (Microsoft Visual C++) build. ...@@ -563,7 +563,7 @@ Following procedure is for the **MSVC** (Microsoft Visual C++) build.
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM git clone --recursive https://github.com/microsoft/LightGBM
cd LightGBM cd LightGBM
mkdir build mkdir build
cd build cd build
...@@ -577,7 +577,7 @@ Following procedure is for the **MSVC** (Microsoft Visual C++) build. ...@@ -577,7 +577,7 @@ Following procedure is for the **MSVC** (Microsoft Visual C++) build.
Docker Docker
^^^^^^ ^^^^^^
Refer to `GPU Docker folder <https://github.com/Microsoft/LightGBM/tree/master/docker/gpu>`__. Refer to `GPU Docker folder <https://github.com/microsoft/LightGBM/tree/master/docker/gpu>`__.
Build HDFS Version Build HDFS Version
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
...@@ -595,7 +595,7 @@ On Linux HDFS version of LightGBM can be built using **CMake** and **gcc**. ...@@ -595,7 +595,7 @@ On Linux HDFS version of LightGBM can be built using **CMake** and **gcc**.
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM ; cd LightGBM git clone --recursive https://github.com/microsoft/LightGBM ; cd LightGBM
mkdir build ; cd build mkdir build ; cd build
cmake -DUSE_HDFS=ON .. cmake -DUSE_HDFS=ON ..
# if you have installed HDFS to a customized location, you should specify paths to HDFS headers (hdfs.h) and library (libhdfs.so) like the following: # if you have installed HDFS to a customized location, you should specify paths to HDFS headers (hdfs.h) and library (libhdfs.so) like the following:
...@@ -627,7 +627,7 @@ VS Build Tools ...@@ -627,7 +627,7 @@ VS Build Tools
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM git clone --recursive https://github.com/microsoft/LightGBM
cd LightGBM cd LightGBM
mkdir build mkdir build
cd build cd build
...@@ -647,7 +647,7 @@ MinGW-w64 ...@@ -647,7 +647,7 @@ MinGW-w64
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM git clone --recursive https://github.com/microsoft/LightGBM
cd LightGBM cd LightGBM
mkdir build mkdir build
cd build cd build
...@@ -673,7 +673,7 @@ On Linux Java wrapper of LightGBM can be built using **Java**, **SWIG**, **CMake ...@@ -673,7 +673,7 @@ On Linux Java wrapper of LightGBM can be built using **Java**, **SWIG**, **CMake
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM ; cd LightGBM git clone --recursive https://github.com/microsoft/LightGBM ; cd LightGBM
mkdir build ; cd build mkdir build ; cd build
cmake -DUSE_SWIG=ON .. cmake -DUSE_SWIG=ON ..
make -j4 make -j4
...@@ -707,7 +707,7 @@ Only **Apple Clang** version 8.1 or higher is supported. ...@@ -707,7 +707,7 @@ Only **Apple Clang** version 8.1 or higher is supported.
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM ; cd LightGBM git clone --recursive https://github.com/microsoft/LightGBM ; cd LightGBM
mkdir build ; cd build mkdir build ; cd build
# For Mojave (10.14) # For Mojave (10.14)
...@@ -745,7 +745,7 @@ gcc ...@@ -745,7 +745,7 @@ gcc
.. code:: .. code::
git clone --recursive https://github.com/Microsoft/LightGBM ; cd LightGBM git clone --recursive https://github.com/microsoft/LightGBM ; cd LightGBM
export CXX=g++-7 CC=gcc-7 # replace "7" with version of gcc installed on your machine export CXX=g++-7 CC=gcc-7 # replace "7" with version of gcc installed on your machine
mkdir build ; cd build mkdir build ; cd build
cmake -DUSE_SWIG=ON -DAPPLE_OUTPUT_DYLIB=ON .. cmake -DUSE_SWIG=ON -DAPPLE_OUTPUT_DYLIB=ON ..
...@@ -757,11 +757,11 @@ Also, you may want to read `gcc Tips <./gcc-Tips.rst>`__. ...@@ -757,11 +757,11 @@ Also, you may want to read `gcc Tips <./gcc-Tips.rst>`__.
.. |download artifacts| image:: ./_static/images/artifacts-not-available.svg .. |download artifacts| image:: ./_static/images/artifacts-not-available.svg
:target: https://lightgbm.readthedocs.io/en/latest/Installation-Guide.html :target: https://lightgbm.readthedocs.io/en/latest/Installation-Guide.html
.. _Python-package: https://github.com/Microsoft/LightGBM/tree/master/python-package .. _Python-package: https://github.com/microsoft/LightGBM/tree/master/python-package
.. _R-package: https://github.com/Microsoft/LightGBM/tree/master/R-package .. _R-package: https://github.com/microsoft/LightGBM/tree/master/R-package
.. _zip archive: https://github.com/Microsoft/LightGBM/archive/master.zip .. _zip archive: https://github.com/microsoft/LightGBM/archive/master.zip
.. _Visual Studio: https://visualstudio.microsoft.com/downloads/ .. _Visual Studio: https://visualstudio.microsoft.com/downloads/
......
This diff is collapsed.
...@@ -124,4 +124,4 @@ Example ...@@ -124,4 +124,4 @@ Example
.. _here: https://www.youtube.com/watch?v=iqzXhp5TxUY .. _here: https://www.youtube.com/watch?v=iqzXhp5TxUY
.. _A simple parallel example: https://github.com/Microsoft/lightgbm/tree/master/examples/parallel_learning .. _A simple parallel example: https://github.com/microsoft/lightgbm/tree/master/examples/parallel_learning
...@@ -366,7 +366,7 @@ Learning Control Parameters ...@@ -366,7 +366,7 @@ Learning Control Parameters
- **Note**: the forced split logic will be ignored, if the split makes gain worse - **Note**: the forced split logic will be ignored, if the split makes gain worse
- see `this file <https://github.com/Microsoft/LightGBM/tree/master/examples/binary_classification/forced_splits.json>`__ as an example - see `this file <https://github.com/microsoft/LightGBM/tree/master/examples/binary_classification/forced_splits.json>`__ as an example
- ``refit_decay_rate`` :raw-html:`<a id="refit_decay_rate" title="Permalink to this parameter" href="#refit_decay_rate">&#x1F517;&#xFE0E;</a>`, default = ``0.9``, type = double, constraints: ``0.0 <= refit_decay_rate <= 1.0`` - ``refit_decay_rate`` :raw-html:`<a id="refit_decay_rate" title="Permalink to this parameter" href="#refit_decay_rate">&#x1F517;&#xFE0E;</a>`, default = ``0.9``, type = double, constraints: ``0.0 <= refit_decay_rate <= 1.0``
......
...@@ -5,7 +5,7 @@ This document gives a basic walkthrough of LightGBM Python-package. ...@@ -5,7 +5,7 @@ This document gives a basic walkthrough of LightGBM Python-package.
**List of other helpful links** **List of other helpful links**
- `Python Examples <https://github.com/Microsoft/LightGBM/tree/master/examples/python-guide>`__ - `Python Examples <https://github.com/microsoft/LightGBM/tree/master/examples/python-guide>`__
- `Python API <./Python-API.rst>`__ - `Python API <./Python-API.rst>`__
...@@ -226,4 +226,4 @@ If early stopping is enabled during training, you can get predictions from the b ...@@ -226,4 +226,4 @@ If early stopping is enabled during training, you can get predictions from the b
ypred = bst.predict(data, num_iteration=bst.best_iteration) ypred = bst.predict(data, num_iteration=bst.best_iteration)
.. _Python-package: https://github.com/Microsoft/LightGBM/tree/master/python-package .. _Python-package: https://github.com/microsoft/LightGBM/tree/master/python-package
...@@ -71,13 +71,13 @@ For example, the following command line will keep ``num_trees=10`` and ignore th ...@@ -71,13 +71,13 @@ For example, the following command line will keep ``num_trees=10`` and ignore th
Examples Examples
-------- --------
- `Binary Classification <https://github.com/Microsoft/LightGBM/tree/master/examples/binary_classification>`__ - `Binary Classification <https://github.com/microsoft/LightGBM/tree/master/examples/binary_classification>`__
- `Regression <https://github.com/Microsoft/LightGBM/tree/master/examples/regression>`__ - `Regression <https://github.com/microsoft/LightGBM/tree/master/examples/regression>`__
- `Lambdarank <https://github.com/Microsoft/LightGBM/tree/master/examples/lambdarank>`__ - `Lambdarank <https://github.com/microsoft/LightGBM/tree/master/examples/lambdarank>`__
- `Parallel Learning <https://github.com/Microsoft/LightGBM/tree/master/examples/parallel_learning>`__ - `Parallel Learning <https://github.com/microsoft/LightGBM/tree/master/examples/parallel_learning>`__
.. _CSV: https://en.wikipedia.org/wiki/Comma-separated_values .. _CSV: https://en.wikipedia.org/wiki/Comma-separated_values
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment