Skip to content

Update Modin Get Started Readme with node and mode instruction #831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 2, 2022
Merged

Update Modin Get Started Readme with node and mode instruction #831

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a64d0a
Update Modin Get Started Readme with node and mode instruction
bdmoore1 May 25, 2021
4b374b2
Merge branch 'master' into bdmoore1-modin-gstarted-readme-nodemode-up…
praveenkk123 Feb 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 33 additions & 7 deletions AI-and-Analytics/Getting-Started-Samples/IntelModin_GettingStarted/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ Intel Distribution of Modin* uses Ray or Dask to provide an effortless way to sp
In this sample, you will run Intel Distribution of Modin*-accelerated Pandas functions and note the performance gain when compared to "stock" (aka standard) Pandas functions.

## Key Implementation Details
This Getting Started sample code is implemented for CPU using the Python language. The example assumes you have Pandas and MoIntel Distribution of Modin* installed inside a conda environment, similar to what is directed by the [Intel® oneAPI AI Analytics Toolkit](https://www.intel.com/content/www/us/en/develop/documentation/installation-guide-for-intel-oneapi-toolkits-linux/top/installation/install-using-package-managers/conda/install-intel-ai-analytics-toolkit-via-conda.html).

This Getting Started sample code is implemented for CPU using the Python language. The example assumes you have Pandas and Modin installed inside a conda environment, similar to what is directed by the [Intel® oneAPI AI Analytics Toolkit](https://www.intel.com/content/www/us/en/develop/documentation/installation-guide-for-intel-oneapi-toolkits-linux/top/installation/install-using-package-managers/conda/install-intel-ai-analytics-toolkit-via-conda.html).


## License

Expand All @@ -24,7 +26,12 @@ Code samples are licensed under the MIT license. See

Third party program Licenses can be found here: [third-party-programs.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/third-party-programs.txt).

## Building Intel Distribution of Modin* for CPU

## Running Samples on the Intel® DevCloud
If you are running this sample on the DevCloud, see [Running Samples on the Intel® DevCloud](#run-samples-on-devcloud)

## Building Modin for CPU


Intel Distribution of Modin* is ready for use once you finish the Intel Distribution of Modin installation and have run the post installation script.

Expand Down Expand Up @@ -83,9 +90,9 @@ Launch Jupyter Notebook in the directory housing the code example:
jupyter notebook
```

## Running the Sample
## Running the Sample<a name="running-the-sample"></a>

### Run as Jupyter Notebook
### Run as Jupyter Notebook<a name="run-as-jupyter-notebook"></a>

Open .ipynb file and run cells in Jupyter Notebook using the "Run" button (see the image using "daal4py Hello World" sample):

Expand All @@ -106,8 +113,27 @@ Run the Program
`python IntelModin_GettingStarted.py`

##### Expected Printed Output:
Expected Cell Output is shown in IntelModin_GettingStarted.ipynb.
Expected Cell Output is shown in IntelModin_GettingStarted.ipynb

### Running Samples on the Intel&reg; DevCloud (Optional)<a name="run-samples-on-devcloud"></a>

<!---Include the next paragraph ONLY if the sample runs in batch mode-->
### Run in Batch Mode
This sample runs in batch mode, so you must have a script for batch processing. Once you have a script set up, refer to [Running the Sample](#running-the-sample).

<!---Include the next paragraph ONLY if the sample DOES NOT RUN in batch mode-->
### Run in Interactive Mode
This sample runs in interactive mode. For more information, see [Run as Juypter Notebook](#run-as-jupyter-notebook).

### Request a Compute Node
In order to run on the DevCloud, you need to request a compute node using node properties such as: `gpu`, `xeon`, `fpga_compile`, `fpga_runtime` and others. For more information about the node properties, execute the `pbsnodes` command.
This node information must be provided when submitting a job to run your sample in batch mode using the qsub command. When you see the qsub command in the Run section of the [Hello World instructions](https://devcloud.intel.com/oneapi/get_started/aiAnalyticsToolkitSamples/), change the command to fit the node you are using. Nodes which are in bold indicate they are compatible with this sample:

### Build and run additional samples
Several sample programs are available for you to try, many of which can be compiled and run in a similar fashion. Experiment with running the various samples on different kinds of compute nodes or adjust their source code to experiment with different workloads.
<!---Mark each compatible Node in BOLD-->
| Node | Command |
| ----------------- | ------------------------------------------------------- |
| GPU | qsub -l nodes=1:gpu:ppn=2 -d . hello-world.sh |
| CPU | qsub -l nodes=1:xeon:ppn=2 -d . hello-world.sh |
| FPGA Compile Time | qsub -l nodes=1:fpga\_compile:ppn=2 -d . hello-world.sh |
| FPGA Runtime | qsub -l nodes=1:fpga\_runtime:ppn=2 -d . hello-world.sh |