KhronosGroup / KhronosGroup/OpenCL-Docs
Clarify CL_DEVICE_LOCAL_MEM_SIZE
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 421
- Forks
- 132
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 11
Description
The definition of CL_DEVICE_LOCAL_MEM_SIZE is given as:
Size of local memory region in bytes. The minimum value is 32 KB for devices that are not of type CL_DEVICE_TYPE_CUSTOM.
I think the meaning of "local memory region" here is ambiguous, because it could refer to either:
- The size of the physical local memory present in each compute unit; or
- The maximum amount of local memory available to a single work-group.
Based on the behavior of existing implementations, it seems that the intent is 2). Wording like the following would be clearer:
Maximum amount of local memory available to each work-group, in bytes. The minimum value is 32 KB for devices that are not of type CL_DEVICE_TYPE_CUSTOM.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by searching the OpenCL-Docs sources for CL_DEVICE_LOCAL_MEM_SIZE and compare its definition with the linked OpenCL 3.0 specification. Review nearby device-query documentation for consistent terminology, then verify that the revised wording distinguishes work-group availability from physical device memory and preserves the stated minimum.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100