summaryrefslogtreecommitdiffstats
path: root/libraries/xgboost/README
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/xgboost/README')
-rw-r--r--libraries/xgboost/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/libraries/xgboost/README b/libraries/xgboost/README
new file mode 100644
index 0000000000..2fd90ab1e3
--- /dev/null
+++ b/libraries/xgboost/README
@@ -0,0 +1,17 @@
+ XGBoost is an optimized distributed gradient boosting library
+designed to be highly efficient, flexible and portable. It implements
+machine learning algorithms under the Gradient Boosting framework.
+XGBoost provides a parallel tree boosting (also known as GBDT, GBM)
+that solve many data science problems in a fast and accurate way.
+The same code runs on major distributed environment (Hadoop, SGE,
+MPI) and can solve problems beyond billions of examples.
+
+
+ By default the package is build without parellization, if you want
+to enable OpenMP set the environment variable OMP=yes.
+ For enabling MPI set the environment variable MPI=yes, this requires
+a MPI implementation, use mpich (openmpi isn't working).
+ To enable GPU support set CUDA=yes, this requires the CUDA toolkit.
+ To install the Python module set PYTHON=yes (note: python3 only).
+ If you want to run the tests set the environment variable TESTS=yes,
+this requires gtest.