Skip to content

Commit cc4cc44

Browse files
bdmoore1JoeOster
andauthored
node and mode update for daal4py readme (oneapi-src#519)
* node and mode update for daal4py readme * Update README.md * Update README.md * moved devcloud instructions under jupyter * fixed .ipynb typo Co-authored-by: JoeOster <[email protected]>
1 parent 89af9df commit cc4cc44

File tree

1 file changed

+30
-5
lines changed
  • AI-and-Analytics/Getting-Started-Samples/IntelPython_daal4py_GettingStarted

1 file changed

+30
-5
lines changed

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

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ Code samples are licensed under the MIT license. See
2424

2525
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)
2626

27+
## Running Samples on the Intel&reg; DevCloud
28+
If you are running this sample on the DevCloud, see [Running Samples on the Intel&reg; DevCloud](#run-samples-on-devcloud)
29+
2730
## Building daal4py for CPU
2831

2932
oneAPI Data Analytics Library is ready for use once you finish the Intel® oneAPI AI Analytics Toolkit installation and have run the post installation script.
@@ -73,11 +76,11 @@ Launch Jupyter Notebook in the directory housing the code example
7376
```
7477
jupyter notebook
7578
```
76-
## Running the Sample
79+
## Running the Sample<a name="running-the-sample"></a>
7780

78-
### Running the Sample as a Jupyter Notebook
81+
### Running the Sample as a Jupyter Notebook<a name="run-as-jupyter-notebook"></a>
7982

80-
Open .pynb file and run cells in Jupyter Notebook using the "Run" button (see image)
83+
Open .ipynb file and run cells in Jupyter Notebook using the "Run" button (see image)
8184

8285
![Click the Run Button in the Jupyter Notebook](Jupyter_Run.jpg "Run Button on Jupyter Notebook")
8386

@@ -121,7 +124,30 @@ Run the Program
121124

122125
`python IntelPython_daal4py_GettingStarted.py`
123126

124-
The output files of the script will be saved in the included models and result directories.
127+
The output files of the script will be saved in the included models and result directories.
128+
129+
### Running Samples on the Intel&reg; DevCloud (Optional)<a name="run-samples-on-devcloud"></a>
130+
131+
<!---Include the next paragraph ONLY if the sample runs in batch mode-->
132+
### Run in Batch Mode
133+
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).
134+
135+
<!---Include the next paragraph ONLY if the sample DOES NOT RUN in batch mode-->
136+
### Run in Interactive Mode
137+
This sample runs in interactive mode. For more information, see [Run as Juypter Notebook](#run-as-jupyter-notebook).
138+
139+
### Request a Compute Node
140+
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.
141+
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:
142+
143+
<!---Mark each compatible Node in BOLD-->
144+
| Node | Command |
145+
| ----------------- | ------------------------------------------------------- |
146+
| GPU | qsub -l nodes=1:gpu:ppn=2 -d . hello-world.sh |
147+
| __CPU__ | __qsub -l nodes=1:xeon:ppn=2 -d . hello-world.sh__ |
148+
| FPGA Compile Time | qsub -l nodes=1:fpga\_compile:ppn=2 -d . hello-world.sh |
149+
| FPGA Runtime | qsub -l nodes=1:fpga\_runtime:ppn=2 -d . hello-world.sh |
150+
125151

126152
##### Expected Printed Output (with similar numbers):
127153
```
@@ -151,4 +177,3 @@ Here is one of our loaded model's features:
151177
1.58423529e-02 -4.57542900e-01]]
152178
[CODE_SAMPLE_COMPLETED_SUCCESFULLY]
153179
```
154-

0 commit comments

Comments
 (0)