Skip to content

Commit acd77d9

Browse files
cranechu0131cranechu0131
authored
Remove env variable BIGDL_LLM_XMX_DISABLED in documentation (#12445)
* fix: remove BIGDL_LLM_XMX_DISABLED in mddocs * fix: remove set SYCL_CACHE_PERSISTENT=1 in example * fix: remove BIGDL_LLM_XMX_DISABLED in workflows * fix: merge igpu and A-series Graphics * fix: remove set BIGDL_LLM_XMX_DISABLED=1 in example * fix: remove BIGDL_LLM_XMX_DISABLED in workflows * fix: merge igpu and A-series Graphics * fix: textual adjustment * fix: textual adjustment * fix: textual adjustment
1 parent f8c2bb2 commit acd77d9

File tree

122 files changed

+119
-1443
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

122 files changed

+119
-1443
lines changed

‎.github/workflows/llm_performance_tests.yml

-34
Original file line numberDiff line numberDiff line change
@@ -805,7 +805,6 @@ jobs:
805805
call conda activate igpu-perf
806806
if "${{ matrix.platform }}"=="perf-mtl" (
807807
set SYCL_CACHE_PERSISTENT=1
808-
set BIGDL_LLM_XMX_DISABLED=1
809808
)
810809
if "${{ matrix.platform }}"=="perf-lnl" (
811810
set SYCL_CACHE_PERSISTENT=1
@@ -841,7 +840,6 @@ jobs:
841840
842841
if "${{ matrix.platform }}"=="perf-mtl" (
843842
set SYCL_CACHE_PERSISTENT=1
844-
set BIGDL_LLM_XMX_DISABLED=1
845843
)
846844
if "${{ matrix.platform }}"=="perf-lnl" (
847845
set SYCL_CACHE_PERSISTENT=1
@@ -875,7 +873,6 @@ jobs:
875873
876874
if "${{ matrix.platform }}"=="perf-mtl" (
877875
set SYCL_CACHE_PERSISTENT=1
878-
set BIGDL_LLM_XMX_DISABLED=1
879876
)
880877
if "${{ matrix.platform }}"=="perf-lnl" (
881878
set SYCL_CACHE_PERSISTENT=1
@@ -910,7 +907,6 @@ jobs:
910907
911908
if "${{ matrix.platform }}"=="perf-mtl" (
912909
set SYCL_CACHE_PERSISTENT=1
913-
set BIGDL_LLM_XMX_DISABLED=1
914910
)
915911
if "${{ matrix.platform }}"=="perf-lnl" (
916912
set SYCL_CACHE_PERSISTENT=1
@@ -947,7 +943,6 @@ jobs:
947943
948944
if "${{ matrix.platform }}"=="perf-mtl" (
949945
set SYCL_CACHE_PERSISTENT=1
950-
set BIGDL_LLM_XMX_DISABLED=1
951946
)
952947
if "${{ matrix.platform }}"=="perf-lnl" (
953948
set SYCL_CACHE_PERSISTENT=1
@@ -1003,7 +998,6 @@ jobs:
1003998
1004999
if "${{ matrix.platform }}"=="perf-mtl" (
10051000
set SYCL_CACHE_PERSISTENT=1
1006-
set BIGDL_LLM_XMX_DISABLED=1
10071001
)
10081002
if "${{ matrix.platform }}"=="perf-lnl" (
10091003
set SYCL_CACHE_PERSISTENT=1
@@ -1039,7 +1033,6 @@ jobs:
10391033
10401034
if "${{ matrix.platform }}"=="perf-mtl" (
10411035
set SYCL_CACHE_PERSISTENT=1
1042-
set BIGDL_LLM_XMX_DISABLED=1
10431036
)
10441037
if "${{ matrix.platform }}"=="perf-lnl" (
10451038
set SYCL_CACHE_PERSISTENT=1
@@ -1073,7 +1066,6 @@ jobs:
10731066
10741067
if "${{ matrix.platform }}"=="perf-mtl" (
10751068
set SYCL_CACHE_PERSISTENT=1
1076-
set BIGDL_LLM_XMX_DISABLED=1
10771069
)
10781070
if "${{ matrix.platform }}"=="perf-lnl" (
10791071
set SYCL_CACHE_PERSISTENT=1
@@ -1108,7 +1100,6 @@ jobs:
11081100
11091101
if "${{ matrix.platform }}"=="perf-mtl" (
11101102
set SYCL_CACHE_PERSISTENT=1
1111-
set BIGDL_LLM_XMX_DISABLED=1
11121103
)
11131104
if "${{ matrix.platform }}"=="perf-lnl" (
11141105
set SYCL_CACHE_PERSISTENT=1
@@ -1145,7 +1136,6 @@ jobs:
11451136
11461137
if "${{ matrix.platform }}"=="perf-mtl" (
11471138
set SYCL_CACHE_PERSISTENT=1
1148-
set BIGDL_LLM_XMX_DISABLED=1
11491139
)
11501140
if "${{ matrix.platform }}"=="perf-lnl" (
11511141
set SYCL_CACHE_PERSISTENT=1
@@ -1200,7 +1190,6 @@ jobs:
12001190
12011191
if "${{ matrix.platform }}"=="perf-mtl" (
12021192
set SYCL_CACHE_PERSISTENT=1
1203-
set BIGDL_LLM_XMX_DISABLED=1
12041193
)
12051194
if "${{ matrix.platform }}"=="perf-lnl" (
12061195
set SYCL_CACHE_PERSISTENT=1
@@ -1236,7 +1225,6 @@ jobs:
12361225
12371226
if "${{ matrix.platform }}"=="perf-mtl" (
12381227
set SYCL_CACHE_PERSISTENT=1
1239-
set BIGDL_LLM_XMX_DISABLED=1
12401228
)
12411229
if "${{ matrix.platform }}"=="perf-lnl" (
12421230
set SYCL_CACHE_PERSISTENT=1
@@ -1270,7 +1258,6 @@ jobs:
12701258
12711259
if "${{ matrix.platform }}"=="perf-mtl" (
12721260
set SYCL_CACHE_PERSISTENT=1
1273-
set BIGDL_LLM_XMX_DISABLED=1
12741261
)
12751262
if "${{ matrix.platform }}"=="perf-lnl" (
12761263
set SYCL_CACHE_PERSISTENT=1
@@ -1305,7 +1292,6 @@ jobs:
13051292
13061293
if "${{ matrix.platform }}"=="perf-mtl" (
13071294
set SYCL_CACHE_PERSISTENT=1
1308-
set BIGDL_LLM_XMX_DISABLED=1
13091295
)
13101296
if "${{ matrix.platform }}"=="perf-lnl" (
13111297
set SYCL_CACHE_PERSISTENT=1
@@ -1342,7 +1328,6 @@ jobs:
13421328
13431329
if "${{ matrix.platform }}"=="perf-mtl" (
13441330
set SYCL_CACHE_PERSISTENT=1
1345-
set BIGDL_LLM_XMX_DISABLED=1
13461331
)
13471332
if "${{ matrix.platform }}"=="perf-lnl" (
13481333
set SYCL_CACHE_PERSISTENT=1
@@ -1397,7 +1382,6 @@ jobs:
13971382
13981383
if "${{ matrix.platform }}"=="perf-mtl" (
13991384
set SYCL_CACHE_PERSISTENT=1
1400-
set BIGDL_LLM_XMX_DISABLED=1
14011385
)
14021386
if "${{ matrix.platform }}"=="perf-lnl" (
14031387
set SYCL_CACHE_PERSISTENT=1
@@ -1435,7 +1419,6 @@ jobs:
14351419
14361420
if "${{ matrix.platform }}"=="perf-mtl" (
14371421
set SYCL_CACHE_PERSISTENT=1
1438-
set BIGDL_LLM_XMX_DISABLED=1
14391422
)
14401423
if "${{ matrix.platform }}"=="perf-lnl" (
14411424
set SYCL_CACHE_PERSISTENT=1
@@ -1474,7 +1457,6 @@ jobs:
14741457
14751458
if "${{ matrix.platform }}"=="perf-mtl" (
14761459
set SYCL_CACHE_PERSISTENT=1
1477-
set BIGDL_LLM_XMX_DISABLED=1
14781460
)
14791461
if "${{ matrix.platform }}"=="perf-lnl" (
14801462
set SYCL_CACHE_PERSISTENT=1
@@ -1522,7 +1504,6 @@ jobs:
15221504
15231505
if "${{ matrix.platform }}"=="perf-mtl" (
15241506
set SYCL_CACHE_PERSISTENT=1
1525-
set BIGDL_LLM_XMX_DISABLED=1
15261507
)
15271508
if "${{ matrix.platform }}"=="perf-lnl" (
15281509
set SYCL_CACHE_PERSISTENT=1
@@ -1572,7 +1553,6 @@ jobs:
15721553
15731554
if "${{ matrix.platform }}"=="perf-mtl" (
15741555
set SYCL_CACHE_PERSISTENT=1
1575-
set BIGDL_LLM_XMX_DISABLED=1
15761556
)
15771557
if "${{ matrix.platform }}"=="perf-lnl" (
15781558
set SYCL_CACHE_PERSISTENT=1
@@ -1642,7 +1622,6 @@ jobs:
16421622
16431623
if "${{ matrix.platform }}"=="perf-mtl" (
16441624
set SYCL_CACHE_PERSISTENT=1
1645-
set BIGDL_LLM_XMX_DISABLED=1
16461625
)
16471626
if "${{ matrix.platform }}"=="perf-lnl" (
16481627
set SYCL_CACHE_PERSISTENT=1
@@ -1680,7 +1659,6 @@ jobs:
16801659
16811660
if "${{ matrix.platform }}"=="perf-mtl" (
16821661
set SYCL_CACHE_PERSISTENT=1
1683-
set BIGDL_LLM_XMX_DISABLED=1
16841662
)
16851663
if "${{ matrix.platform }}"=="perf-lnl" (
16861664
set SYCL_CACHE_PERSISTENT=1
@@ -1717,7 +1695,6 @@ jobs:
17171695
17181696
if "${{ matrix.platform }}"=="perf-mtl" (
17191697
set SYCL_CACHE_PERSISTENT=1
1720-
set BIGDL_LLM_XMX_DISABLED=1
17211698
)
17221699
if "${{ matrix.platform }}"=="perf-lnl" (
17231700
set SYCL_CACHE_PERSISTENT=1
@@ -1756,7 +1733,6 @@ jobs:
17561733
17571734
if "${{ matrix.platform }}"=="perf-mtl" (
17581735
set SYCL_CACHE_PERSISTENT=1
1759-
set BIGDL_LLM_XMX_DISABLED=1
17601736
)
17611737
if "${{ matrix.platform }}"=="perf-lnl" (
17621738
set SYCL_CACHE_PERSISTENT=1
@@ -1814,7 +1790,6 @@ jobs:
18141790
18151791
if "${{ matrix.platform }}"=="perf-mtl" (
18161792
set SYCL_CACHE_PERSISTENT=1
1817-
set BIGDL_LLM_XMX_DISABLED=1
18181793
)
18191794
if "${{ matrix.platform }}"=="perf-lnl" (
18201795
set SYCL_CACHE_PERSISTENT=1
@@ -1852,7 +1827,6 @@ jobs:
18521827
18531828
if "${{ matrix.platform }}"=="perf-mtl" (
18541829
set SYCL_CACHE_PERSISTENT=1
1855-
set BIGDL_LLM_XMX_DISABLED=1
18561830
)
18571831
if "${{ matrix.platform }}"=="perf-lnl" (
18581832
set SYCL_CACHE_PERSISTENT=1
@@ -1888,7 +1862,6 @@ jobs:
18881862
18891863
if "${{ matrix.platform }}"=="perf-mtl" (
18901864
set SYCL_CACHE_PERSISTENT=1
1891-
set BIGDL_LLM_XMX_DISABLED=1
18921865
)
18931866
if "${{ matrix.platform }}"=="perf-lnl" (
18941867
set SYCL_CACHE_PERSISTENT=1
@@ -1925,7 +1898,6 @@ jobs:
19251898
19261899
if "${{ matrix.platform }}"=="perf-mtl" (
19271900
set SYCL_CACHE_PERSISTENT=1
1928-
set BIGDL_LLM_XMX_DISABLED=1
19291901
)
19301902
if "${{ matrix.platform }}"=="perf-lnl" (
19311903
set SYCL_CACHE_PERSISTENT=1
@@ -1964,7 +1936,6 @@ jobs:
19641936
19651937
if "${{ matrix.platform }}"=="perf-mtl" (
19661938
set SYCL_CACHE_PERSISTENT=1
1967-
set BIGDL_LLM_XMX_DISABLED=1
19681939
)
19691940
if "${{ matrix.platform }}"=="perf-lnl" (
19701941
set SYCL_CACHE_PERSISTENT=1
@@ -2021,7 +1992,6 @@ jobs:
20211992
20221993
if "${{ matrix.platform }}"=="perf-mtl" (
20231994
set SYCL_CACHE_PERSISTENT=1
2024-
set BIGDL_LLM_XMX_DISABLED=1
20251995
)
20261996
if "${{ matrix.platform }}"=="perf-lnl" (
20271997
set SYCL_CACHE_PERSISTENT=1
@@ -2059,7 +2029,6 @@ jobs:
20592029
20602030
if "${{ matrix.platform }}"=="perf-mtl" (
20612031
set SYCL_CACHE_PERSISTENT=1
2062-
set BIGDL_LLM_XMX_DISABLED=1
20632032
)
20642033
if "${{ matrix.platform }}"=="perf-lnl" (
20652034
set SYCL_CACHE_PERSISTENT=1
@@ -2095,7 +2064,6 @@ jobs:
20952064
20962065
if "${{ matrix.platform }}"=="perf-mtl" (
20972066
set SYCL_CACHE_PERSISTENT=1
2098-
set BIGDL_LLM_XMX_DISABLED=1
20992067
)
21002068
if "${{ matrix.platform }}"=="perf-lnl" (
21012069
set SYCL_CACHE_PERSISTENT=1
@@ -2132,7 +2100,6 @@ jobs:
21322100
21332101
if "${{ matrix.platform }}"=="perf-mtl" (
21342102
set SYCL_CACHE_PERSISTENT=1
2135-
set BIGDL_LLM_XMX_DISABLED=1
21362103
)
21372104
if "${{ matrix.platform }}"=="perf-lnl" (
21382105
set SYCL_CACHE_PERSISTENT=1
@@ -2171,7 +2138,6 @@ jobs:
21712138
21722139
if "${{ matrix.platform }}"=="perf-mtl" (
21732140
set SYCL_CACHE_PERSISTENT=1
2174-
set BIGDL_LLM_XMX_DISABLED=1
21752141
)
21762142
if "${{ matrix.platform }}"=="perf-lnl" (
21772143
set SYCL_CACHE_PERSISTENT=1

‎docs/mddocs/DockerGuides/docker_pytorch_inference_gpu.md

-4
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,6 @@ root@arda-arc12:/# sycl-ls
9797
> # Reduce memory accesses by fusing SDP ops.
9898
> # Recommended for use on Intel Data Center GPU Max Series.
9999
> export ENABLE_SDP_FUSION=1
100-
>
101-
> # Disable XMX computation.
102-
> # Recommended for use on integrated GPUs.
103-
> export BIGDL_LLM_XMX_DISABLED=1
104100
> ```
105101
106102

‎docs/mddocs/Overview/install_gpu.md

+1-8
Original file line numberDiff line numberDiff line change
@@ -150,13 +150,7 @@ call "C:\Program Files (x86)\Intel\oneAPI\setvars.bat"
150150

151151
Please also set the following environment variable if you would like to run LLMs on: -->
152152

153-
- For **Intel iGPU**:
154-
```cmd
155-
set SYCL_CACHE_PERSISTENT=1
156-
set BIGDL_LLM_XMX_DISABLED=1
157-
```
158-
159-
- For **Intel Arc™ A-Series Graphics**:
153+
- For **Intel iGPU** and **Intel Arc™ A-Series Graphics**:
160154
```cmd
161155
set SYCL_CACHE_PERSISTENT=1
162156
```
@@ -596,7 +590,6 @@ To use GPU acceleration on Linux, several environment variables are required or
596590
source /opt/intel/oneapi/setvars.sh
597591
598592
export SYCL_CACHE_PERSISTENT=1
599-
export BIGDL_LLM_XMX_DISABLED=1
600593
```
601594
602595
> [!NOTE]

‎docs/mddocs/Quickstart/benchmark_quickstart.md

+2-17
Original file line numberDiff line numberDiff line change
@@ -80,34 +80,19 @@ Some parameters in the yaml file that you can configure:
8080

8181
Please refer to [here](../Overview/install_gpu.md#runtime-configuration) to configure oneAPI environment variables. Choose corresponding commands base on your device.
8282

83-
- For **Intel iGPU**:
83+
- For **Intel iGPU** and **Intel Arc™ A-Series Graphics**:
8484

8585
```bash
8686
set SYCL_CACHE_PERSISTENT=1
87-
set BIGDL_LLM_XMX_DISABLED=1
8887
8988
python run.py
9089
```
9190

92-
- For **Intel Arc™ A300-Series or Pro A60**:
93-
94-
```bash
95-
set SYCL_CACHE_PERSISTENT=1
96-
python run.py
97-
```
98-
99-
- For **Other Intel dGPU Series**:
100-
101-
```bash
102-
# e.g. Arc™ A770
103-
python run.py
104-
```
105-
10691
## Run on Linux
10792

10893
Please choose corresponding commands base on your device.
10994

110-
- For **Intel Arc™ A-Series and Intel Data Center GPU Flex**:
95+
- For **Intel Arc™ A-Series** and **Intel Data Center GPU Flex**:
11196

11297
For Intel Arc™ A-Series Graphics and Intel Data Center GPU Flex Series, we recommend:
11398

‎docs/mddocs/Quickstart/install_linux_gpu.md

-1
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,6 @@ To use GPU acceleration on Linux, several environment variables are required or
422422
source /opt/intel/oneapi/setvars.sh
423423
424424
export SYCL_CACHE_PERSISTENT=1
425-
export BIGDL_LLM_XMX_DISABLED=1
426425
```
427426
428427
> [!NOTE]

‎docs/mddocs/Quickstart/install_linux_gpu.zh-CN.md

-1
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,6 @@ conda activate llm
390390
source /opt/intel/oneapi/setvars.sh
391391
392392
export SYCL_CACHE_PERSISTENT=1
393-
export BIGDL_LLM_XMX_DISABLED=1
394393
```
395394

396395
> [!NOTE]

‎docs/mddocs/Quickstart/install_windows_gpu.md

+2-9
Original file line numberDiff line numberDiff line change
@@ -109,19 +109,12 @@ You can verify if `ipex-llm` is successfully installed following below steps.
109109

110110
- Set the following environment variables according to your device:
111111

112-
- For **Intel iGPU**:
112+
- For **Intel iGPU** and **Intel Arc™ A770**:
113113

114114
```cmd
115115
set SYCL_CACHE_PERSISTENT=1
116-
set BIGDL_LLM_XMX_DISABLED=1
117116
```
118-
119-
- For **Intel Arc™ A770**:
120-
121-
```cmd
122-
set SYCL_CACHE_PERSISTENT=1
123-
```
124-
117+
125118
> [!TIP]
126119
> For other Intel dGPU Series, please refer to [this guide](../Overview/install_gpu.md#runtime-configuration) for more details regarding runtime configuration.
127120

‎docs/mddocs/Quickstart/install_windows_gpu.zh-CN.md

+1-8
Original file line numberDiff line numberDiff line change
@@ -108,14 +108,7 @@ conda activate llm
108108

109109
- 根据你的设备，设置以下环境参数：
110110

111-
- **Intel iGPU**:
112-
113-
```cmd
114-
set SYCL_CACHE_PERSISTENT=1
115-
set BIGDL_LLM_XMX_DISABLED=1
116-
```
117-
118-
- **Intel Arc™ A770**:
111+
- **Intel iGPU** and **Intel Arc™ A770**:
119112

120113
```cmd
121114
set SYCL_CACHE_PERSISTENT=1

0 commit comments

Comments
 (0)