add sparse rrule

Project.toml

@@ -1,6 +1,6 @@
 name = "ChainRules"
 uuid = "082447d4-558c-5d27-93f4-14fc19e9eca2"
-version = "1.23"
+version = "1.24"
 
 [deps]
 ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
@@ -9,6 +9,7 @@ IrrationalConstants = "92d709cd-6900-40b7-9082-c6be49f344b6"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 RealDot = "c1ae055f-0cd5-4b69-90a6-9a35b1a98df9"
+SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 
 [compat]

src/ChainRules.jl

@@ -8,6 +8,7 @@ using LinearAlgebra
 using LinearAlgebra.BLAS
 using Random
 using RealDot: realdot
+using SparseArrays
 using Statistics
 
 # Basically everything this package does is overloading these, so we make an exception
@@ -42,6 +43,8 @@ include("rulesets/LinearAlgebra/structured.jl")
 include("rulesets/LinearAlgebra/symmetric.jl")
 include("rulesets/LinearAlgebra/factorization.jl")
 
+include("rulesets/SparseArrays/sparsematrix.jl")
+
 include("rulesets/Random/random.jl")
 
 end # module

src/rulesets/SparseArrays/sparsematrix.jl

@@ -0,0 +1,25 @@
+function rrule(::typeof(sparse), I::AbstractVector, J::AbstractVector, V::AbstractVector, m, n, combine::typeof(+))
+ project_V = ProjectTo(V)
+
+ function sparse_pullback(Ω̄)
+ ΔΩ = unthunk(Ω̄)
+ ΔV = project_V(ΔΩ[I .+ m .* (J .- 1)])
+ return NoTangent(), NoTangent(), NoTangent(), ΔV, NoTangent(), NoTangent(), NoTangent()
+ end
+
+ return sparse(I, J, V, m, n, combine), sparse_pullback
+end
+
+function rrule(::Type{T}, A::AbstractMatrix) where T <: SparseMatrixCSC
+ function sparse_pullback(Ω̄)
+ return NoTangent(), Ω̄
+ end
+ return T(A), sparse_pullback
+end
+
+function rrule(::Type{T}, v::AbstractVector) where T <: SparseVector
+ function sparse_pullback(Ω̄)
+ return NoTangent(), Ω̄
+ end
+ return T(v), sparse_pullback
+end

test/rulesets/SparseArrays/sparsematrix.jl

@@ -0,0 +1,19 @@
+
+@testset "sparse(I, J, V, m, n, +)" begin
+ m, n = 3, 5
+ s, t, w = [1,2], [2,3], [0.5,0.5]
+
+ test_rrule(sparse, s, t, w, m, n, +)
+end
+
+@testset "SparseMatrixCSC(A)" begin
+ A = rand(5, 3)
+ test_rrule(SparseMatrixCSC, A)
+ test_rrule(SparseMatrixCSC{Float32,Int}, A, rtol=1e-5)
+end
+
+@testset "SparseVector(v)" begin
+ v = rand(5)
+ test_rrule(SparseVector, v)
+ test_rrule(SparseVector{Float32}, Float32.(v), rtol=1e-5)
+end

test/runtests.jl

@@ -12,6 +12,7 @@ using LinearAlgebra
 using LinearAlgebra.BLAS
 using LinearAlgebra: dot
 using Random
+using SparseArrays
 using StaticArrays
 using Statistics
 using Test
@@ -72,6 +73,10 @@ end
 
  println()
 
+ include_test("rulesets/SparseArrays/sparsematrix.jl")
+
+ println()
+
  include_test("rulesets/Random/random.jl")
 
  println()