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.

Sign up for GitHub

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

Fix backend display in docs #333

Merged
merged 1 commit into from
Jun 26, 2024
Merged

Fix backend display in docs #333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DifferentiationInterface/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This package provides a backend-agnostic syntax to differentiate functions of th

## Compatibility

We support all of the backends defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl) v1.0:
We support all of the backends defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl):

- [ChainRulesCore.jl](https://github.com/JuliaDiff/ChainRulesCore.jl)
- [Diffractor.jl](https://github.com/JuliaDiff/Diffractor.jl)
Expand Down
6 changes: 3 additions & 3 deletions DifferentiationInterface/docs/src/backends.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ This page is about the latter, check out [that page](@ref "Operators") to learn
We support all dense backend choices from [ADTypes.jl](https://github.com/SciML/ADTypes.jl), as well as their sparse wrapper [`AutoSparse`](@extref ADTypes.AutoSparse).

```@setup backends
using ADTypes
using DifferentiationInterface
import Markdown

Expand All @@ -26,8 +27,7 @@ import Zygote

backend_examples = [
AutoDiffractor(),
AutoEnzyme(; mode=Enzyme.Forward),
AutoEnzyme(; mode=Enzyme.Reverse),
AutoEnzyme(),
AutoFastDifferentiation(),
AutoFiniteDiff(),
AutoFiniteDifferences(; fdm=FiniteDifferences.central_fdm(3, 1)),
Expand All @@ -52,7 +52,7 @@ println(io, "| Backend | Availability | Two-argument functions | Hessian support
println(io, "|:--------|:------------:|:----------------------:|:---------------:|")

for b in backend_examples
join(io, [string(b), unicode_check_available(b), unicode_check_twoarg(b), unicode_check_hessian(b)], '|')
join(io, ["[`$(nameof(typeof(b)))`](@extref ADTypes)", unicode_check_available(b), unicode_check_twoarg(b), unicode_check_hessian(b)], '|')
println(io, '|' )
end
backend_table = Markdown.parse(String(take!(io)))
Expand Down
Loading