Skip to content

Commit e44d99c

Browse files
committed
update CANN.md
1 parent d8b5015 commit e44d99c

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

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

261262

263+
## Environment variable setup
264+
265+
### GGML_CANN_ASYNC_MODE
266+
267+
`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`.
268+
269+
270+
271+
### GGML_CANN_MEM_POOL
272+
273+
three cases here:
274+
275+
- By setting `export GGML_CANN_MEM_POOL=pRio` (the value is case-insensitive), you specify the use of a priority queue-based memory pool.
276+
277+
- Legacy memory pools are enabled when VMM is not available or when `export GGML_CANN_MEM_POOL=leg` is set.
278+
279+
- default VMM
280+
281+
### GGML_CANN_DISABLE_BUF_POOL_CLEAN
282+
283+
`GGML_CANN_DISABLE_BUF_POOL_CLEAN` is used to disable the buffer pool cleaning feature.
284+
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`.
285+
286+
262287
## TODO
263288
- Support more models and data types.

0 commit comments

Comments
 (0)