Skip to content

docs: make Enzyme warning more visible #808

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

Merged
merged 1 commit into from
Jun 2, 2025
Merged

docs: make Enzyme warning more visible #808

merged 1 commit into from
Jun 2, 2025

Conversation

gdalle
Copy link
Member

@gdalle gdalle commented Jun 2, 2025

  • Turn the Enzyme warning on the README into a GitHub admonition for more visibility:
  • Translate it to a Documenter.jl admonition when building the docs.
  • Add a related warning to the backends page

The warning now looks like this on the README:

Caution

Note that in some cases, going through DifferentiationInterface.jl might be slower or cause more errors than a direct call to the backend’s API. This is especially true for Enzyme.jl, whose handling of activities and multiple arguments is not fully supported here. We are working on this challenge, and welcome any suggestions or contributions. Meanwhile, if differentiation fails or takes too long, consider using Enzyme.jl through its native API instead.

Related:

@gdalle
Copy link
Member Author

gdalle commented Jun 2, 2025

cc @wsmoses, trying to make this as visible and explicit as I can

Copy link

codecov bot commented Jun 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.93%. Comparing base (f07b6ec) to head (f53bc1a).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #808   +/-   ##
=======================================
  Coverage   97.93%   97.93%           
=======================================
  Files         128      128           
  Lines        7693     7693           
=======================================
  Hits         7534     7534           
  Misses        159      159           
Flag Coverage Δ
DI 98.81% <ø> (ø)
DIT 95.61% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@gdalle gdalle merged commit d8905f5 into main Jun 2, 2025
50 checks passed
@gdalle gdalle deleted the gd/warn branch June 2, 2025 22:19
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.

1 participant