Skip to content

Commit f66e152

Browse files
committed
update CANN.md
1 parent 8c3df5e commit f66e152

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/backend/CANN.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
- [DataType Supports](#datatype-supports)
99
- [Docker](#docker)
1010
- [Linux](#linux)
11+
- [Environment variable setup](#environment-variable-setup)
1112
- [TODO](#todo)
1213

1314

@@ -281,5 +282,29 @@ cmake --build build --config release
281282
Please add the **[CANN]** prefix/tag in issues/PRs titles to help the CANN-team check/address them without delay.
282283

283284

285+
## Environment variable setup
286+
287+
### GGML_CANN_ASYNC_MODE
288+
289+
`GGML_CANN_ASYNC_MODE` controls whether asynchronous commit mode is enabled(default closed state), which can help speed up model execution. Yes, enable, y, 1, on ,true(case insensitive) are all valid values to enable `GGML_CANN_ASYNC_MODE`, such as `export GGML_CANN_ASYNC_MODE=yEs`.
290+
291+
292+
293+
### GGML_CANN_MEM_POOL
294+
295+
three cases here:
296+
297+
- By setting `export GGML_CANN_MEM_POOL=pRio` (the value is case-insensitive), you specify the use of a priority queue-based memory pool.
298+
299+
- Legacy memory pools are enabled when VMM is not available or when `export GGML_CANN_MEM_POOL=leg` is set.
300+
301+
- default VMM
302+
303+
### GGML_CANN_DISABLE_BUF_POOL_CLEAN
304+
305+
`GGML_CANN_DISABLE_BUF_POOL_CLEAN` is used to disable the buffer pool cleaning feature.
306+
The values **yes**, **enable**, **y**, **1**, **on**, and **true** (case-insensitive) are all valid to enable `GGML_CANN_DISABLE_BUF_POOL_CLEAN`. such as `export GGML_CANN_DISABLE_BUF_POOL_CLEAN=yEs`.
307+
308+
284309
## TODO
285310
- Support more models and data types.

0 commit comments

Comments
 (0)