Skip to content

Commit 79eb941

Browse files
Update Modin Get Started Readme with node and mode instruction (oneapi-src#831)
Co-authored-by: praveenkk123 <[email protected]>
1 parent 9c89ecb commit 79eb941

File tree

1 file changed

+33
-7
lines changed
  • AI-and-Analytics/Getting-Started-Samples/IntelModin_GettingStarted

1 file changed

+33
-7
lines changed

AI-and-Analytics/Getting-Started-Samples/IntelModin_GettingStarted/README.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ Intel Distribution of Modin* uses Ray or Dask to provide an effortless way to sp
1515
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.
1616

1717
## Key Implementation Details
18-
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).
18+
19+
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).
20+
1921

2022
## License
2123

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

2527
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).
2628

27-
## Building Intel Distribution of Modin* for CPU
29+
30+
## Running Samples on the Intel&reg; DevCloud
31+
If you are running this sample on the DevCloud, see [Running Samples on the Intel&reg; DevCloud](#run-samples-on-devcloud)
32+
33+
## Building Modin for CPU
34+
2835

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

@@ -83,9 +90,9 @@ Launch Jupyter Notebook in the directory housing the code example:
8390
jupyter notebook
8491
```
8592

86-
## Running the Sample
93+
## Running the Sample<a name="running-the-sample"></a>
8794

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

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

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

108115
##### Expected Printed Output:
109-
Expected Cell Output is shown in IntelModin_GettingStarted.ipynb.
116+
Expected Cell Output is shown in IntelModin_GettingStarted.ipynb
117+
118+
### Running Samples on the Intel&reg; DevCloud (Optional)<a name="run-samples-on-devcloud"></a>
119+
120+
<!---Include the next paragraph ONLY if the sample runs in batch mode-->
121+
### Run in Batch Mode
122+
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).
123+
124+
<!---Include the next paragraph ONLY if the sample DOES NOT RUN in batch mode-->
125+
### Run in Interactive Mode
126+
This sample runs in interactive mode. For more information, see [Run as Juypter Notebook](#run-as-jupyter-notebook).
127+
128+
### Request a Compute Node
129+
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.
130+
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:
110131

111-
### Build and run additional samples
112-
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.
132+
<!---Mark each compatible Node in BOLD-->
133+
| Node | Command |
134+
| ----------------- | ------------------------------------------------------- |
135+
| GPU | qsub -l nodes=1:gpu:ppn=2 -d . hello-world.sh |
136+
| CPU | qsub -l nodes=1:xeon:ppn=2 -d . hello-world.sh |
137+
| FPGA Compile Time | qsub -l nodes=1:fpga\_compile:ppn=2 -d . hello-world.sh |
138+
| FPGA Runtime | qsub -l nodes=1:fpga\_runtime:ppn=2 -d . hello-world.sh |
113139

0 commit comments

Comments
 (0)