Skip to content

Commit a8182e9

Browse files
authored
[doc] Format change for doc gen (#1725)
* Update api_doc.rst * format change in releases.md for doc gen
1 parent 069bf57 commit a8182e9

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

docs/tutorials/api_doc.rst

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ General
1313
The motivation of adding this alias is to unify the coding style in user scripts base on torch.xpu modular.
1414

1515
.. code-block:: python
16+
1617
>>> # bfloat16 inference case.
1718
>>> model = ...
1819
>>> model.load_state_dict(torch.load(PATH))

docs/tutorials/releases.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,11 @@ This release supports the following fusion patterns in PyTorch\* JIT mode:
6464

6565
### Known Issues
6666

67-
- #### [CRITICAL ERROR] Kernel 'XXX' removed due to usage of FP64 instructions unsupported by the targeted hardware
67+
#### [CRITICAL ERROR] Kernel 'XXX' removed due to usage of FP64 instructions unsupported by the targeted hardware
6868

6969
FP64 is not natively supported by the [Intel® Data Center GPU Flex Series](https://www.intel.com/content/www/us/en/products/docs/discrete-gpus/data-center-gpu/flex-series/overview.html) platform. If you run any AI workload on that platform and receive this error message, it means a kernel requiring FP64 instructions is removed and not executed, hence the accuracy of the whole workload is wrong.
7070

71-
- #### symbol undefined caused by _GLIBCXX_USE_CXX11_ABI:
71+
#### symbol undefined caused by \_GLIBCXX_USE_CXX11_ABI
7272

7373
Error info: <br>
7474

@@ -80,7 +80,7 @@ This release supports the following fusion patterns in PyTorch\* JIT mode:
8080

8181
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 to use gcc version 9.4.0 on ubuntu 20.04. <br>
8282

83-
- #### Can't find oneMKL library when build Intel® Extension for PyTorch\* without oneMKL
83+
#### Can't find oneMKL library when build Intel® Extension for PyTorch\* without oneMKL
8484

8585
Error info: <br>
8686

@@ -101,7 +101,7 @@ This release supports the following fusion patterns in PyTorch\* JIT mode:
101101

102102
Then clean build Intel® Extension for PyTorch\*.
103103

104-
- #### undefined symbol: mkl_lapack_dspevd. Intel MKL FATAL ERROR: cannot load libmkl_vml_avx512.so.2 or libmkl_vml_def.so.2
104+
#### undefined symbol: mkl_lapack_dspevd. Intel MKL FATAL ERROR: cannot load libmkl_vml_avx512.so.2 or libmkl_vml_def.so.2
105105

106106
This issue may occur when Intel® Extension for PyTorch\* is built with oneMKL library and PyTorch\* is not build with any MKL library. The oneMKL kernel may run into CPU backend incorrectly and trigger this issue. Resolve it by installing MKL library from conda:
107107

@@ -112,7 +112,7 @@ This release supports the following fusion patterns in PyTorch\* JIT mode:
112112

113113
then clean build PyTorch\*.
114114

115-
- #### OSError: libmkl_intel_lp64.so.1: cannot open shared object file: No such file or directory
115+
#### OSError: libmkl_intel_lp64.so.1: cannot open shared object file: No such file or directory
116116

117117
Wrong MKL library is used when multiple MKL libraries exist in system. Preload oneMKL by:
118118

0 commit comments

Comments
 (0)