docs bug fix (#2175)

* docs bug fix

---------

Co-authored-by: Ye Ting <[email protected]>

Author: jingxu10

docs/tutorials/getting_started.md

@@ -5,7 +5,7 @@
 Prebuilt wheel files are released for multiple Python versions. You can install them simply with the following pip command.
 
 ```bash
-python -m pip install torch==1.13.0a0 torchvision==0.14.0 intel_extension_for_pytorch==1.13.10+xpu -f https://developer.intel.com/ipex-whl-stable-xpu
+python -m pip install torch==1.13.0a0 torchvision==0.14.1a0 intel_extension_for_pytorch==1.13.10+xpu -f https://developer.intel.com/ipex-whl-stable-xpu
 ```
 
 You can run a simple sanity test to double confirm if the correct version is installed, and if the software stack can get correct hardware information onboard your system.

docs/tutorials/installation.md

@@ -40,17 +40,24 @@ Verified Hardware Platforms:
 Please refer to [Install oneAPI Base Toolkit Packages](https://www.intel.com/content/www/us/en/developer/tools/oneapi/toolkits.html#base-kit).
 
 Need to install components of Intel® oneAPI Base Toolkit:
- - Intel® oneAPI DPC++ Compiler
- - Intel® oneAPI Math Kernel Library (oneMKL)
+ - Intel® oneAPI DPC++ Compiler (`DPCPP_ROOT` as its installation path)
+ - Intel® oneAPI Math Kernel Library (oneMKL) (`MKL_ROOT` as its installation path)
 
-Default installation location *{ONEAPI_ROOT}* is `/opt/intel/oneapi` for root account, `${HOME}/intel/oneapi` for other accounts.
+Default installation location *{ONEAPI_ROOT}* is `/opt/intel/oneapi` for root account, `${HOME}/intel/oneapi` for other accounts. Generally, `DPCPP_ROOT` is `{ONEAPI_ROOT}/compiler/latest`, `MKL_ROOT` is `{ONEAPI_ROOT}/mkl/latest`.
 
 **_NOTE:_** You need to activate oneAPI environment when using Intel® Extension for PyTorch\* on Intel GPU.
 
 ```bash
 source {ONEAPI_ROOT}/setvars.sh
 ```
 
+**_NOTE:_** You need to activate ONLY DPC++ compiler and oneMKL environment when compiling Intel® Extension for PyTorch\* from source on Intel GPU.
+
+```bash
+source {DPCPP_ROOT}/env/vars.sh
+source {MKL_ROOT}/env/vars.sh
+```
+
 ## PyTorch-Intel® Extension for PyTorch\* Version Mapping
 
 Intel® Extension for PyTorch\* has to work with a corresponding version of PyTorch. Here are the PyTorch versions that we support and the mapping relationship:
@@ -69,41 +76,27 @@ Prebuilt wheel files availability matrix for Python versions:
 | 1.13.10+xpu |  | ✔️ | ✔️ | ✔️ | ✔️ |
 | 1.10.200+gpu | ✔️ | ✔️ | ✔️ | ✔️ |  |
 
-**Note:** Wheel files for Intel® Distribution for Python\* only supports Python 3.9.
-
-**Note:** Wheel files supporting Intel® Distribution for Python\* starts from 1.13.
+---
 
-### Repositories for prebuilt wheel files
+Prebuilt wheel files for generic Python\* and Intel® Distribution for Python\* are released in separate repositories.
 
-Prebuilt wheel files for generic Python\* and Intel® Distribution for Python\* are released in separate repositories. Replace the place holder `<REPO_URL>` in installation commands with a real URL below.
-
-```
-# Generic Python
-REPO_URL: https://developer.intel.com/ipex-whl-stable-xpu
+```bash
+# General Python*
+python -m pip install torch==1.13.0a0 torchvision==0.14.1a0 intel_extension_for_pytorch==1.13.10+xpu -f https://developer.intel.com/ipex-whl-stable-xpu
 
 # Intel® Distribution for Python*
-REPO_URL: https://developer.intel.com/ipex-whl-stable-xpu-idp
+python -m pip install torch==1.13.0a0 torchvision==0.14.1a0 intel_extension_for_pytorch==1.13.10+xpu -f https://developer.intel.com/ipex-whl-stable-xpu-idp
 ```
 
-### Install PyTorch and TorchVision
-
-```bash
-python -m pip install torch==1.13.0a0 torchvision==0.14.1a0 -f <REPO_URL>
-```
-
-**Note:** Installation of TorchVision is optional.
+**Note:** Wheel files for Intel® Distribution for Python\* only supports Python 3.9. The support starts from 1.13.10+xpu.
 
 **Note:** Please install Numpy 1.22.3 under Intel® Distribution for Python\*.
 
-### Install torchaudio (Optional)
-
-Intel® Extension for PyTorch\* doesn't depend on torchaudio. If you need TorchAudio, please follow the [instructions](https://github.com/pytorch/audio/tree/v0.13.0#from-source) to compile it from source. According to torchaudio-pytorch dependency table, torchaudio 0.13.0 is recommended.
+**Note:** Installation of TorchVision is optional.
 
-### Install Intel® Extension for PyTorch\*
+**Note:** Since DPC++ compiler doesn't support old [C++ ABI](https://gcc.gnu.org/onlinedocs/libstdc++/manual/using_dual_abi.html) (`_GLIBCXX_USE_CXX11_ABI=0`), ecosystem packages, including PyTorch and TorchVision, need to be compiled with the new C++ ABI (`_GLIBCXX_USE_CXX11_ABI=1`).
 
-```bash
-python -m pip install intel_extension_for_pytorch==1.13.10+xpu -f <REPO_URL>
-```
+**Note:** If you need TorchAudio, please follow the [instructions](https://github.com/pytorch/audio/tree/v0.13.0#from-source) to compile it from source. According to torchaudio-pytorch dependency table, torchaudio 0.13.0 is recommended.
 
 ## Install via compiling from source
 
@@ -126,15 +119,16 @@ $ cd pytorch
 $ git apply ${intel_extension_for_pytorch_directory}/torch_patches/*.patch 
 $ git submodule sync
 $ git submodule update --init --recursive
+$ conda install numpy ninja cmake
 $ pip install -r requirements.txt
-$ source {ONEAPI_ROOT}/setvars.sh
+$ export GLIBCXX_USE_CXX11_ABI=1
 $ python setup.py bdist_wheel
 $ pip install dist/*.whl
 ```
 
 ### Configure the AOT (Optional)
 
-Please refer to [AOT documentation](./AOT.md) for how to configure `USE_AOT_DEVLIST`. Without configuring AOT, the start-up time for processes using Intel® Extension for PyTorch\* will be high, so this step is important.
+Please refer to [AOT documentation](./AOT.md) for how to configure `USE_AOT_DEVLIST`. Without configuring AOT, the start-up time for processes using Intel® Extension for PyTorch\* will be long, so this step is important.
 
 ### Install Intel® Extension for PyTorch\*:
 
@@ -143,7 +137,9 @@ $ cd intel-extension-for-pytorch
 $ git submodule sync
 $ git submodule update --init --recursive
 $ pip install -r requirements.txt
-$ source {ONEAPI_ROOT}/setvars.sh # If you have sourced the oneAPI environment when compiling PyTorch, please skip this step.
+$ source {DPCPP_ROOT}/env/vars.sh
+$ source {MKL_ROOT}/env/vars.sh
+$ export USE_AOT_DEVLIST="..." # Set values accordingly
 $ python setup.py bdist_wheel
 $ pip install dist/*.whl
 ```

docs/tutorials/performance_tuning/known_issues.md

@@ -13,7 +13,7 @@ Known Issues
     ImportError: undefined symbol: _ZNK5torch8autograd4Node4nameB5cxx11Ev
     ```
 
-    DPC++ does not support `_GLIBCXX_USE_CXX11_ABI=0`, Intel® Extension for PyTorch\* is always compiled with `_GLIBCXX_USE_CXX11_ABI=1`. This symbol undefined issue appears when PyTorch\* is compiled with `_GLIBCXX_USE_CXX11_ABI=0`. Update PyTorch\* CMAKE file to set `_GLIBCXX_USE_CXX11_ABI=1` and compile PyTorch\* with particular compiler which supports `_GLIBCXX_USE_CXX11_ABI=1`. We recommend using prebuilt wheels in [download server](https://developer.intel.com/ipex-whl-stable-xpu) to avoid this issue.
+    DPC++ does not support `_GLIBCXX_USE_CXX11_ABI=0`, Intel® Extension for PyTorch\* is always compiled with `_GLIBCXX_USE_CXX11_ABI=1`. This symbol undefined issue appears when PyTorch\* is compiled with `_GLIBCXX_USE_CXX11_ABI=0`. Pass `export GLIBCXX_USE_CXX11_ABI=1` and compile PyTorch\* with particular compiler which supports `_GLIBCXX_USE_CXX11_ABI=1`. We recommend using prebuilt wheels in [download server](https://developer.intel.com/ipex-whl-stable-xpu) to avoid this issue.
 
 - Can't find oneMKL library when build Intel® Extension for PyTorch\* without oneMKL