[SYCL][UR][L0] Update documentation on env vars for L0 plugin #9350
Conversation
| variables in production code.</span> | ||
| variables in production code. Please prefix them with `UR_L0_` or | ||
| `SYCL_PI_LEVEL_ZERO_`. `SYCL_PI_LEVEL_ZERO_` will be deprecated in upcoming | ||
| versions releases. </span> |
There was a problem hiding this comment.
@smaslov-intel : Do you think this is ok, or would you prefer having the table below with each entry with the old and new names, something like:
| Environment variable | Values | Description |
|---|---|---|
| UR_L0_SINGLE_THREAD_MODE, SYCL_PI_LEVEL_ZERO_SINGLE_THREAD_MODE (deprecated) | Integer | A single-threaded app has an opportunity to enable this mode to avoid overhead from mutex locking in the Level Zero plugin. A value greater than 0 enables single thread mode. A value of 0 disables single thread mode. The default is 0. |
There was a problem hiding this comment.
I think the documentation of UR_L0 env vars should be moved under https://github.com/intel/llvm/tree/sycl/sycl/plugins/unified_runtime/ur/adapters/level_zero
In this file we'd provide a mapping from SYCL_PI_LEVEL_ZERO to UR_L0 ones, and link to their definitions (and also mention that SYCL_PI_LEVEL_ZERO are deprecated).
There was a problem hiding this comment.
Thanks @smaslov-intel . Moving this to draft then while I open a PR in the adapter and then will update back here once we have a link.
Signed-off-by: Jaime Arteaga <[email protected]>
| | `USM_ALLOCATOR` | [EnableBuffers][;[MaxPoolSize][;[host\|device\|shared:][MaxPoolableSize][,[Capacity][,SlabMinSize]]]...] | EnableBuffers enables pooling for SYCL buffers, default 0, set to 1 to enable. MaxPoolSize is the maximum size of the pool, default 0. MemType is host, device or shared. Other parameters are values specified as positive integers with optional K, M or G suffix. MaxPoolableSize is the maximum allocation size that may be pooled, default 0 for host and shared, 32KB for device. Capacity is the number of allocations in each size range freed by the program but retained in the pool for reallocation, default 0. Size ranges follow this pattern: 64, 96, 128, 192, and so on, i.e., powers of 2, with one range in between. SlabMinSize is the minimum allocation size, 64KB for host and device, 2MB for shared. Example: SYCL_PI_LEVEL_ZERO_USM_ALLOCATOR=1;32M;host:1M,4,64K;device:1M,4,64K;shared:0,0,2M| | ||
| | `BATCH_SIZE` | Integer | Sets a preferred number of compute commands to batch into a command list before executing the command list. A value of 0 causes the batch size to be adjusted dynamically. A value greater than 0 specifies fixed size batching, with the batch size set to the specified value. The default is 0. | | ||
| | `COPY_BATCH_SIZE` | Integer | Sets a preferred number of copy commands to batch into a command list before executing the command list. A value of 0 causes the batch size to be adjusted dynamically. A value greater than 0 specifies fixed size batching, with the batch size set to the specified value. The default is 0. | | ||
| | `FILTER_EVENT_WAIT_LIST` | Integer | When set to 0, disables filtering of signaled events from wait lists when using the Level Zero backend. The default is 0. | |
There was a problem hiding this comment.
Perhaps this would be better filed as an issue, but in current sycl branch at least there is no UR_L0_FILTER_EVENT_WAIT_LIST code, just the code for SYCL_PI_LEVEL_ZERO_FILTER_EVENT_WAIT_LIST.
|
This pull request is stale because it has been open 180 days with no activity. Remove stale label or comment or this will be automatically closed in 30 days. |
|
This pull request was closed because it has been stalled for 30 days with no activity. |
No description provided.