From 74348c8001e8eab706fae8c91f21ac8a9e022e92 Mon Sep 17 00:00:00 2001
From: Boliang Chen <cblsjtu@gmail.com>
Date: Sun, 11 Jan 2015 00:00:03 +0800
Subject: [PATCH] initialize

---
 multi-node/hadoop/README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 multi-node/hadoop/README.md

diff --git a/multi-node/hadoop/README.md b/multi-node/hadoop/README.md
new file mode 100644
index 000000000..adfacdb8b
--- /dev/null
+++ b/multi-node/hadoop/README.md
@@ -0,0 +1,15 @@
+Distributed XGBoost: Hadoop Version
+====
+* Hadoop version: run ```bash run_binary_classification.sh <n_hadoop_workers> <path_in_HDFS>```
+  - This is the hadoop version of binary classification example in the demo folder.
+
+How to Use
+====
+* Check whether environment variable $HADOOP_HOME exists (e.g. run ```echo $HADOOP_HOME```). If not, plz set up hadoop-streaming.jar path in rabit_hadoop.py. 
+
+Notes
+====
+* The code has been tested on MapReduce 1 (MRv1), it should be ok to run on MapReduce 2 (MRv2, YARN).
+* The code is multi-threaded, so you want to run one xgboost per node/worker, which means the parameter <n_workers> should be less than the number of slaves/workers. 
+* The hadoop version now can only save the final model and evaluate test data locally after the training process.
+