Skip to content

Commit ad5d07c

Browse files
committed
[SYCL][Graph][Doc] Update spec supported features
The following features are defined in the specification as unsupported, but have working implementations merged upstream. This PR updates the graphs specification to reflect that and removes some trailing whitespace. * intel#11418 * intel#11505 * intel#11556 * intel#11855
1 parent 0b6b3b8 commit ad5d07c

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

sycl/doc/extensions/experimental/sycl_ext_oneapi_graph.asciidoc

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -486,10 +486,10 @@ class depends_on {
486486
}
487487
----
488488

489-
==== Depends-On-All-Leaves Property
489+
==== Depends-On-All-Leaves Property
490490
The API for explicitly adding nodes to a `command_graph` includes a
491-
`property_list` parameter. This extension defines the `depends_on_all_leaves`
492-
property to be passed here. `depends_on_all_leaves` provides a shortcut for
491+
`property_list` parameter. This extension defines the `depends_on_all_leaves`
492+
property to be passed here. `depends_on_all_leaves` provides a shortcut for
493493
adding all the current leaves of a graph as dependencies.
494494
[source,c++]
495495
----
@@ -757,11 +757,11 @@ print_graph(std::string path, bool verbose = false) const;
757757
----
758758

759759
|Synchronous operation that writes a DOT formatted description of the graph to the
760-
provided path. By default, this includes the graph topology, node types, node id,
761-
and kernel names.
762-
Verbose can be set to true to write more detailed information about each node type
760+
provided path. By default, this includes the graph topology, node types, node id,
761+
and kernel names.
762+
Verbose can be set to true to write more detailed information about each node type
763763
such as kernel arguments, copy source, and destination addresses.
764-
At the moment DOT format is the only supported format. The name of hte output file
764+
At the moment DOT format is the only supported format. The name of the output file
765765
must therefore match this extension, i.e. "<filename>.dot".
766766

767767
Parameters:
@@ -772,7 +772,7 @@ or memory access where applicable.
772772

773773
Exceptions:
774774

775-
* Throws synchronously with error code `invalid` if the path is invalid or
775+
* Throws synchronously with error code `invalid` if the path is invalid or
776776
the file extension is not supported or if the write operation failed.
777777

778778
|===
@@ -1220,11 +1220,12 @@ passed an invalid event.
12201220

12211221
The new handler methods, and queue shortcuts, defined by
12221222
link:../supported/sycl_ext_oneapi_enqueue_barrier.asciidoc[sycl_ext_oneapi_enqueue_barrier]
1223-
cannot be used in graph nodes. A synchronous exception will be thrown with
1224-
error code `invalid` if a user tries to add them to a graph.
1225-
1226-
Removing this restriction is something we may look at for future revisions of
1227-
`sycl_ext_oneapi_graph`.
1223+
can only be used in graph nodes created using the Record & Replay API, as
1224+
barriers rely on events to enforce dependencies. A synchronous exception will be
1225+
thrown with error code `invalid` if a user tries to add them to a graph using
1226+
the Explicit API. Empty nodes created with the `node::depends_on_all_leaves`
1227+
property can be used instead of barriers when a user is building a graph with
1228+
the explicit API.
12281229

12291230
==== sycl_ext_oneapi_memcpy2d
12301231

@@ -1793,12 +1794,14 @@ if used in application code.
17931794
. Using `handler::memset` in a graph node.
17941795
. Using `handler::prefetch` in a graph node.
17951796
. Using `handler::memadvise` in a graph node.
1796-
. Using specialization constants in a graph node.
17971797
. Using reductions in a graph node.
17981798
. Using sycl streams in a graph node.
1799-
. Using a kernel bundle in a graph node.
18001799
. Profiling an event returned from graph submission with
18011800
`event::get_profiling_info()`.
1801+
. Level Zero immediate command-lists are not supported, and
1802+
`sycl::ext::intel::property::queue::no_immediate_command_list`
1803+
should be set on construction to any queues an executable
1804+
graph is submitted to.
18021805

18031806
== Revision History
18041807

0 commit comments

Comments
 (0)