Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SYCL][Graph] Update spec supported features #341

Closed
wants to merge 1 commit into from
Closed

[SYCL][Graph] Update spec supported features #341

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 18 additions & 15 deletions sycl/doc/extensions/experimental/sycl_ext_oneapi_graph.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,10 +486,10 @@ class depends_on {
}
----

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

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

Parameters:
Expand All @@ -772,7 +772,7 @@ or memory access where applicable.

Exceptions:

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

|===
Expand Down Expand Up @@ -1220,11 +1220,12 @@ passed an invalid event.

The new handler methods, and queue shortcuts, defined by
link:../supported/sycl_ext_oneapi_enqueue_barrier.asciidoc[sycl_ext_oneapi_enqueue_barrier]
cannot be used in graph nodes. A synchronous exception will be thrown with
error code `invalid` if a user tries to add them to a graph.

Removing this restriction is something we may look at for future revisions of
`sycl_ext_oneapi_graph`.
can only be used in graph nodes created using the Record & Replay API, as
barriers rely on events to enforce dependencies. A synchronous exception will be
thrown with error code `invalid` if a user tries to add them to a graph using
the Explicit API. Empty nodes created with the `node::depends_on_all_leaves`
property can be used instead of barriers when a user is building a graph with
the explicit API.

==== sycl_ext_oneapi_memcpy2d

Expand Down Expand Up @@ -1793,12 +1794,14 @@ if used in application code.
. Using `handler::memset` in a graph node.
. Using `handler::prefetch` in a graph node.
. Using `handler::memadvise` in a graph node.
. Using specialization constants in a graph node.
. Using reductions in a graph node.
. Using sycl streams in a graph node.
. Using a kernel bundle in a graph node.
. Profiling an event returned from graph submission with
`event::get_profiling_info()`.
. Level Zero immediate command-lists are not supported, and
`sycl::ext::intel::property::queue::no_immediate_command_list`
should be set on construction to any queues an executable
graph is submitted to.

== Revision History

Expand Down