Skip to content
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.

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

docs: clarify tape recording in ReverseDiff docstring #92

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

Conversation

gdalle
Copy link
Collaborator

@gdalle gdalle commented Nov 6, 2024

Checklist

  • Appropriate tests were added
  • Any code changes were done in a way that does not break public API
  • All documentation related to code changes were updated
  • The new code follows the
    contributor guidelines, in particular the SciML Style Guide and
    COLPRAC.
  • Any new documentation only uses public API

Additional context

Fixes #91 by clarifying the AutoReverseDiff docstring.
The agreed-upon meaning of compile is to allow pre-recording and reuse of the tape, not to force its compilation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

What does "compile" mean for ReverseDiff?
1 participant