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

Updated BLAS domain with exact copy-over from oneMKL spec per SME dir… #128

Closed

Conversation

JOCwriter
Copy link
Contributor

…ection.

Added exceptions.inc.rst to oneMKL/docs to resolve cross references used in BLAS topics, and added exceptions.inc.rst to the index toctree.

Signed-off-by: John O'Connell john.oconnell@intel.com

Description

Please include a summary of the change. Please also include relevant
motivation and context. See
contribution guidelines
for more details. If the change fixes an issue not documented in the project's
Github issue tracker, please document all steps necessary to reproduce it.

Fixes # (GitHub issue)

Checklist

All Submissions

  • Do all unit tests pass locally? Attach a log.
  • Have you formatted the code using clang-format?

New interfaces

  • Have you provided motivation for adding a new feature as part of RFC and
    it was accepted? # (RFC)
  • What version of oneAPI spec the interface is targeted?
  • Complete New features checklist

New features

  • Have you provided motivation for adding a new feature?
  • Have you added relevant tests?

Bug fixes

  • Have you added relevant regression tests?
  • Have you included information on how to reproduce the issue (either in a
    GitHub issue or in this PR)?

…ection.

Added exceptions.inc.rst to oneMKL/docs to resolve cross references used in BLAS topics, and added exceptions.inc.rst to the index toctree.

Signed-off-by: John O'Connell <john.oconnell@intel.com>
@JOCwriter
Copy link
Contributor Author

@mkrainiuk / @mmeterel , Please review. Per our agreement, I have updated BLAS domain with everything from existing spec.

@JOCwriter
Copy link
Contributor Author

@mmeterel / @mkrainiuk , gentle nudge. This PR needs to be assigned, but I don' thave the option to set reviewers. Please review.

@mmeterel
Copy link
Contributor

@JOCwriter My main comment about this PR is the exception handling in the oneMKL open source interfaces - which is different than how it is described in the new documentation. @mkrainiuk do you have any feedback/recommendation on how to handle the exceptions section in the new documentation?

@JOCwriter
Copy link
Contributor Author

@mkrainiuk / @mmeterel
Thank you Mesut for the review. Please suggest the specific changes that need to be made to comply with open source implementations strategy. I'm trying to get this wrapped up by 2021.4. In our last meeting, my understanding was that all of the spec (with respect to BLAS) could be copied over and used. It turns out that there are several references in the BLAS topics to this exceptions topic, which I understood to be also valid.

@mmeterel
Copy link
Contributor

@JOCwriter Regarding BLAS documentation, all the spec could be re-used in terms of API descriptions. This will be much faster than updating the documentation here manually, based on personal experience. Exceptions in the spec describe what needs to be happen in the implementation, however, oneMKL open source interfaces did not implement it yet. I believe, the documentation in this repo should reflect what is supported here, not in the spec or in the Intel oneMKL product. Mixing documentation will lead to confusion. That is why I want Maria's feedback on exceptions.

One option would be to remove all references to exceptions in API pages. (Again, even this will be much faster than updating the documents manually here)

How about other domains like RNG and LAPACK? Will you be adding those docs as well?

@JOCwriter
Copy link
Contributor Author

@mmeterel ,

Unfortunately, RNG and LAPACK fell out of scope for the 2021.4 deadline due to the misalignment between the initial strategy and the additional input we received from the team. We will bring those domains into scope for phase 2 (2022.1), however. Please let me know at your earliest what you and @mkrainiuk agree is the best path forward for the BLAS exception handling approach.

@mmeterel
Copy link
Contributor

There were some recent additions/changes to oneAPI spec for BLAS domain. We will open another PR to bring oneAPI spec with recent changes. Closing this PR.

@mmeterel mmeterel closed this Nov 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants