Fix deprecations in DiffRules 1.4 (#191)

* Fix deprecations in DiffRules 1.4

* Apply suggestions

Author: devmotion

Project.toml

@@ -1,6 +1,6 @@
 name = "ReverseDiff"
 uuid = "37e2e3b7-166d-5795-8a7a-e32c996b4267"
-version = "1.10.0"
+version = "1.11.0"
 
 [deps]
 ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
@@ -9,6 +9,7 @@ DiffRules = "b552c78f-8df3-52c6-915a-8e097449b14b"
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
 FunctionWrappers = "069b7b12-0de2-55c6-9aab-29f3d0a68a2e"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+LogExpFunctions = "2ab3a3ac-af41-5b50-aa03-7779005ae688"
 MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
 NaNMath = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
@@ -19,9 +20,10 @@ Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 [compat]
 ChainRulesCore = "1"
 DiffResults = "1"
-DiffRules = "0.1, 1"
+DiffRules = "1.4"
 ForwardDiff = "0.10"
 FunctionWrappers = "1"
+LogExpFunctions = "0.3"
 MacroTools = "0.5"
 NaNMath = "0.3"
 SpecialFunctions = "0.8, 0.9, 0.10, 1.0"

src/ReverseDiff.jl

@@ -15,6 +15,8 @@ using ForwardDiff
 using ForwardDiff: Dual, Partials
 using StaticArrays
 
+using LogExpFunctions: LogExpFunctions
+
 using MacroTools
 
 using ChainRulesCore

src/derivatives/broadcast.jl

@@ -264,8 +264,11 @@ end
 
 @inline _materialize(f, args) = broadcast(f, args...)
 
-for (M, f, arity) in DiffRules.diffrules()
-    isdefined(ReverseDiff, M) || continue
+for (M, f, arity) in DiffRules.diffrules(; filter_modules=nothing)
+    if !(isdefined(@__MODULE__, M) && isdefined(getfield(@__MODULE__, M), f))
+        @warn "$M.$f is not available and hence rule for it can not be defined"
+        continue  # Skip rules for methods not defined in the current scope
+    end
     if arity == 1
         @eval @inline materialize(bc::RDBroadcasted{typeof($M.$f), <:Tuple{TrackedArray}}) = _materialize(bc.f, bc.args)
     elseif arity == 2

src/derivatives/elementwise.jl

@@ -67,7 +67,11 @@ end
 # dispatch #
 #----------#
 
-for g! in (:map!, :broadcast!), (M, f, arity) in DiffRules.diffrules()
+for g! in (:map!, :broadcast!), (M, f, arity) in DiffRules.diffrules(; filter_modules=nothing)
+    if !(isdefined(@__MODULE__, M) && isdefined(getfield(@__MODULE__, M), f))
+        @warn "$M.$f is not available and hence rule for it can not be defined"
+        continue  # Skip rules for methods not defined in the current scope
+    end
     if arity == 1
         @eval @inline Base.$(g!)(f::typeof($M.$f), out::TrackedArray, t::TrackedArray) = $(g!)(ForwardOptimize(f), out, t)
     elseif arity == 2
@@ -154,7 +158,11 @@ end
 # dispatch #
 #----------#
 
-for g in (:map, :broadcast), (M, f, arity) in DiffRules.diffrules()
+for g in (:map, :broadcast), (M, f, arity) in DiffRules.diffrules(; filter_modules=nothing)
+    if !(isdefined(@__MODULE__, M) && isdefined(getfield(@__MODULE__, M), f))
+        @warn "$M.$f is not available and hence rule for it can not be defined"
+        continue  # Skip rules for methods not defined in the current scope
+    end
     if arity == 1
         @eval @inline Base.$(g)(f::typeof($M.$f), t::TrackedArray) = $(g)(ForwardOptimize(f), t)
     elseif arity == 2

src/derivatives/scalars.jl

@@ -2,7 +2,11 @@
 # ForwardOptimize #
 ###################
 
-for (M, f, arity) in DiffRules.diffrules()
+for (M, f, arity) in DiffRules.diffrules(; filter_modules=nothing)
+    if !(isdefined(@__MODULE__, M) && isdefined(getfield(@__MODULE__, M), f))
+        @warn "$M.$f is not available and hence rule for it can not be defined"
+        continue  # Skip rules for methods not defined in the current scope
+    end
     if arity == 1
         @eval @inline $M.$(f)(t::TrackedReal) = ForwardOptimize($M.$(f))(t)
     elseif arity == 2

test/derivatives/ElementwiseTests.jl

@@ -1,6 +1,15 @@
 module ElementwiseTests
 
-using ReverseDiff, ForwardDiff, Test, DiffRules, SpecialFunctions, NaNMath, DiffTests
+using ReverseDiff
+
+using DiffRules
+using DiffTests
+using ForwardDiff
+using LogExpFunctions
+using NaNMath
+using SpecialFunctions
+
+using Test
 
 include(joinpath(dirname(@__FILE__), "../utils.jl"))
 
@@ -379,16 +388,17 @@ for f in DiffTests.NUMBER_TO_NUMBER_FUNCS
     test_elementwise(f, ReverseDiff.@forward(f), a, tp)
 end
 
-DOMAIN_ERR_FUNCS = (:asec, :acsc, :asecd, :acscd, :acoth, :acosh)
-
-for (M, fsym, arity) in DiffRules.diffrules()
+for (M, fsym, arity) in DiffRules.diffrules(; filter_modules=nothing)
+    # ensure that all rules can be tested
+    if !(isdefined(@__MODULE__, M) && isdefined(getfield(@__MODULE__, M), fsym))
+        error("$M.$fsym is not available")
+    end
     fsym === :rem2pi && continue
     if arity == 1
         f = eval(:($M.$fsym))
-        is_domain_err_func = in(fsym, DOMAIN_ERR_FUNCS)
         test_println("forward-mode unary scalar functions", f)
-        test_elementwise(f, f, is_domain_err_func ? x .+ 1 : x, tp)
-        test_elementwise(f, f, is_domain_err_func ? a .+ 1 : a, tp)
+        test_elementwise(f, f, modify_input(fsym, x), tp)
+        test_elementwise(f, f, modify_input(fsym, a), tp)
     elseif arity == 2
         in(fsym, SKIPPED_BINARY_SCALAR_TESTS) && continue
         f = eval(:($M.$fsym))

test/derivatives/ScalarTests.jl

@@ -1,14 +1,22 @@
 module ScalarTests
 
-using ReverseDiff, ForwardDiff, Test, DiffRules, SpecialFunctions, NaNMath
+using ReverseDiff
+
+using DiffRules
+using ForwardDiff
+using LogExpFunctions
+using NaNMath
+using SpecialFunctions
+
+using Test
 
 include(joinpath(dirname(@__FILE__), "../utils.jl"))
 
 x, a, b = rand(3)
 tp = InstructionTape()
 int_range = 1:10
 
-function test_forward(f, x, tp::InstructionTape, is_domain_err_func::Bool)
+function test_forward(f, x, tp::InstructionTape, fsym::Symbol)
     xt = ReverseDiff.TrackedReal(x, zero(x), tp)
     y = f(x)
 
@@ -23,7 +31,7 @@ function test_forward(f, x, tp::InstructionTape, is_domain_err_func::Bool)
     @test deriv(xt) == ForwardDiff.derivative(f, x)
 
     # forward
-    x2 = is_domain_err_func ? rand() + 1 : rand()
+    x2 = modify_input(fsym, rand())
     ReverseDiff.value!(xt, x2)
     ReverseDiff.forward_pass!(tp)
     @test value(yt) == f(x2)
@@ -133,15 +141,15 @@ function test_skip(f, a, b, tp)
     @test isempty(tp)
 end
 
-DOMAIN_ERR_FUNCS = (:asec, :acsc, :asecd, :acscd, :acoth, :acosh)
-
-for (M, f, arity) in DiffRules.diffrules()
+for (M, f, arity) in DiffRules.diffrules(; filter_modules=nothing)
+    # ensure that function is defined
+    if !(isdefined(@__MODULE__, M) && isdefined(getfield(@__MODULE__, M), f))
+        error("$M.$f is not available")
+    end
     f === :rem2pi && continue
     if arity == 1
         test_println("forward-mode unary scalar functions", string(M, ".", f))
-        is_domain_err_func = in(f, DOMAIN_ERR_FUNCS)
-        n = is_domain_err_func ? x + 1 : x
-        test_forward(eval(:($M.$f)), n, tp, is_domain_err_func)
+        test_forward(eval(:($M.$f)), modify_input(f, x), tp, f)
     elseif arity == 2
         in(f, SKIPPED_BINARY_SCALAR_TESTS) && continue
         test_println("forward-mode binary scalar functions", f)
@@ -153,7 +161,7 @@ INT_ONLY_FUNCS = (:iseven, :isodd)
 
 for f in ReverseDiff.SKIPPED_UNARY_SCALAR_FUNCS
     test_println("SKIPPED_UNARY_SCALAR_FUNCS", f)
-    n = in(f, DOMAIN_ERR_FUNCS) ? x + 1 : x
+    n = modify_input(f, x)
     n = in(f, INT_ONLY_FUNCS) ? ceil(Int, n) : n
     test_skip(eval(f), n, tp)
 end

test/utils.jl

@@ -23,3 +23,16 @@ test_println(kind, f, pad = "  ") = println(pad, "testing $(kind): `$(f)`...")
 tracked_is(a, b) = value(a) === value(b) && deriv(a) === deriv(b) && tape(a) === tape(b)
 tracked_is(a::AbstractArray, b::AbstractArray) = all(map(tracked_is, a, b))
 tracked_is(a::Tuple, b::Tuple) = all(map(tracked_is, a, b))
+
+# ensure that input is in domain of function
+# here `x` is a scalar or array generated with `rand(dims...)`, i.e., values of `x`
+# are between 0 and 1
+function modify_input(f, x)
+    return if in(f, (:asec, :acsc, :asecd, :acscd, :acosh, :acoth))
+        x .+ one(eltype(x))
+    elseif f === :log1mexp || f === :log2mexp
+        x .- one(eltype(x))
+    else
+        x
+    end
+end