Skip to content

[SYCL][Doc] Device query for graphs support #178

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 2 commits into from
May 22, 2023
Merged

[SYCL][Doc] Device query for graphs support #178

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8eb1cae
[SYCL][Doc] Device query for graphs support
May 17, 2023
bab9c2b
Return an enum rather than bool from device query
May 18, 2023
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
41 changes: 41 additions & 0 deletions sycl/doc/extensions/proposed/sycl_ext_oneapi_graph.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,20 @@ class depends_on {
} // namespace node
} // namespace property

// Device query for level of support
namespace info {
namespace device {
struct graphs_support;

enum class graph_support_level {
unsupported = 0,
native,
emulated
};

} // namespace device
} // namespace info

class node {};

// State of a graph
Expand Down Expand Up @@ -404,6 +418,30 @@ public:
} // namespace sycl
----

=== Device Info Query

Due to the experimental nature of the extension, support is not available across
all devices. The following device support query is added to report devices which
are currently supported, and how that support is implemented.


Table {counter: tableNumber}. Device Info Queries.
[%header]
|===
| Device Descriptors | Return Type | Description

|`info::device::graph_support`
|`info::device::graph_support_level`
|When passed to `device::get_info<...>()`, the function returns `native`
if there is an underlying SYCL backend command-buffer construct which is used
to propagate the graph to the backend. If no backend construct exists, or
building on top of it has not yet been implemented, then `emulated` is
returned. Otherwise `unsupported` is returned if the SYCL device doesn't
support using this graph extension.

|===


=== Node

:crs: https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html#sec:reference-semantics
Expand Down Expand Up @@ -548,6 +586,9 @@ Exceptions:
* Throws synchronously with error code `invalid` if `syclDevice` is not
associated with `syclContext`.

* Throws synchronously with error code `invalid` if `syclDevice`
<<device-info-query, reports this extension as unsupported>>.

|===

Table {counter: tableNumber}. Member functions of the `command_graph` class.
Expand Down