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

feat: compile neural operators using Reactant #52

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
3 changes: 3 additions & 0 deletions .buildkite/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ steps:
version: "1.10"
- JuliaCI/julia-coverage#v1:
codecov: true
dirs:
- src
- ext
command: |
julia --project -e '
println("--- :julia: Instantiating project")
Expand Down
6 changes: 6 additions & 0 deletions .buildkite/testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ steps:
test_args: "--quickfail"
- JuliaCI/julia-coverage#v1:
codecov: true
dirs:
- src
- ext
agents:
queue: "juliagpu"
cuda: "*"
Expand All @@ -27,6 +30,9 @@ steps:
test_args: "--quickfail"
- JuliaCI/julia-coverage#v1:
codecov: true
dirs:
- src
- ext
env:
JULIA_AMDGPU_CORE_MUST_LOAD: "1"
JULIA_AMDGPU_HIP_MUST_LOAD: "1"
Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ concurrency:

jobs:
ci:
name: Julia ${{ matrix.version }} - ${{ matrix.os }}
if: ${{ !contains(github.event.head_commit.message, '[skip tests]') }}
runs-on: ${{ matrix.os }}
strategy:
Expand Down Expand Up @@ -51,6 +50,8 @@ jobs:
- uses: julia-actions/julia-buildpkg@v1
- uses: julia-actions/julia-runtest@v1
- uses: julia-actions/julia-processcoverage@v1
with:
directories: src,ext
- uses: codecov/codecov-action@v5
with:
files: lcov.info
Expand All @@ -60,7 +61,6 @@ jobs:

downgrade:
if: ${{ !contains(github.event.head_commit.message, '[skip tests]') && github.base_ref == github.event.repository.default_branch }}
name: Downgrade Julia ${{ matrix.version }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
Expand All @@ -75,6 +75,8 @@ jobs:
- uses: julia-actions/julia-buildpkg@v1
- uses: julia-actions/julia-runtest@v1
- uses: julia-actions/julia-processcoverage@v1
with:
directories: src,ext
- uses: codecov/codecov-action@v5
with:
files: lcov.info
Expand Down
17 changes: 12 additions & 5 deletions Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,24 @@ Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
Static = "aedffcd0-7271-4cad-89d0-dc628f76c6d3"
WeightInitializers = "d49dbf32-c5c2-4618-8acc-27bb2598ef2d"

[weakdeps]
Reactant = "3c362404-f566-11ee-1572-e11a4b42c853"

[extensions]
NeuralOperatorsReactantExt = "Reactant"

[compat]
ArgCheck = "2.3"
ChainRulesCore = "1.24"
ConcreteStructs = "0.2.3"
FFTW = "1.8"
Lux = "1"
LuxCore = "1"
LuxLib = "1.2"
MLDataDevices = "1.2.0"
NNlib = "0.9.21"
Lux = "1.2.1"
LuxCore = "1.1"
LuxLib = "1.3.7"
MLDataDevices = "1.5"
NNlib = "0.9.24"
Random = "1.10"
Reactant = "0.2.5"
Static = "1.1.1"
WeightInitializers = "1"
julia = "1.10"
8 changes: 6 additions & 2 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
CondaPkg = "992eb4ea-22a4-4c89-a5bb-47a3300528ab"
DataDeps = "124859b0-ceae-595e-8997-d05f6a7a8dfe"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Enzyme = "7da242da-08ed-463a-9acd-ee780be4f1d9"
Lux = "b2108857-7c20-44ae-9111-449ecde12c47"
LuxCUDA = "d0bbae9a-e099-4d5b-a835-1c6931763bda"
MAT = "23992714-dd62-5051-b70f-ba57cb901cac"
Expand All @@ -11,19 +12,22 @@ NeuralOperators = "ea5c82af-86e5-48da-8ee1-382d6ad7af4b"
Optimisers = "3bd65402-5787-11e9-1adc-39752487f4e2"
Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
PythonCall = "6099a3de-0909-46bc-b1f4-468b9a2dfc0d"
Reactant = "3c362404-f566-11ee-1572-e11a4b42c853"
Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"

[compat]
CairoMakie = "0.12.11"
CondaPkg = "0.2.23"
DataDeps = "0.7.13"
Documenter = "1.7.0"
Lux = "1"
Enzyme = "0.13.24"
Lux = "1.2.1"
LuxCUDA = "0.3.3"
MAT = "0.10.7"
MLUtils = "0.4.4"
NeuralOperators = "0.5"
Optimisers = "0.3.3"
Optimisers = "0.3.3, 0.4"
Printf = "1.10"
PythonCall = "0.9.23"
Reactant = "0.2.11"
Zygote = "0.6.71"
1 change: 1 addition & 0 deletions docs/pages.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ pages = [
"NOMAD" => "models/nomad.md"
],
"Tutorials" => [
"XLA Compilation" => "tutorials/reactant.md",
"Burgers Equation" => "tutorials/burgers.md"
],
"API Reference" => "api.md"
Expand Down
60 changes: 60 additions & 0 deletions docs/src/tutorials/reactant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Compiling NeuralOperators.jl using Reactant.jl

```@example reactant
using NeuralOperators, Lux, Random, Enzyme, Reactant

function sumabs2first(model, ps, st, x)
z, _ = model(x, ps, st)
return sum(abs2, z)
end

dev = reactant_device()
```

## Compiling DeepONet

```@example reactant
deeponet = DeepONet()
ps, st = Lux.setup(Random.default_rng(), deeponet) |> dev;

u = rand(Float32, 64, 32) |> dev;
y = rand(Float32, 1, 128, 32) |> dev;
nothing # hide

@jit deeponet((u, y), ps, st)
```

Computing the gradient of the DeepONet model.

```@example reactant
function ∇deeponet(model, ps, st, (u, y))
return Enzyme.gradient(
Enzyme.Reverse, Const(sumabs2first), Const(model), ps, Const(st), Const((u, y))
)
end

@jit ∇deeponet(deeponet, ps, st, (u, y))
```

## Compiling FourierNeuralOperator

```@example reactant
fno = FourierNeuralOperator()
ps, st = Lux.setup(Random.default_rng(), fno) |> dev;

x = rand(Float32, 2, 32, 5) |> dev;

@jit fno(x, ps, st)
```

Computing the gradient of the FourierNeuralOperator model.

```@example reactant
function ∇fno(model, ps, st, x)
return Enzyme.gradient(
Enzyme.Reverse, Const(sumabs2first), Const(model), ps, Const(st), Const(x)
)
end

@jit ∇fno(fno, ps, st, x)
```
31 changes: 31 additions & 0 deletions ext/NeuralOperatorsReactantExt.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
module NeuralOperatorsReactantExt

using FFTW: FFTW
using NeuralOperators: NeuralOperators, FourierTransform
using NNlib: NNlib
using Reactant: Reactant, TracedRArray, AnyTracedRArray

# XXX: Reevaluate after https://github.com/EnzymeAD/Reactant.jl/issues/246 is fixed
function NeuralOperators.transform(
ft::FourierTransform, x::AnyTracedRArray{T, N}) where {T, N}
x_c = Reactant.TracedUtils.promote_to(
TracedRArray{Complex{T}, N},
Reactant.TracedUtils.materialize_traced_array(x)
)
return FFTW.fft(x_c, 1:ndims(ft))
end

function NeuralOperators.inverse(
ft::FourierTransform, x::AnyTracedRArray{T, N}, ::NTuple{N, Int64}) where {T, N}
return real(FFTW.ifft(x, 1:ndims(ft)))
end

function NeuralOperators.fast_pad_zeros(x::AnyTracedRArray, pad_dims)
return NNlib.pad_zeros(
Reactant.TracedUtils.materialize_traced_array(x),
NeuralOperators.expand_pad_dims(pad_dims);
dims=ntuple(identity, ndims(x) - 2)
)
end

end
3 changes: 1 addition & 2 deletions src/layers.jl
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,7 @@ function operator_conv(x, tform::AbstractTransform, weights)
x_p = apply_pattern(x_tr, weights)

pad_dims = size(x_t)[1:(end - 2)] .- size(x_p)[1:(end - 2)]
x_padded = NNlib.pad_constant(x_p, expand_pad_dims(pad_dims), false;
dims=ntuple(identity, ndims(x_p) - 2))::typeof(x_p)
x_padded = fast_pad_zeros(x_p, pad_dims)

return inverse(tform, x_padded, size(x))
end
Expand Down
5 changes: 5 additions & 0 deletions src/utils.jl
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,8 @@ function ∇safe_batched_adjoint(
::Type{<:AbstractGPUDevice}, Δ::AbstractArray{T, 3}) where {T}
return NoTangent(), stack(adjoint, eachslice(Δ; dims=3))
end

function fast_pad_zeros(x, pad_dims)::typeof(x)
return NNlib.pad_zeros(
x, expand_pad_dims(pad_dims); dims=ntuple(identity, ndims(x) - 2))
end
2 changes: 1 addition & 1 deletion test/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ LuxCore = "1"
LuxLib = "1.2"
LuxTestUtils = "1.1.2"
MLDataDevices = "1"
Optimisers = "0.3.3"
Optimisers = "0.3.3, 0.4"
Pkg = "1.10"
Preferences = "1"
Random = "1.10"
Expand Down
Loading