Add DI warning to AutoEnzyme #109
Draft
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.
Checklist
contributor guidelines, in particular the SciML Style Guide and
COLPRAC.
Additional context
Calling Enzyme through DI can introduce errors or slowdowns compared to Enzyme's native API. However, end users are unlikely to check out either the DI docs or the Enzyme docs when investigating what happened, especially when derivatives are deep in the call stack.
On the other hand, end users usually provide the
AutoEnzyme
object to whatever package they are using. Thus, adding a warning there seems like a good way to raise awareness.@wsmoses what do you think? You could also write a page for the Enzyme docs with examples of what can go wrong when going through DI, and we could link it from here and from the DI docs.
Related: