Skip to content
This repository was archived by the owner on Jul 18, 2024. It is now read-only.

Commit 5ddb2c6

Browse files
authored
[v1.1][ISSUE-218]update demo text and format (#289)
* update demo text and format Signed-off-by: Xue, Chendi <chendi.xue@intel.com> * update DLRM note on train section as well Signed-off-by: Xue, Chendi <chendi.xue@intel.com> --------- Signed-off-by: Xue, Chendi <chendi.xue@intel.com>
1 parent 5ae232d commit 5ddb2c6

2 files changed

Lines changed: 19 additions & 5 deletions

File tree

demo/builtin/dien/DIEN_DEMO.ipynb

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,11 +112,12 @@
112112
]
113113
},
114114
{
115+
"attachments": {},
115116
"cell_type": "markdown",
116117
"id": "2411d204",
117118
"metadata": {},
118119
"source": [
119-
"(Option 1) use pip install - recommended"
120+
"### (Option 1) Use Pip Install"
120121
]
121122
},
122123
{
@@ -133,11 +134,12 @@
133134
]
134135
},
135136
{
137+
"attachments": {},
136138
"cell_type": "markdown",
137139
"id": "acb73441",
138140
"metadata": {},
139141
"source": [
140-
"(Option 2) use docker\n",
142+
"### (Option 2) Use Docker\n",
141143
"``` bash\n",
142144
"# 1. git clone codes\n",
143145
"git clone https://github.com/intel/e2eAIOK.git\n",

demo/builtin/dlrm/DLRM_DEMO.ipynb

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,12 +208,13 @@
208208
]
209209
},
210210
{
211+
"attachments": {},
211212
"cell_type": "markdown",
212213
"id": "213dafa7",
213214
"metadata": {},
214215
"source": [
215216
"# Getting Started\n",
216-
"Noted: This demo needs to compile torch v1.5.0-rc3, ipex, torchCCL package, it was tested on bare metal environment. Due to the limitations of colab system, this notebook is only for presentation purpose.\n",
217+
"Noted: This demo needs to compile torch v1.5.0-rc3, ipex, torchCCL package, it was tested on bare metal environment. Due to the limitations of colab system, this notebook is only for presentation purpose. Result AUC showed is trained with a small sample dataset. Full dataset result please refer to [performance section](#performance). \n",
217218
"\n",
218219
" * [1. Environment Setup](#1.-Environment-Setup)\n",
219220
" * [2. Workflow Prepare](#2.-Workflow-Prepare)\n",
@@ -231,11 +232,12 @@
231232
]
232233
},
233234
{
235+
"attachments": {},
234236
"cell_type": "markdown",
235237
"id": "61f9eafa",
236238
"metadata": {},
237239
"source": [
238-
"(Option 1) use pip - DLRM model is based on DLRM MLPerf Training 0.7 Intel submission\n",
240+
"### (Option 1) Use Pip install\n",
239241
"\n",
240242
" * source: https://github.com/mlperf/training_results_v0.7/tree/master/Intel/benchmarks/dlrm/1-node-4s-cpx-pytorch\n",
241243
" * It has strict dependencies to GCC version, torch version, oneCCL version."
@@ -277,11 +279,12 @@
277279
]
278280
},
279281
{
282+
"attachments": {},
280283
"cell_type": "markdown",
281284
"id": "4cf5ce5f",
282285
"metadata": {},
283286
"source": [
284-
"(Option 2) use docker"
287+
"### (Option 2) Use Docker"
285288
]
286289
},
287290
{
@@ -559,6 +562,15 @@
559562
"Noticed: set enable_sigopt to True, SDA will explore HyperParameter for this model. In our demo, we will use our searched best parameter."
560563
]
561564
},
565+
{
566+
"attachments": {},
567+
"cell_type": "markdown",
568+
"id": "2fbda6f7",
569+
"metadata": {},
570+
"source": [
571+
"> Note: Bellow training script is just for demonstration, and uses small sampled dataset and runs a small iterations. For actual performance result, please refer to [performance](#performance)"
572+
]
573+
},
562574
{
563575
"cell_type": "code",
564576
"execution_count": 1,

0 commit comments

Comments
 (0)