oneapi-src / oneapi-src/unified-memory-framework
Extend documentation for memory providers
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- C
- Stars
- 98
- Forks
- 48
- Avg merge
- 3d 20h
- Merged PRs (30d)
- 6
Description
Description
- Today Memory provider API section contains only APIs from the memory_provider.h header.
- But also we should describe the umf_memory_provider_ops_t structure. It contains mandatory and optional interfaces (callbacks to implementation).
- Each memory provider implementation should describe which interfaces it implements. For example, L0 provider implements IPC but does not implement umf_memory_provider_ext_ops_t.
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 with the Memory provider API section linked in the issue and the interfaces declared in memory_provider.h, then inspect umf_memory_provider_ops_t and the provider implementations. Document the mandatory and optional callbacks, and record which interfaces each provider implements, including the L0 provider's IPC support and lack of umf_memory_provider_ext_ops_t.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100