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

Enzyme support #85

Draft
wants to merge 10 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 8 commits
Commits
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
41 changes: 23 additions & 18 deletions Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,11 @@ version = "0.6.0-DEV"

[deps]
ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
Enzyme = "7da242da-08ed-463a-9acd-ee780be4f1d9"
ExprTools = "e2ba6199-217a-4e67-a87a-7c52f15ade04"
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
Requires = "ae029012-a4dd-5104-9daa-d747884805df"

[weakdeps]
ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
DiffResults = "163ba53b-c6d8-5494-b064-1a9d43ac40c5"
FiniteDifferences = "26cc04aa-876d-5657-8c51-4c34ba976000"
ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
ReverseDiff = "37e2e3b7-166d-5795-8a7a-e32c996b4267"
Tracker = "9f7883ad-71c0-57eb-9f7f-b5c9e6d3789c"
Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"

[extensions]
AbstractDifferentiationChainRulesCoreExt = "ChainRulesCore"
AbstractDifferentiationFiniteDifferencesExt = "FiniteDifferences"
AbstractDifferentiationForwardDiffExt = ["DiffResults", "ForwardDiff"]
AbstractDifferentiationReverseDiffExt = ["DiffResults", "ReverseDiff"]
AbstractDifferentiationTrackerExt = "Tracker"
AbstractDifferentiationZygoteExt = "Zygote"

[compat]
ChainRulesCore = "1"
DiffResults = "1"
Expand All @@ -37,6 +21,16 @@ ReverseDiff = "1"
Tracker = "0.2"
Zygote = "0.6"
julia = "1.6"
Enzyme = "0.11"

[extensions]
AbstractDifferentiationChainRulesCoreExt = "ChainRulesCore"
AbstractDifferentiationFiniteDifferencesExt = "FiniteDifferences"
AbstractDifferentiationForwardDiffExt = ["DiffResults", "ForwardDiff"]
AbstractDifferentiationReverseDiffExt = ["DiffResults", "ReverseDiff"]
AbstractDifferentiationTrackerExt = "Tracker"
AbstractDifferentiationZygoteExt = "Zygote"
AbstractDifferentiationEnzymeExt = "Enzyme"

[extras]
ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
Expand All @@ -48,6 +42,17 @@ ReverseDiff = "37e2e3b7-166d-5795-8a7a-e32c996b4267"
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
Tracker = "9f7883ad-71c0-57eb-9f7f-b5c9e6d3789c"
Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"
Enzyme = "7da242da-08ed-463a-9acd-ee780be4f1d9"

[targets]
test = ["Test", "ChainRulesCore", "DiffResults", "FiniteDifferences", "ForwardDiff", "Random", "ReverseDiff", "Tracker", "Zygote"]
test = ["Test", "ChainRulesCore", "DiffResults", "FiniteDifferences", "ForwardDiff", "Random", "ReverseDiff", "Tracker", "Zygote", "Enzyme"]

[weakdeps]
ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
DiffResults = "163ba53b-c6d8-5494-b064-1a9d43ac40c5"
FiniteDifferences = "26cc04aa-876d-5657-8c51-4c34ba976000"
ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
ReverseDiff = "37e2e3b7-166d-5795-8a7a-e32c996b4267"
Tracker = "9f7883ad-71c0-57eb-9f7f-b5c9e6d3789c"
Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"
Enzyme = "7da242da-08ed-463a-9acd-ee780be4f1d9"
62 changes: 62 additions & 0 deletions ext/AbstractDifferentiationEnzymeExt.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
module AbstractDifferentiationEnzymeExt

if isdefined(Base, :get_extension)
import AbstractDifferentiation as AD
using Enzyme: Enzyme
else
import ..AbstractDifferentiation as AD
using ..Enzyme: Enzyme
end

struct Mutating{F}
f::F
end
function (f::Mutating)(y, xs...)
y .= f.f(xs...)
return y
end

AD.@primitive function value_and_pullback_function(b::AD.EnzymeReverseBackend, f, xs...)
y = f(xs...)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should use ReverseSplitMode here, and call the augmented forward pass for that result, use the reverse pass (and tape created from aug) for the reverse pass.

return y,
Δ -> begin
Δ_xs = zero.(xs)
dup = if y isa Real
if Δ isa Real
Enzyme.Duplicated([y], [Δ])
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems a bit strange - that's not something an Enzyme user would do AFAIK.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ya it's a quick and dirty hack to get it running, needs to be optimised

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe one can reuse some of the things I did in TuringLang/DistributionsAD.jl#254.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is a real or tuple of real, this should be an active argument [in reverse mode]

elseif Δ isa Tuple{Real}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tuple issue hits again...

Enzyme.Duplicated([y], [Δ[1]])
else
throw(ArgumentError("Unsupported cotangent type."))
end
else
if Δ isa AbstractArray{<:Real}
Enzyme.Duplicated(y, Δ)
elseif Δ isa Tuple{AbstractArray{<:Real}}
Enzyme.Duplicated(y, Δ[1])
else
throw(ArgumentError("Unsupported cotangent type."))
end
end
Enzyme.autodiff(
Enzyme.Reverse,
Mutating(f),
Enzyme.Const,
dup,
Enzyme.Duplicated.(xs, Δ_xs)...,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That means users of AbstractDifferentiation miss a major feature of Enzyme. But maybe it's unavoidable and the current design of AbstractDifferentiation can't support it and the wrapper will always be less performant than Enzyme?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's brainstorm solutions, I think it's possible to support partial pullback with an extended API

)
return Δ_xs
end
end
function AD.pushforward_function(::AD.EnzymeReverseBackend, f, xs...)
return AD.pushforward_function(AD.EnzymeForwardBackend(), f, xs...)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This creates an inconsistency with the behaviour of other backends where it is guaranteed that the specified backend is used for every operation. I think the better design might be to have dedicated Reverse+Forward wrappers that allow to specify different backends for forward and reverse mode operations and pick the best mode for every call.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. This was done to make some failed tests pass which likely fail due to an Enzyme correctness issue. We should change this before merge.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the test case of the correctness issue? Can you open an issue with it?

end

AD.@primitive function pushforward_function(b::AD.EnzymeForwardBackend, f, xs...)
return ds -> Tuple(Enzyme.autodiff(Enzyme.Forward, f, Enzyme.Duplicated.(xs, ds)...))
end
function AD.value_and_pullback_function(::AD.EnzymeForwardBackend, f, xs...)
return AD.value_and_pullback_function(AD.EnzymeReverseBackend(), f, xs...)
end

end # module
5 changes: 3 additions & 2 deletions ext/AbstractDifferentiationFiniteDifferencesExt.jl
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ end

Create an AD backend that uses forward mode with FiniteDifferences.jl.
"""
AD.FiniteDifferencesBackend() =
AD.FiniteDifferencesBackend(FiniteDifferences.central_fdm(5, 1))
function AD.FiniteDifferencesBackend()
return AD.FiniteDifferencesBackend(FiniteDifferences.central_fdm(5, 1))
end

function AD.jacobian(ba::AD.FiniteDifferencesBackend, f, xs...)
return FiniteDifferences.jacobian(ba.method, f, xs...)
Expand Down
2 changes: 2 additions & 0 deletions src/AbstractDifferentiation.jl
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,8 @@ function value_and_pullback_function(ab::AbstractBackend, f, xs...)
if ws isa Tuple
@assert length(vs) == length(ws)
return sum(Base.splat(_dot), zip(ws, vs))
elseif ws isa Tuple && length(ws) == 1
return _dot(vs, only(ws))
else
return _dot(vs, ws)
end
Expand Down
20 changes: 20 additions & 0 deletions src/backends.jl
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,23 @@ It is a special case of [`ReverseRuleConfigBackend`](@ref).
To be able to use this backend, you have to load Zygote.
"""
function ZygoteBackend end

"""
EnzymeReverseBackend

AD backend that uses reverse mode of Enzyme.jl.

!!! note
To be able to use this backend, you have to load Enzyme.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only true on Julia >= 1.9 I think?

"""
struct EnzymeReverseBackend <: AbstractReverseMode end

"""
EnzymeForwardBackend

AD backend that uses forward mode of Enzyme.jl.

!!! note
To be able to use this backend, you have to load Enzyme.
"""
struct EnzymeForwardBackend <: AbstractForwardMode end
47 changes: 47 additions & 0 deletions test/enzyme.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
import AbstractDifferentiation as AD
using Test
using Enzyme

backends = [
"EnzymeForwardBackend" => AD.EnzymeForwardBackend(),
"EnzymeReverseBackend" => AD.EnzymeReverseBackend(),
]

@testset "$name" for (name, backend) in backends
if name == "EnzymeForwardBackend"
@test backend isa AD.AbstractForwardMode
else
@test backend isa AD.AbstractReverseMode
end

@testset "Derivative" begin
test_derivatives(backend; multiple_inputs=false)
end
@testset "Gradient" begin
test_gradients(backend; multiple_inputs=false)
end
@testset "Jacobian" begin
test_jacobians(backend; multiple_inputs=false)
end
# @testset "Hessian" begin
# test_hessians(backend, multiple_inputs = false)
# end
@testset "jvp" begin
test_jvp(backend; multiple_inputs=false, vaugmented=true)
end
@testset "j′vp" begin
test_j′vp(backend; multiple_inputs=false)
end
@testset "Lazy Derivative" begin
test_lazy_derivatives(backend; multiple_inputs=false)
end
@testset "Lazy Gradient" begin
test_lazy_gradients(backend; multiple_inputs=false)
end
@testset "Lazy Jacobian" begin
test_lazy_jacobians(backend; multiple_inputs=false, vaugmented=true)
end
# @testset "Lazy Hessian" begin
# test_lazy_hessians(backend, multiple_inputs = false)
# end
end
1 change: 1 addition & 0 deletions test/runtests.jl
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ using Test
include("finitedifferences.jl")
include("tracker.jl")
include("ruleconfig.jl")
include("enzyme.jl")
end
Loading