Skip to content

Commit c88d5df

Browse files
authored
[UR] Add missing EXP-GRAPH.rst file (#20782)
1 parent 6dd1bc3 commit c88d5df

File tree

5 files changed

+110
-0
lines changed

5 files changed

+110
-0
lines changed

unified-runtime/include/ur_api.h

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

unified-runtime/include/ur_print.hpp

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<%
2+
OneApi=tags['$OneApi']
3+
x=tags['$x']
4+
X=x.upper()
5+
%>
6+
7+
.. _experimental-graph:
8+
9+
================================================================================
10+
Graph
11+
================================================================================
12+
13+
.. warning::
14+
15+
Experimental features:
16+
17+
* May be replaced, updated, or removed at any time.
18+
* Do not require maintaining API/ABI stability of their own additions over
19+
time.
20+
21+
22+
Motivation
23+
--------------------------------------------------------------------------------
24+
This extension introduces functionality for recording enqueued operations into a
25+
graph for later execution. Queues can enter graph capture mode, where operations
26+
enqueued to them are recorded into a graph instead of being executed immediately.
27+
This graph can then be instantiated as an executable graph and appended to a queue
28+
multiple times for repeated execution.
29+
30+
API
31+
--------------------------------------------------------------------------------
32+
33+
Enums
34+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35+
* ${x}_device_info_t
36+
* ${X}_DEVICE_INFO_GRAPH_RECORD_AND_REPLAY_SUPPORT_EXP
37+
38+
Functions
39+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40+
* Graph
41+
* ${x}GraphCreateExp
42+
* ${x}GraphInstantiateGraphExp
43+
* ${x}GraphDestroyExp
44+
* ${x}GraphExecutableGraphDestroyExp
45+
* ${x}GraphIsEmptyExp
46+
* ${x}GraphDumpContentsExp
47+
* Queue
48+
* ${x}QueueBeginGraphCaptureExp
49+
* ${x}QueueBeginCaptureIntoGraphExp
50+
* ${x}QueueEndGraphCaptureExp
51+
* ${x}QueueAppendGraphExp
52+
* ${x}QueueIsGraphCaptureEnabledExp
53+
54+
Changelog
55+
--------------------------------------------------------------------------------
56+
57+
+-----------+---------------------------------------------+
58+
| Revision | Changes |
59+
+===========+=============================================+
60+
| 1.0 | Initial Draft |
61+
+-----------+---------------------------------------------+
62+
| 1.1 | Extend ${x}_device_info_t enumerator with |
63+
| | graph record and replay entry. |
64+
+-----------+---------------------------------------------+
65+
66+
Support
67+
--------------------------------------------------------------------------------
68+
69+
Adapters which support this experimental feature *must* return true for the new
70+
``${X}_DEVICE_INFO_GRAPH_RECORD_AND_REPLAY_SUPPORT_EXP`` device info query.
71+
72+
Contributors
73+
--------------------------------------------------------------------------------
74+
75+
* Krzysztof, Filipek `[email protected] <[email protected]>`_
76+
* Krzysztof, Swiecicki `[email protected] <[email protected]>`_

unified-runtime/scripts/core/exp-graph.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,18 @@ type: handle
2424
desc: "Handle of record & replay executable graph object"
2525
name: "$x_exp_executable_graph_handle_t"
2626
--- #--------------------------------------------------------------------------
27+
type: enum
28+
extend: true
29+
typed_etors: true
30+
desc: "Extension enums to $x_device_info_t to support graph record and replay functionality."
31+
name: $x_device_info_t
32+
etors:
33+
- name: GRAPH_RECORD_AND_REPLAY_SUPPORT_EXP
34+
value: "0x2080"
35+
desc: |
36+
[$x_bool_t] returns true if the device supports graph record and replay
37+
functionality.
38+
--- #--------------------------------------------------------------------------
2739
type: function
2840
desc: "Create a new record & replay graph instance explicitly."
2941
class: $xGraph

unified-runtime/tools/urinfo/urinfo.hpp

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)