docs: clarify copy kwarg behavior in asarray for libraries disallowing mutation
#886
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
Open
|
Moving to draft, as the language in this PR is related and likely dependent on the outcome of other discussions: |
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.
This PR:
copy#495 by clarifying that, for libraries disallowing mutation, when provided known array input,copy=Truecan be ignored.The principle ask from #495 was to have an explicit API to guarantee an output array which can be safely mutated.
asarray(x, copy=True)satisfies that ask; however, for libraries such as JAX, performing an explicit copy is unnecessary, as mutation is disallowed by design. This PR provides an escape hatch for such libraries by allowing them to disregardcopy=Truewhen provided known array input.