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.

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: update documentation #2129

Merged
merged 1 commit into from
Oct 10, 2024

Conversation

sgeor255
Copy link
Contributor

@sgeor255 sgeor255 commented Sep 27, 2024

This PR updates the documentation about SYCL primitives.

@sgeor255 sgeor255 requested review from a team as code owners September 27, 2024 15:11
@github-actions github-actions bot added documentation A request to change/fix/improve the documentation. Codeowner: @oneapi-src/onednn-doc platform:gpu-generic Codeowner: @oneapi-src/onednn-gpu-generic labels Sep 27, 2024
@sgeor255 sgeor255 force-pushed the svet/update-sycl-docs branch from 1a2a009 to 9c50b89 Compare October 3, 2024 15:33
@mgouicem mgouicem requested a review from ranukund October 4, 2024 08:38
Copy link
Contributor

@ranukund ranukund left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor changes suggested. Please incorporate as you see fit.

General limitations:

* Currently blocked formats are not supported by any implementation unless
explicitly listed
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems there's an extra space here.

@@ -33,11 +33,56 @@ one, the environment variable can be set to `cuda:*`.

# Supported Primitives

General limitations:

* Currently blocked formats are not supported by any implementation unless
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Currently blocked formats are not supported by any implementation unless
* Currently blocked formats are not supported by any implementations unless

## Batch Normalization

The implementation supports both forward and backward directions.

* Supported formats: `NCDHW`, `NDHWC`, `NCHW`, `NHWC`, `NCW`, `NWC`, `NC`
* Supported data types
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Supported data types
* Supported data types:


## Convolution

The implementation supports forward, backward data and backward weights
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The implementation supports forward, backward data and backward weights
The implementation supports forward data, backward data, and backward weight

directions.

* Supported input/output formats: plain formats
* Supported weights formats: `goiw`, `goihw`, `goidhw`, `oiw`, `oihw`, `oidhw`;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Supported weights formats: `goiw`, `goihw`, `goidhw`, `oiw`, `oihw`, `oidhw`;
* Supported weights formats: `goiw`, `goihw`, `goidhw`, `oiw`, `oihw`, `oidhw`

* Supported weights formats: `goiw`, `goihw`, `goidhw`, `oiw`, `oihw`, `oidhw`;
* Supported data types: `f32`, `bf16`, `f16`, `s32`, `s8`, `u8`
* Limitations
* Some very large problem sizes currently return `unimplemented` due to an
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Some very large problem sizes currently return `unimplemented` due to an
* Few substantial problem sizes currently return `unimplemented` due to an

directions.

* Supported input/output formats: plain formats
* Supported weights formats: `goiw`, `goihw`, `goidhw`, `oiw`, `oihw`, `oidhw`;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Supported weights formats: `goiw`, `goihw`, `goidhw`, `oiw`, `oihw`, `oidhw`;
* Supported weights formats: `goiw`, `goihw`, `goidhw`, `oiw`, `oihw`, `oidhw`

* Supported weights formats: `goiw`, `goihw`, `goidhw`, `oiw`, `oihw`, `oidhw`;
* Supported data types: `f32`, `bf16`, `f16`, `s32`, `s8`, `u8`
* Limitations
* Some very large problem sizes currently return `unimplemented` due to an
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Some very large problem sizes currently return `unimplemented` due to an
* Few substantial problem sizes currently return `unimplemented` due to an


## Pooling

The implementation supports both forward and backward directions.

* Supported formats: `NCDHW`, `NDHWC`, `NCHW`, `NHWC`, `NCW`, `NWC`
* Supported data types for forward direction: f32, bf16, f16, s8, u8
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Supported data types for forward direction: f32, bf16, f16, s8, u8
* Supported data types for forward direction: `f32`, `bf16`, `f16`, `s8`, `u8`


## Pooling

The implementation supports both forward and backward directions.

* Supported formats: `NCDHW`, `NDHWC`, `NCHW`, `NHWC`, `NCW`, `NWC`
* Supported data types for forward direction: f32, bf16, f16, s8, u8
* Supported data types for backward direction: f32, bf16, f16
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Supported data types for backward direction: f32, bf16, f16
* Supported data types for backward direction: `f32`, `bf16`, `f16`

@sgeor255 sgeor255 force-pushed the svet/update-sycl-docs branch from 9c50b89 to 93b7bd8 Compare October 9, 2024 16:30
@sgeor255
Copy link
Contributor Author

sgeor255 commented Oct 9, 2024

Minor changes suggested. Please incorporate as you see fit.

Thanks, @ranukund , I have made most of the suggested changes.

@avmanerikar avmanerikar merged commit 9db41d4 into oneapi-src:main Oct 10, 2024
25 checks passed
@vpirogov vpirogov added this to the v3.7 milestone Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation A request to change/fix/improve the documentation. Codeowner: @oneapi-src/onednn-doc platform:gpu-generic Codeowner: @oneapi-src/onednn-gpu-generic
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants