initial commit: modified scala etls to accept Fannie Mae data

docs/get-started/xgboost-examples/building-sample-apps/python.md

@@ -17,7 +17,8 @@ Two files are required by PySpark:
 
 + *samples.zip*
 
-  the package including all example code
+  the package including all example code. 
+  Executing the above build commands generates the samples.zip file in 'spark-rapids-examples/examples/XGBoost-Examples' folder
 
 + *main.py*
 

docs/get-started/xgboost-examples/dataset/mortgage.md

@@ -0,0 +1,22 @@
+# How to download the Mortgage dataset
+
+
+
+## Steps to download the data
+
+1. Go to the [Fannie Mae](https://capitalmarkets.fanniemae.com/credit-risk-transfer/single-family-credit-risk-transfer/fannie-mae-single-family-loan-performance-data) website
+2. Click on [Single-Family Loan Performance Data](https://datadynamics.fanniemae.com/data-dynamics/?&_ga=2.181456292.2043790680.1657122341-289272350.1655822609#/reportMenu;category=HP)
+    * Register as a new user if you are using the website for the first time
+    * Use the credentials to login
+3. Select [HP](https://datadynamics.fanniemae.com/data-dynamics/#/reportMenu;category=HP)
+4. Click on  **Download Data** and choose *Single-Family Loan Performance Data*
+5. You will find a tabular list of 'Acquisition and Performance' files sorted based on year and quarter. Click on the file to download `Eg: 2017Q1.zip`
+6. Unzip the downlad file to extract the csv file `Eg: 2017Q1.csv`
+7. Copy only the csv files to a new folder for the ETL to read
+
+## Notes
+1. Refer to the [Loan Performance Data Tutorial](https://capitalmarkets.fanniemae.com/media/9066/display) for more details. 
+2. Note that *Single-Family Loan Performance Data* has 2 componenets. However, the Mortgage ETL requires only the first one (primary dataset)
+    * Primary Dataset:  Acquisition and Performance Files
+    * HARP Dataset
+3. Use the [Resources](https://datadynamics.fanniemae.com/data-dynamics/#/resources/HP) section to know more about the dataset

docs/get-started/xgboost-examples/on-prem-cluster/kubernetes-scala.md

@@ -60,9 +60,10 @@ on cluster filesystems like HDFS, or in [object stores like S3 and GCS](https://
 Note that using [application dependencies](https://spark.apache.org/docs/latest/running-on-kubernetes.html#dependency-management) from 
 the submission client’s local file system is currently not yet supported.
 
-Note: the `mortgage_eval_merged.csv` and `mortgage_train_merged.csv` are not Mortgage raw data,
-they are the data produced by Mortgage ETL job. If user wants to use a larger size Mortgage data, please refer to [Launch ETL job](#etl).
-Taxi ETL job is the same. But Agaricus does not have ETL process, it is combined with XGBoost as there is just a filter operation.
+#### Note: 
+1. Mortgage and Taxi jobs have ETLs to generate the processed data. You can either use this ETLed data to split into training and testing data or run the ETL on different subsets of the dataset to produce training and testing datasets. Please refer [Launch ETL job](#etl). 
+2. For convenience, a subset of [Taxi](/datasets/) dataset is made available in this repo that can be readily used for launching XGBoost job. Use [ETL](#etl) to generate larger datasets for trainig and testing. 
+3. Agaricus does not have an ETL process, it is combined with XGBoost as there is just a filter operation.
 
 Save Kubernetes Template Resources
 ----------------------------------
@@ -110,13 +111,11 @@ ${SPARK_HOME}/bin/spark-submit \
    --class com.nvidia.spark.examples.mortgage.ETLMain  \
    $SAMPLE_JAR \
    -format=csv \
-   -dataPath="perf::${SPARK_XGBOOST_DIR}/mortgage/perf-train/" \
-   -dataPath="acq::${SPARK_XGBOOST_DIR}/mortgage/acq-train/" \
+   -dataPath="data::${SPARK_XGBOOST_DIR}/mortgage/input/" \
    -dataPath="out::${SPARK_XGBOOST_DIR}/mortgage/out/train/"
 
 # if generating eval data, change the data path to eval as well as the corresponding perf-eval and acq-eval data
-# -dataPath="perf::${SPARK_XGBOOST_DIR}/mortgage/perf-eval"
-# -dataPath="acq::${SPARK_XGBOOST_DIR}/mortgage/acq-eval"
+# -dataPath="data::${SPARK_XGBOOST_DIR}/mortgage/input/"
 # -dataPath="out::${SPARK_XGBOOST_DIR}/mortgage/out/eval/"
 # if running Taxi ETL benchmark, change the class and data path params to
 # -class com.nvidia.spark.examples.taxi.ETLMain  

docs/get-started/xgboost-examples/on-prem-cluster/standalone-python.md

@@ -53,6 +53,13 @@ Get Application Files, Jar and Dataset
 
 Make sure you have prepared the necessary packages and dataset by following this [guide](/docs/get-started/xgboost-examples/prepare-package-data/preparation-python.md)
 
+
+#### Note: 
+1. Mortgage and Taxi jobs have ETLs to generate the processed data. You can either use this ETLed data to split into training and testing data or run the ETL on different subsets of the dataset to produce training and testing datasets. Please refer [Launch ETL job](#etl). 
+2. For convenience, a subset of [Taxi](/datasets/) dataset is made available in this repo that can be readily used for launching XGBoost job. Use [ETL](#etl) to generate larger datasets for trainig and testing. 
+3. Agaricus does not have an ETL process, it is combined with XGBoost as there is just a filter operation.
+
+
 Launch a Standalone Spark Cluster
 ---------------------------------
 
@@ -99,13 +106,11 @@ ${SPARK_HOME}/bin/spark-submit \
     main.py \
     --mainClass='com.nvidia.spark.examples.mortgage.etl_main' \
     --format=csv \
-    --dataPath="perf::${SPARK_XGBOOST_DIR}/mortgage/perf-train/" \
-    --dataPath="acq::${SPARK_XGBOOST_DIR}/mortgage/acq-train/" \
+    --dataPath="data::${SPARK_XGBOOST_DIR}/mortgage/input/" \
     --dataPath="out::${SPARK_XGBOOST_DIR}/mortgage/out/train/"
 
 # if generating eval data, change the data path to eval as well as the corresponding perf-eval and acq-eval data
-# --dataPath="perf::${SPARK_XGBOOST_DIR}/mortgage/perf-eval"
-# --dataPath="acq::${SPARK_XGBOOST_DIR}/mortgage/acq-eval"
+# --dataPath="data::${SPARK_XGBOOST_DIR}/mortgage/input/"
 # --dataPath="out::${SPARK_XGBOOST_DIR}/mortgage/out/eval/"
 # if running Taxi ETL benchmark, change the class and data path params to
 # -class com.nvidia.spark.examples.taxi.ETLMain  

docs/get-started/xgboost-examples/on-prem-cluster/standalone-scala.md

@@ -53,9 +53,11 @@ Get Jars and Dataset
 Make sure you have prepared the necessary packages and dataset 
 by following this [guide](/docs/get-started/xgboost-examples/prepare-package-data/preparation-scala.md)
 
-Note: the `mortgage_eval_merged.csv` and `mortgage_train_merged.csv` are not Mortgage raw data,
-they are the data produced by Mortgage ETL job. If user wants to use a larger size Mortgage data, please refer to [Launch ETL job](#etl).
-Taxi ETL job is the same. But Agaricus does not have ETL process, it is combined with XGBoost as there is just a filter operation.
+#### Note: 
+1. Mortgage and Taxi jobs have ETLs to generate the processed data. You can either use this ETLed data to split into training and testing data or run the ETL on different subsets of the dataset to produce training and testing datasets. Please refer [Launch ETL job](#etl). 
+2. For convenience, a subset of [Taxi](/datasets/) dataset is made available in this repo that can be readily used for launching XGBoost job. Use [ETL](#etl) to generate larger datasets for trainig and testing. 
+3. Agaricus does not have an ETL process, it is combined with XGBoost as there is just a filter operation.
+
 
 Launch a Standalone Spark Cluster
 ---------------------------------
@@ -107,13 +109,11 @@ ${SPARK_HOME}/bin/spark-submit \
     --class com.nvidia.spark.examples.mortgage.ETLMain  \
     $SAMPLE_JAR \
     -format=csv \
-    -dataPath="perf::${SPARK_XGBOOST_DIR}/mortgage/perf-train/" \
-    -dataPath="acq::${SPARK_XGBOOST_DIR}/mortgage/acq-train/" \
+    -dataPath="data::${SPARK_XGBOOST_DIR}/mortgage/input/" \
     -dataPath="out::${SPARK_XGBOOST_DIR}/mortgage/out/train/"
 
 # if generating eval data, change the data path to eval as well as the corresponding perf-eval and acq-eval data
-# -dataPath="perf::${SPARK_XGBOOST_DIR}/mortgage/perf-eval"
-# -dataPath="acq::${SPARK_XGBOOST_DIR}/mortgage/acq-eval"
+# -dataPath="data::${SPARK_XGBOOST_DIR}/mortgage/input/"
 # -dataPath="out::${SPARK_XGBOOST_DIR}/mortgage/out/eval/"
 # if running Taxi ETL benchmark, change the class and data path params to
 # -class com.nvidia.spark.examples.taxi.ETLMain  
@@ -150,7 +150,7 @@ export SPARK_DRIVER_MEMORY=4g
 export SPARK_EXECUTOR_MEMORY=8g
 
 # example class to use
-export EXAMPLE_CLASS=com.nvidia.spark.examples.mortgage.GPUMain
+export EXAMPLE_CLASS=com.nvidia.spark.examples.mortgage.Main
 # or change to com.nvidia.spark.examples.taxi.GPUMain to run Taxi Xgboost benchmark
 # or change to com.nvidia.spark.examples.agaricus.GPUMain to run Agaricus Xgboost benchmark
 
@@ -229,7 +229,7 @@ export SPARK_DRIVER_MEMORY=4g
 export SPARK_EXECUTOR_MEMORY=8g
 
 # example class to use
-export EXAMPLE_CLASS=com.nvidia.spark.examples.mortgage.CPUMain
+export EXAMPLE_CLASS=com.nvidia.spark.examples.mortgage.Main
 # Please make sure to change the class while running Taxi or Agaricus benchmark     
 
 # tree construction algorithm

docs/get-started/xgboost-examples/on-prem-cluster/yarn-python.md

@@ -60,8 +60,7 @@ ${SPARK_HOME}/bin/spark-submit \
     ${MAIN_PY} \
     --mainClass='com.nvidia.spark.examples.mortgage.etl_main' \
     --format=csv \
-    --dataPath="perf::${DATA_PATH}/mortgage/data/mortgage/perf/" \
-    --dataPath="acq::${DATA_PATH}/mortgage/data/mortgage/acq/" \
+    --dataPath="data::${DATA_PATH}/mortgage/data/mortgage/input/" \
     --dataPath="out::${DATA_PATH}/mortgage/data/mortgage/out/train/"
 
 # if generate eval data, change the data path to eval

docs/get-started/xgboost-examples/on-prem-cluster/yarn-scala.md

@@ -35,6 +35,11 @@ Get Jars and Dataset
 
 Make sure you have prepared the necessary packages and dataset by following this [guide](/docs/get-started/xgboost-examples/prepare-package-data/preparation-scala.md)
 
+#### Note: 
+1. Mortgage and Taxi jobs have ETLs to generate the processed data. You can either use this ETLed data to split into training and testing data or run the ETL on different subsets of the dataset to produce training and testing datasets. Please refer [Launch ETL job](#etl). 
+2. For convenience, a subset of [Taxi](/datasets/) dataset is made available in this repo that can be readily used for launching XGBoost job. Use [ETL](#etl) to generate larger datasets for trainig and testing. 
+3. Agaricus does not have an ETL process, it is combined with XGBoost as there is just a filter operation.
+
 Create a directory in HDFS, and copy:
 
 ``` bash
@@ -69,13 +74,11 @@ ${SPARK_HOME}/bin/spark-submit \
    --class com.nvidia.spark.examples.mortgage.ETLMain  \
    $SAMPLE_JAR \
    -format=csv \
-   -dataPath="perf::${SPARK_XGBOOST_DIR}/mortgage/perf-train/" \
-   -dataPath="acq::${SPARK_XGBOOST_DIR}/mortgage/acq-train/" \
+   -dataPath="data::${SPARK_XGBOOST_DIR}/mortgage/input/" \
    -dataPath="out::${SPARK_XGBOOST_DIR}/mortgage/out/train/"
 
-# if generating eval data, change the data path to eval as well as the corresponding perf-eval and acq-eval data
-# -dataPath="perf::${SPARK_XGBOOST_DIR}/mortgage/perf-eval"
-# -dataPath="acq::${SPARK_XGBOOST_DIR}/mortgage/acq-eval"
+# if generating eval data, change the data path to eval 
+# -dataPath="data::${SPARK_XGBOOST_DIR}/mortgage/input/"
 # -dataPath="out::${SPARK_XGBOOST_DIR}/mortgage/out/eval/"
 # if running Taxi ETL benchmark, change the class and data path params to
 # -class com.nvidia.spark.examples.taxi.ETLMain  

docs/get-started/xgboost-examples/prepare-package-data/preparation-python.md

@@ -17,9 +17,10 @@ Following this [guide](/docs/get-started/xgboost-examples/building-sample-apps/p
 
 ### Download dataset
 
-You need to download Mortgage dataset to `/opt/xgboost` from this [site](https://docs.rapids.ai/datasets/mortgage-data)
-, download Taxi dataset from this [site](https://www1.nyc.gov/site/tlc/about/tlc-trip-record-data.page)
-, download Agaricus dataset from this [site](https://gust.dev/r/xgboost-agaricus).
+You need to copy the dataset to `/opt/xgboost`. Use the following links to download the data.
+1. [Mortgage dataset](/docs/get-started/xgboost-examples/dataset/mortgage.md)
+2. [Taxi dataset](https://www1.nyc.gov/site/tlc/about/tlc-trip-record-data.page)
+3. [Agaricus dataset](https://gust.dev/r/xgboost-agaricus)
 
 ### Setup environments
 

docs/get-started/xgboost-examples/prepare-package-data/preparation-scala.md

@@ -13,9 +13,10 @@ Following this [guide](/docs/get-started/xgboost-examples/building-sample-apps/s
 
 ### Download dataset
 
-You need to download mortgage dataset to `/opt/xgboost` from this [site](https://docs.rapids.ai/datasets/mortgage-data)
-, download Taxi dataset from this [site](https://www1.nyc.gov/site/tlc/about/tlc-trip-record-data.page)
-, download Agaricus dataset from this [site](https://gust.dev/r/xgboost-agaricus).
+You need to copy the dataset to `/opt/xgboost`. Use the following links to download the data.
+1. [Mortgage dataset](/docs/get-started/xgboost-examples/dataset/mortgage.md)
+2. [Taxi dataset](https://www1.nyc.gov/site/tlc/about/tlc-trip-record-data.page)
+3. [Agaricus dataset](https://gust.dev/r/xgboost-agaricus)
 
 ### Setup environments