ENH: parse complex special cases from stubs of unary functions #409
Conversation
This file contains hidden or 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
"stub" docstrings include "special cases":
> `if x_i is +infinity, sqrt(x_i) is +infinity` etc
`test_special_cases` parses these statements from docstrings and makes them
into tests cases.
So far, parsing only worked for real value cases, and failed for complex-valued
cases:
> For complex floating-point operands, let a = real(x_i), b = imag(x_i), and
> `If a is either +0 or -0 and b is +0, the result is +0 + 0j.`
These stanzas simply generate "case for {func} is not machine-readable" `UserWarning`s.
Quite a wall of them.
Therefore, we update parsing and testing code to take these complex-valued
cases into accout.
For now, we only consider unary functions.
The effect is:
$ ARRAY_API_TESTS_MODULE=array_api_compat.torch pytest array_api_tests/test_special_cases.py::test_unary
generates
- "128 passed, 177 warnings in 0.78s" on master
- "11 failed, 241 passed, 49 warnings in 1.82s" on this branch
So that there are new failures (from new complex-valued cases) but we 128 less warnings.
ev-br
force-pushed
the
copilot_spec_cases_unary
branch
from
a69e65f to
158af05
Compare
ev-br
force-pushed
the
copilot_spec_cases_unary
branch
from
158af05 to
eae7d2a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
"stub" docstrings include "special cases":
test_special_casesparses these statements from docstrings and makes them into tests cases.So far, parsing only worked for real value cases, and failed for complex-valued cases:
These stanzas simply generate "case for {func} is not machine-readable"
UserWarnings. Quite a wall of them.Therefore, we update parsing and testing code to take these complex-valued cases into accout.
For now, we only consider unary functions.
The effect is that
$ ARRAY_API_TESTS_MODULE=array_api_compat.torch pytest array_api_tests/test_special_cases.py::test_unarygenerates
So that there are new failures (from new complex-valued cases) but we have 128 less warnings.
NB: this pull request is generated by Copilot. The original prompt and subsequent back-and-forths are at ev-br#3