Skip to content

[SYCL][Docs] Updates to experimental status spec #284

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

Merged
merged 1 commit into from
Aug 2, 2023
Merged

[SYCL][Docs] Updates to experimental status spec #284

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
25 changes: 19 additions & 6 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 @@ -1032,7 +1032,7 @@ modifiable graph will perform this action, useful in RAII pattern usage.
:host-task: https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#subsec:interfaces.hosttasks

It is not yet supported to have a host task inside a `command_graph`.
Support will be added subsequently as detailed in the <<host-tasks, host tasks>>
Support will be added subsequently as detailed in the <<future-host-tasks, host tasks>>
part from the <<future-direction, future direction>> section of this specification.

=== Queue Behavior In Recording Mode
Expand Down Expand Up @@ -1201,6 +1201,16 @@ 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`.

=== sycl_ext_oneapi_bindless_images

The new handler methods, and queue shortcuts, defined by
link:../experimental/sycl_ext_oneapi_bindless_images.asciidoc[sycl_ext_oneapi_bindless_images]
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`.

== Examples

[NOTE]
Expand Down Expand Up @@ -1502,7 +1512,7 @@ associated with a buffer that was created using a host data pointer will
outlive any executable graphs created from a modifiable graph which uses
that buffer.

=== Host Tasks [[host-tasks]]
=== Host Tasks [[future-host-tasks]]

A {host-task}[host task] is a native C++ callable, scheduled according to SYCL
dependency rules. It is valid to record a host task as part of graph, though it
Expand Down Expand Up @@ -1666,13 +1676,15 @@ The following features are not yet supported:
. Using `handler::fill` in a graph node implemented for USM only.
. Using `handler::memset` in a graph node.
. Using `handler::prefetch` in a graph node.
. Using handler::memadvise 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.
. Thread safety of new methods.
. Profiling an event returned from graph submission with `event::get_profiling_info()`.
. Subgraph can only be added as a node to any parent graph once, and will not correctly execute by itself after being added as a sub-graph.
. Profiling an event returned from graph submission with
`event::get_profiling_info()`.
. A sub-graph can only be added as a node to any parent graph once, and will not
correctly execute by itself after being added as a sub-graph.

== Revision History

Expand All @@ -1684,7 +1696,8 @@ The following features are not yet supported:

|1|2023-03-23|Pablo Reble, Ewan Crawford, Ben Tracy, Julian Miller
|Initial public working draft
|2|2023-08-01|Pablo Reble, Ewan Crawford, Ben Tracy, Julian Miller
|2|2023-08-01|Pablo Reble, Ewan Crawford, Ben Tracy, Julian Miller,
Maxime France-Pillois
|Promote status to experimental

|========================================