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

Provide an option to exclude some AD backends #327

Closed
wants to merge 3 commits into from
Closed

Provide an option to exclude some AD backends #327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e70f8ea
Provide an option to exlude some AD backends
amontoison Feb 1, 2025
2b4c98e
Fix a typo in predefined_backend.jl
amontoison Feb 1, 2025
ee0aa50
Update src/ad.jl
amontoison Feb 1, 2025
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
65 changes: 35 additions & 30 deletions src/ad.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The default constructors are
ADModelNLSBackend(nvar, F!, nequ, ncon = 0, c = (args...) -> []; show_time::Bool = false, kwargs...)

If `show_time` is set to `true`, it prints the time used to generate each backend.
`excluded_backend` is the list of backends that are not used and will be set to `EmptyADbackend`.

The remaining `kwargs` are either the different backends as listed below or arguments passed to the backend's constructors:
- `gradient_backend = ForwardDiffADGradient`;
Expand Down Expand Up @@ -54,9 +55,10 @@ function ADModelBackend(
backend::Symbol = :default,
matrix_free::Bool = false,
show_time::Bool = false,
gradient_backend = get_default_backend(:gradient_backend, backend),
hprod_backend = get_default_backend(:hprod_backend, backend),
hessian_backend = get_default_backend(:hessian_backend, backend, matrix_free),
excluded_backend::Vector{Symbol} = Symbol[],
gradient_backend = get_default_backend(:gradient_backend, backend; excluded_backend),
hprod_backend = get_default_backend(:hprod_backend, backend; excluded_backend),
hessian_backend = get_default_backend(:hessian_backend, backend, matrix_free; excluded_backend),
kwargs...,
)
c! = (args...) -> []
Expand Down Expand Up @@ -116,13 +118,14 @@ function ADModelBackend(
backend::Symbol = :default,
matrix_free::Bool = false,
show_time::Bool = false,
gradient_backend = get_default_backend(:gradient_backend, backend),
hprod_backend = get_default_backend(:hprod_backend, backend),
jprod_backend = get_default_backend(:jprod_backend, backend),
jtprod_backend = get_default_backend(:jtprod_backend, backend),
jacobian_backend = get_default_backend(:jacobian_backend, backend, matrix_free),
hessian_backend = get_default_backend(:hessian_backend, backend, matrix_free),
ghjvprod_backend = get_default_backend(:ghjvprod_backend, backend),
excluded_backend::Vector{Symbol} = Symbol[],
gradient_backend = get_default_backend(:gradient_backend, backend; excluded_backend),
hprod_backend = get_default_backend(:hprod_backend, backend; excluded_backend),
jprod_backend = get_default_backend(:jprod_backend, backend; excluded_backend),
jtprod_backend = get_default_backend(:jtprod_backend, backend; excluded_backend),
jacobian_backend = get_default_backend(:jacobian_backend, backend, matrix_free; excluded_backend),
hessian_backend = get_default_backend(:hessian_backend, backend, matrix_free; excluded_backend),
ghjvprod_backend = get_default_backend(:ghjvprod_backend, backend; excluded_backend),
kwargs...,
)
GB = gradient_backend
Expand Down Expand Up @@ -218,14 +221,15 @@ function ADModelNLSBackend(
backend::Symbol = :default,
matrix_free::Bool = false,
show_time::Bool = false,
gradient_backend = get_default_backend(:gradient_backend, backend),
hprod_backend = get_default_backend(:hprod_backend, backend),
hessian_backend = get_default_backend(:hessian_backend, backend, matrix_free),
hprod_residual_backend = get_default_backend(:hprod_residual_backend, backend),
jprod_residual_backend = get_default_backend(:jprod_residual_backend, backend),
jtprod_residual_backend = get_default_backend(:jtprod_residual_backend, backend),
jacobian_residual_backend = get_default_backend(:jacobian_residual_backend, backend, matrix_free),
hessian_residual_backend = get_default_backend(:hessian_residual_backend, backend, matrix_free),
excluded_backend::Vector{Symbol} = Symbol[],
gradient_backend = get_default_backend(:gradient_backend, backend; excluded_backend),
hprod_backend = get_default_backend(:hprod_backend, backend; excluded_backend),
hessian_backend = get_default_backend(:hessian_backend, backend, matrix_free; excluded_backend),
hprod_residual_backend = get_default_backend(:hprod_residual_backend, backend; excluded_backend),
jprod_residual_backend = get_default_backend(:jprod_residual_backend, backend; excluded_backend),
jtprod_residual_backend = get_default_backend(:jtprod_residual_backend, backend; excluded_backend),
jacobian_residual_backend = get_default_backend(:jacobian_residual_backend, backend, matrix_free; excluded_backend),
hessian_residual_backend = get_default_backend(:hessian_residual_backend, backend, matrix_free; excluded_backend),
kwargs...,
)
function F(x; nequ = nequ)
Expand Down Expand Up @@ -344,18 +348,19 @@ function ADModelNLSBackend(
backend::Symbol = :default,
matrix_free::Bool = false,
show_time::Bool = false,
gradient_backend = get_default_backend(:gradient_backend, backend),
hprod_backend = get_default_backend(:hprod_backend, backend),
jprod_backend = get_default_backend(:jprod_backend, backend),
jtprod_backend = get_default_backend(:jtprod_backend, backend),
jacobian_backend = get_default_backend(:jacobian_backend, backend, matrix_free),
hessian_backend = get_default_backend(:hessian_backend, backend, matrix_free),
ghjvprod_backend = get_default_backend(:ghjvprod_backend, backend),
hprod_residual_backend = get_default_backend(:hprod_residual_backend, backend),
jprod_residual_backend = get_default_backend(:jprod_residual_backend, backend),
jtprod_residual_backend = get_default_backend(:jtprod_residual_backend, backend),
jacobian_residual_backend = get_default_backend(:jacobian_residual_backend, backend, matrix_free),
hessian_residual_backend = get_default_backend(:hessian_residual_backend, backend, matrix_free),
excluded_backend::Vector{Symbol} = Symbol[],
gradient_backend = get_default_backend(:gradient_backend, backend; excluded_backend),
hprod_backend = get_default_backend(:hprod_backend, backend; excluded_backend),
jprod_backend = get_default_backend(:jprod_backend, backend; excluded_backend),
jtprod_backend = get_default_backend(:jtprod_backend, backend; excluded_backend),
jacobian_backend = get_default_backend(:jacobian_backend, backend, matrix_free; excluded_backend),
hessian_backend = get_default_backend(:hessian_backend, backend, matrix_free; excluded_backend),
ghjvprod_backend = get_default_backend(:ghjvprod_backend, backend; excluded_backend),
hprod_residual_backend = get_default_backend(:hprod_residual_backend, backend; excluded_backend),
jprod_residual_backend = get_default_backend(:jprod_residual_backend, backend; excluded_backend),
jtprod_residual_backend = get_default_backend(:jtprod_residual_backend, backend; excluded_backend),
jacobian_residual_backend = get_default_backend(:jacobian_residual_backend, backend, matrix_free; excluded_backend),
hessian_residual_backend = get_default_backend(:hessian_residual_backend, backend, matrix_free; excluded_backend),
kwargs...,
)
function F(x; nequ = nequ)
Expand Down
28 changes: 18 additions & 10 deletions src/predefined_backend.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,19 +96,27 @@ function get_default_backend(meth::Symbol, args...; kwargs...)
return get_default_backend(Val(meth), args...; kwargs...)
end

function get_default_backend(::Val{sym}, backend, args...; kwargs...) where {sym}
return predefined_backend[backend][sym]
function get_default_backend(::Val{sym}, backend, args...; excluded_backend::Vector{Symbol}=Symbol[], kwargs...) where {sym}
backend = (sym in excluded_backend) ? EmptyADbackend : predefined_backend[backend][sym]
return backend
end

function get_default_backend(::Val{:jacobian_backend}, backend, matrix_free::Bool = false)
return matrix_free ? EmptyADbackend : predefined_backend[backend][:jacobian_backend]
function get_default_backend(::Val{:jacobian_backend}, backend, matrix_free::Bool = false; excluded_backend::Vector{Symbol}=Symbol[])
backend = (matrix_free || :jacobian_backend in excluded_backend) ? EmptyADbackend : predefined_backend[backend][:jacobian_backend]
return backend
end
function get_default_backend(::Val{:hessian_backend}, backend, matrix_free::Bool = false)
return matrix_free ? EmptyADbackend : predefined_backend[backend][:hessian_backend]

function get_default_backend(::Val{:hessian_backend}, backend, matrix_free::Bool = false; excluded_backend::Vector{Symbol}=Symbol[])
backend = (matrix_free || :hessian_backend in excluded_backend) ? EmptyADbackend : predefined_backend[backend][:hessian_backend]
return backend
end
function get_default_backend(::Val{:jacobian_residual_backend}, backend, matrix_free::Bool = false)
return matrix_free ? EmptyADbackend : predefined_backend[backend][:jacobian_residual_backend]

function get_default_backend(::Val{:jacobian_residual_backend}, backend, matrix_free::Bool = false; excluded_backend::Vector{Symbol}=Symbol[])
backend = (matrix_free || :jacobian_residual_backend in excluded_backend) ? EmptyADbackend : predefined_backend[backend][:jacobian_residual_backend]
return backend
end
function get_default_backend(::Val{:hessian_residual_backend}, backend, matrix_free::Bool = false)
return matrix_free ? EmptyADbackend : predefined_backend[backend][:hessian_residual_backend]

function get_default_backend(::Val{:hessian_residual_backend}, backend, matrix_free::Bool = false; excluded_backend::Vector{Symbol}=Symbol[])
backend = (matrix_free || :hessian_residual_backend in excluded_backend) ? EmptyADbackend : predefined_backend[backend][:hessian_residual_backend]
return backend
end
Loading