Skip to content

various improvements for examples documentation #3326

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

Jump to bottom
Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

various improvements for examples documentation #3326

wants to merge 6 commits into from

Conversation

mzhukova
Copy link
Contributor

@mzhukova mzhukova commented May 23, 2025 •
edited
Loading

First step for improving examples page as planned in https://jira.devtools.intel.com/browse/DOC-13143

Summary of changes:

  • Fixed a few spellings
  • Added brief documentation to matmul_perf.cpp and sycl_interop_usm.cpp
  • Added missing/already documented examples to the table (currently skipping examples for Primitives since they would require a new category, will be done in the future PR)

@mzhukova mzhukova self-assigned this May 23, 2025
@github-actions github-actions bot added documentation A request to change/fix/improve the documentation. Codeowner: @oneapi-src/onednn-doc component:examples labels May 23, 2025
@mzhukova
Copy link
Contributor Author

make test
disable build_vendor_intel
disable run_source_scans
enable run_documentation

@mzhukova mzhukova marked this pull request as ready for review May 27, 2025 17:14
@mzhukova mzhukova requested review from a team as code owners May 27, 2025 17:14
ranukund
ranukund reviewed May 27, 2025
View reviewed changes
@mzhukova mzhukova requested a review from ranukund May 28, 2025 20:36
@mzhukova
Copy link
Contributor Author

hi @uxlfoundation/onednn-doc and @uxlfoundation/onednn-arch, could you please review / approve?

vpirogov
vpirogov reviewed May 30, 2025
View reviewed changes
doc/examples.md
| | CPU | | @ref cpu_cnn_training_f32_c |
| | CPU/GPU | @ref rnn_training_f32_cpp | |
| bf16 training | CPU/GPU | @ref cnn_training_bf16_cpp | |
| Graph API | CPU | @ref graph_cpu_getting_started_cpp | |
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you please split examples into two separate tables by API:

  • Functional API
  • Graph API

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vpirogov vpirogov vpirogov approved these changes

@ranukund ranukund Awaiting requested review from ranukund

At least 2 approving reviews are required to merge this pull request.

Assignees

@mzhukova mzhukova

Labels
component:examples documentation A request to change/fix/improve the documentation. Codeowner: @oneapi-src/onednn-doc
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mzhukova @vpirogov @ranukund