Skip to content

Commit 453ffdc

Browse files
authored
[SYCL][UR][Doc] Add README.md for the Unified Runtime directory (#9939)
Add a readme to point contributors to the UR repository so PI changes which require changes to the UR spec are correctly handled
1 parent 8f09d3e commit 453ffdc

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Unified Runtime
2+
3+
This directory contains the implementation of the PI plugin for Unified Runtime,
4+
including the pi2ur translation layer, as well as the sources for the individual
5+
Unified Runtime adapters.
6+
7+
## Making changes to Unified Runtime
8+
If you introduce changes to PI (e.g. new entry points, new enum values) you
9+
should introduce matching changes to the Unified Runtime spec.
10+
11+
To do this, open a Pull Request adding the changes to the
12+
[Unified Runtime](https://github.com/oneapi-src/unified-runtime)
13+
repository, making sure to follow the
14+
[Contribution Guide](https://oneapi-src.github.io/unified-runtime/core/CONTRIB.html).
15+
16+
When your changes to Unified Runtime are merged, you should:
17+
* Update the UR commit used by changing the `UNIFIED_RUNTIME_TAG` value in
18+
[`CMakeLists.txt`](CMakeLists.txt)
19+
* Make changes to [`pi2ur.hpp`](pi2ur.hpp) to ensure correct mapping from PI to
20+
UR
21+
* Make changes to the affected adapter implementations in the
22+
[`ur/adapters`](ur/adapters) folder

0 commit comments

Comments
 (0)