Skip to content

Adding fp8 to ukernel documentation #3445

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

Merged
merged 3 commits into from
Jul 2, 2025
Merged

Adding fp8 to ukernel documentation #3445

merged 3 commits into from
Jul 2, 2025

Conversation

vpirogov
Copy link
Contributor

This PR documents fp8 support in ukernel API.

Bonus typo fixes:

  • Missing spaces in ISA descriptions
  • Wording in developer guide index

@vpirogov vpirogov requested review from a team as code owners June 18, 2025 22:13
@github-actions github-actions bot added documentation A request to change/fix/improve the documentation. Codeowner: @oneapi-src/onednn-doc platform:cpu-x64 Intel64/AMD64 processors. Codeowner: @oneapi-src/onednn-cpu-x64 labels Jun 18, 2025
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.

Functional API - the terminology hasn't been promoted or described in the documentation yet (apart from Examples and Tutorials); the key concepts section doesn't mention that the core API is called the functional API. We can have an overview page under "Learn" module and describe the APIs (functional and graph). Should the "Functional API" naming be promoted without any prior context? My two cents.

@vpirogov
Copy link
Contributor Author

vpirogov commented Jun 24, 2025

Functional API - the terminology hasn't been promoted or described in the documentation yet (apart from Examples and Tutorials); the key concepts section doesn't mention that the core API is called the functional API. We can have an overview page under "Learn" module and describe the APIs (functional and graph). Should the "Functional API" naming be promoted without any prior context? My two cents.

With the new documentation structure we need a term to identify "classical" oneDNN API and differentiate it from Graph and ukernel. Specifically the following content is covering "classical" API:

"Functional API" is a term that I would use, but I'm open to suggestions.

+@uxlfoundation/onednn-arch for additional input

@vpirogov vpirogov merged commit f97f07d into main Jul 2, 2025
13 checks passed
@vpirogov vpirogov deleted the vpirogov/doc-update branch July 2, 2025 16:46
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:cpu-x64 Intel64/AMD64 processors. Codeowner: @oneapi-src/onednn-cpu-x64
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants