Docs: Update Math API page #3738
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adeljo-amd
requested review from
chrispaquot,
gandryey,
saleelk,
mangupta and
rakesroy
as code owners
adeljo-amd
force-pushed
the
math_doc
branch
2 times, most recently
from
a1238f8 to
e9be8fc
Compare
adeljo-amd
changed the title
randyh62
reviewed
Feb 5, 2025
randyh62
approved these changes
Feb 5, 2025
| difference between a HIP math function result and its corresponding C++ standard library | ||
| function (e.g., comparing HIP's sinf with C++'s sinf). | ||
|
|
||
| The following C++ example shows a simplified method for computing ULP differences between |
There was a problem hiding this comment.
I like the addition of the test case example, but wonder if it should appear after the tables? We could have a reference to it here, above the tables, like "See the Example code for a demonstration of how this data was captured." or something like it?
There was a problem hiding this comment.
I think it should be before the table, as it's more helpful for users to know how the metric is measured before seeing the metric values themselves
| The functions in this section prioritize numerical accuracy and correctness, making them well-suited for | ||
| applications that require high precision and predictable results. | ||
|
|
||
| Arithmetic |
There was a problem hiding this comment.
I like the sorted tables, and the stacked Single/Double Precision tables.
|
@adeljo-amd Could you please rebase the branch? |
Done |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The goal of this PR is to improve the usability of the Math API page, by providing information about each function's maximum ULP error when compared against the C++ standard library (if applicable). It also highlights specific math functions which are unsupported too.