Skip to content

document what is compared by isapprox in tests #2726

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

document what is compared by isapprox in tests #2726

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions lib/EnzymeTestUtils/src/test_forward.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ constraints:
- `atol`: Absolute tolerance for `isapprox`.
- `testset_name`: Name to use for a testset in which all tests are evaluated.

`isapprox(...; rtol, atol)` is used in the comparison of the *primal* and *the partial
derivative(s)*.
Copy link
Member

@wsmoses wsmoses Oct 31, 2025

Choose a reason for hiding this comment

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

its still the partial derivative * the input seed


# Examples

Here we test a rule for a function of scalars. Because we don't provide an activity
Expand Down
5 changes: 4 additions & 1 deletion lib/EnzymeTestUtils/src/test_reverse.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,10 @@ additional constraints:
- `rtol`: Relative tolerance for `isapprox`.
- `atol`: Absolute tolerance for `isapprox`.
- `testset_name`: Name to use for a testset in which all tests are evaluated.
- `output_tangent`: Optional final tangent to provide at the beginning of the reverse-mode differentiation
- `output_tangent`: Optional final tangent to provide at the beginning of the reverse-mode differentiation

`isapprox(...; rtol, atol)` is used in the comparison of the *primal* and *the tangent
multiplied by the partial derivative(s)*.

# Examples

Expand Down