Merge branch 'master' of http://github.com/oneapi-src/oneAPI-samples

Author: vmadananth

DirectProgramming/Python/.gitkeep renamed to .gitmodules

@@ -0,0 +1,111 @@
+# End-to-end machine learning workload: Census
+This sample code illustrates how to use Modin for ETL operations and ridge regression algorithm from the DAAL accelerated scikit-learn library to build and run an end to end machine learning workload. It demonstrates how to use software products that can be found in the [Intel AI Analytics Toolkit powered by oneAPI](https://software.intel.com/content/www/us/en/develop/tools/oneapi/ai-analytics-toolkit.html). 
+
+| Optimized for                     | Description
+| :---                              | :---
+| OS                                | 64-bit Linux: Ubuntu 18.04 or higher
+| Hardware                          | Intel Atom® Processors; Intel® Core™ Processor Family; Intel® Xeon® Processor Family; Intel® Xeon® Scalable Performance Processor Family
+| Software                          | Python version 3.7, Modin, Ray, daal4py, Scikit-Learn, NumPy, Intel® AI Analytics Toolkit
+| What you will learn               | How to use Modin and DAAL optimized scikit-learn (developed and owned by Intel) to build end to end ML workloads and gain performance.
+| Time to complete                  | 15-18 minutes
+
+## Purpose
+Modin uses Ray to provide an effortless way to speed up your Pandas notebooks, scripts and libraries. Unlike other distributed DataFrame libraries, Modin provides seamless integration and compatibility with existing Pandas code. Daal4py is a simplified API to Intel DAAL that allows for fast usage of the framework suited for Data Scientists and Machine Learning users. It is built to help provide an abstraction to Intel® DAAL for either direct usage or integration into one's own framework.
+
+#### Model and dataset
+In this sample, you will use Modin to ingest and process U.S. census data from 1970 to 2010 in order to build a ridge regression based model to find the relation between education and the total income earned in the US.
+Data transformation stage normalizes the income to the yearly inflation, balances the data such that each year has a similar number of data points, and extracts the features from the transformed dataset. The feature vectors are fed into the ridge regression model to predict the income of each sample.
+
+Dataset is from IPUMS USA, University of Minnesota , [www.ipums.org](https://ipums.org/) (Steven Ruggles, Sarah Flood, Ronald Goeken, Josiah Grover, Erin Meyer, Jose Pacas and Matthew Sobek. IPUMS USA: Version 10.0 [dataset]. Minneapolis, MN: IPUMS, 2020. https://doi.org/10.18128/D010.V10.0)
+
+## Key Implementation Details
+This end-to-end workload sample code is implemented for CPU using the Python language. The example requires you to have Modin, Ray, daal4py, Scikit-Learn, NumPy installed inside a conda environment, similar to what is directed by the [oneAPI AI Analytics Toolkit powered by oneAPI](https://software.intel.com/content/www/us/en/develop/articles/installing-ai-kit-with-conda.html) as well as the steps that follow in this README. 
+
+## License
+
+This code sample is licensed under MIT license
+
+## Building Modin and daal4py for CPU to build and run end-to-end workload
+
+Modin and oneAPI Data Analytics Library (DAAL) is ready for use once you finish the Intel AI Analytics Toolkit installation with the Conda Package Manager.
+
+You can refer to the oneAPI [main page](https://software.intel.com/en-us/oneapi), and the Toolkit [Getting Started Guide for Linux](https://software.intel.com/content/www/us/en/develop/documentation/get-started-with-ai-linux/top.html) for installation steps and scripts.
+
+
+### Activate conda environment With Root Access
+
+Please follow the Getting Started Guide steps (above) to set up your oneAPI environment with the `setvars.sh` script and Intel Distribution of Modin environment installation (https://software.intel.com/content/www/us/en/develop/articles/installing-ai-kit-with-conda.html). Then navigate in Linux shell to your oneapi installation path, typically `/opt/intel/oneapi/` when installed as root or sudo, and `~/intel/oneapi/` when not installed as a super user. If you customized the installation folder, the `setvars.sh` file is in your custom folder.
+
+Activate the conda environment with the following command:
+
+#### Linux
+```
+source activate intel-aikit-modin
+```
+
+### Activate conda environment Without Root Access (Optional)
+
+By default, the Intel AI Analytics toolkit is installed in the `oneapi` folder, which requires root privileges to manage it. If you would like to bypass using root access to manage your conda environment, then you can clone your desired conda environment using the following command:
+
+#### Linux
+```
+conda create --name intel-aikit-modin -c intel/label/oneapibeta -c intel -c conda-forge runipy intel-aikit-modin=2021.1b10
+```
+
+Then activate your conda environment with the following command:
+
+```
+conda activate intel-aikit-modin
+```
+
+
+### Install Jupyter Notebook
+
+Launch Jupyter Notebook in the directory housing the code example
+
+```
+conda install jupyter nb_conda_kernels
+```
+or
+```
+pip install jupyter
+```
+
+### Install wget package
+
+Install wget package in order to retrieve the Census dataset using HTTPS
+
+```
+pip install wget
+```
+
+#### View in Jupyter Notebook
+
+
+Launch Jupyter Notebook in the directory housing the code example
+
+```
+jupyter notebook
+```
+
+## Running the end-to-end code sample
+
+### Run as Jupyter Notebook
+
+Open .ipynb file and run cells in Jupyter Notebook using the "Run" button. Alternatively, the entire workbook can be run using the "Restart kernel and re-run whole notebook" button. (see image below using "census modin" sample)
+
+![Click the Run Button in the Jupyter Notebook](Running_Jupyter_notebook.jpg "Run Button on Jupyter Notebook")
+
+### Run as Python File
+
+Open notebook in Jupyter and download as python file (see image using "census modin" sample)
+
+![Download as python file in the Jupyter Notebook](Running_Jupyter_notebook_as_Python.jpg "Download as python file in the Jupyter Notebook")
+
+Run the Program
+
+`python census_modin.py`
+
+##### Expected Printed Output:
+Expected Cell Output shown for census_modin.ipynb:
+![Output](Expected_output.jpg "Expected output for Jupyter Notebook")