modify readme for jupyterlab extension (#1298)

* modify readme for jupyterlab extension

* fix typo

Author: kaikaiyao

neural_coder/backends/.yaml

@@ -0,0 +1,51 @@
+# Copyright (c) 2022 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+transformation:
+  location:
+    -
+    -
+    -
+  content:
+    - |-
+      [+] YOUR CODE LINE 1
+      [+] YOUR CODE LINE 2
+      [+] YOUR CODE LINE 3
+    - |-
+      [+] YOUR CODE LINE 1
+      [+] YOUR CODE LINE 2
+      [+] YOUR CODE LINE 3
+    - |-
+      [+] YOUR CODE LINE 1
+      [+] YOUR CODE LINE 2
+      [+] YOUR CODE LINE 3
+  order:
+    - below:
+        -
+        -
+      above:
+        -
+        -
+    - below:
+        -
+        -
+      above:
+        -
+        -
+    - below:
+        -
+        -
+      above:
+        -
+        -

neural_coder/docs/IntelCPU_PerformanceSetting.md

@@ -1,27 +1,32 @@
 ## Intel CPU Platforms: Best Performance Setting
 ### Install MKL, OpenMP and JEMALLOC
 Through CONDA is the simplest way:
-```python
+```bash
 conda install -y mkl mkl-include jemalloc
 ```
 
+### Install NUMA Controller
+```bash
+apt-get update && apt-get install bc numactl
+```
+
 ### Environment Variables
 Check if your ```CONDA_PREFIX``` has a value by:
-```
+```bash
 echo ${CONDA_PREFIX}
 ```
 If it's empty, it means that you're not in a traditional CONDA environment, you need to find the location of the ```.so.``` files by:
-```
+```bash
 find / -name "libjemalloc.so"
 find / -name "libiomp5.so"
 ```
 It will show the path these file were installed into, for example:
-```
+```bash
 /home/name/lib/libjemalloc.so
 /home/name/lib/libiomp5.so
 ```
 And then you should export this path as ```CONDA_PREFIX```:
-```
+```bash
 export CONDA_PREFIX="/home/name"
 ```
 Finally:
@@ -40,7 +45,7 @@ Check frequency governer state on your machine:
 cat /sys/devices/system/cpu/cpu*/cpufreq/scaling_governor
 ```
 If is shows ```powersave``` instead of ```performance```, execute:
-```
+```bash
 echo "performance" | sudo tee /sys/devices/system/cpu/cpu*/cpufreq/scaling_governor
 cat /sys/devices/system/cpu/cpu*/cpufreq/scaling_governor
 ```

neural_coder/extensions/neural_compressor_ext_lab/README.md

@@ -3,12 +3,13 @@ Intel® Neural Compressor as JupyterLab Extension
 A JupyterLab Extension library supporting Neural Coder, a novel feature powered by Intel® Neural Compressor providing automatic quantization to further simplify computing performance optimizations of Deep Learning models.
 
 ## Installation
-**By Extension Manager in JupyterLab**
+**By Extension Manager in JupyterLab (Recommended)**
 
-Search for ```jupyter-lab-neural-compressor``` in the Extension Manager in JupyterLab. Note that this works for the stable version of JupyterLab 3.
+Search for ```jupyter-lab-neural-compressor``` in the Extension Manager in JupyterLab.
 
 **By Linux Terminal**
-```Shell
+```bash
+npm i jupyter-lab-neural-compressor
 jupyter labextension install jupyter-lab-neural-compressor
 ```
 
@@ -35,3 +36,10 @@ In the new cell box appeared below your Code cell boxes, you can see the executi
 When it is finished, you can also see that the code changes for the best optimization are automatically enabled into your script:
 
 <img src="../screenshots/5.png" alt="Architecture" width="55%" height="55%">
+
+## Pre-requisites
+```bash
+apt-get update && apt-get install bc numactl
+conda install mkl mkl-include jemalloc
+pip3 install neural-compressor opencv-python-headless
+```