-
Notifications
You must be signed in to change notification settings - Fork 15
/
OperatorEnumConstruction.jl
300 lines (275 loc) · 10.5 KB
/
OperatorEnumConstruction.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
module OperatorEnumConstructionModule
import Zygote: gradient
import ..UtilsModule: max_ops
import ..OperatorEnumModule: OperatorEnum, GenericOperatorEnum
import ..EquationModule: string_tree, Node
import ..EvaluateEquationModule: eval_tree_array
import ..EvaluateEquationDerivativeModule: eval_grad_tree_array
"""
OperatorEnum(; binary_operators=[], unary_operators=[], enable_autodiff::Bool=false, extend_user_operators::Bool=false)
Construct an `OperatorEnum` object, defining the possible expressions. This will also
redefine operators for `Node` types, as well as `show`, `print`, and `(::Node)(X)`.
It will automatically compute derivatives with `Zygote.jl`.
# Arguments
- `binary_operators::Vector{Function}`: A vector of functions, each of which is a binary
operator.
- `unary_operators::Vector{Function}`: A vector of functions, each of which is a unary
operator.
- `enable_autodiff::Bool=false`: Whether to enable automatic differentiation.
- `extend_user_operators::Bool=false`: Whether to extend the user's operators to
`Node` types. All operators defined in `Base` will already be extended automatically.
"""
function OperatorEnum(;
binary_operators=[],
unary_operators=[],
enable_autodiff::Bool=false,
extend_user_operators::Bool=false,
)
@assert length(binary_operators) > 0 || length(unary_operators) > 0
@assert length(binary_operators) <= max_ops && length(unary_operators) <= max_ops
binary_operators = Tuple(binary_operators)
unary_operators = Tuple(unary_operators)
for (op, f) in enumerate(map(Symbol, binary_operators))
f = if f in [:pow, :safe_pow]
Symbol(^)
else
f
end
if isdefined(Base, f)
f = :(Base.$(f))
elseif !extend_user_operators
# Skip non-Base operators!
continue
end
Base.MainInclude.eval(
quote
import DynamicExpressions: Node
function $f(l::Node{T1}, r::Node{T2}) where {T1<:Real,T2<:Real}
T = promote_type(T1, T2)
l = convert(Node{T}, l)
r = convert(Node{T}, r)
if (l.constant && r.constant)
return Node(; val=$f(l.val, r.val))
else
return Node($op, l, r)
end
end
function $f(l::Node{T1}, r::T2) where {T1<:Real,T2<:Real}
T = promote_type(T1, T2)
l = convert(Node{T}, l)
r = convert(T, r)
return if l.constant
Node(; val=$f(l.val, r))
else
Node($op, l, Node(; val=r))
end
end
function $f(l::T1, r::Node{T2}) where {T1<:Real,T2<:Real}
T = promote_type(T1, T2)
l = convert(T, l)
r = convert(Node{T}, r)
return if r.constant
Node(; val=$f(l, r.val))
else
Node($op, Node(; val=l), r)
end
end
end,
)
end
# Redefine Base operations:
for (op, f) in enumerate(map(Symbol, unary_operators))
if isdefined(Base, f)
f = :(Base.$(f))
elseif !extend_user_operators
# Skip non-Base operators!
continue
end
Base.MainInclude.eval(
quote
import DynamicExpressions: Node
function $f(l::Node{T})::Node{T} where {T<:Real}
return l.constant ? Node(; val=$f(l.val)) : Node($op, l)
end
end,
)
end
if enable_autodiff
diff_binary_operators = Any[]
diff_unary_operators = Any[]
test_inputs = map(x -> convert(Float32, x), LinRange(-100, 100, 99))
# Create grid over [-100, 100]^2:
test_inputs_xy = reduce(
hcat, reduce(hcat, ([[[x, y] for x in test_inputs] for y in test_inputs]))
)
for op in binary_operators
diff_op(x, y) = gradient(op, x, y)
test_output = diff_op.(test_inputs_xy[1, :], test_inputs_xy[2, :])
gradient_exists = all((x) -> x !== nothing, Iterators.flatten(test_output))
if gradient_exists
push!(diff_binary_operators, diff_op)
else
if verbosity > 0
@warn "Automatic differentiation has been turned off, since operator $(op) does not have well-defined gradients."
end
enable_autodiff = false
break
end
end
for op in unary_operators
diff_op(x) = gradient(op, x)[1]
test_output = diff_op.(test_inputs)
gradient_exists = all((x) -> x !== nothing, test_output)
if gradient_exists
push!(diff_unary_operators, diff_op)
else
if verbosity > 0
@warn "Automatic differentiation has been turned off, since operator $(op) does not have well-defined gradients."
end
enable_autodiff = false
break
end
end
diff_binary_operators = Tuple(diff_binary_operators)
diff_unary_operators = Tuple(diff_unary_operators)
end
if !enable_autodiff
diff_binary_operators = nothing
diff_unary_operators = nothing
end
operators = OperatorEnum(
binary_operators, unary_operators, diff_binary_operators, diff_unary_operators
)
@eval begin
Base.print(io::IO, tree::Node) = print(io, string_tree(tree, $operators))
Base.show(io::IO, tree::Node) = print(io, string_tree(tree, $operators))
import DynamicExpressions: Node
function (tree::Node{T})(X::AbstractArray{T,2})::AbstractArray{T,1} where {T<:Real}
out, did_finish = eval_tree_array(tree, X, $operators)
if !did_finish
out .= T(NaN)
end
return out
end
function (tree::Node{T1})(X::AbstractArray{T2,2}) where {T1<:Real,T2<:Real}
if T1 != T2
T = promote_type(T1, T2)
tree = convert(Node{T}, tree)
X = T.(X)
end
return tree(X)
end
# Gradients:
function Base.adjoint(tree::Node{T}) where {T}
return X -> begin
_, grad, did_complete = eval_grad_tree_array(tree, X, $operators; variable=true)
!did_complete && (grad .= T(NaN))
grad
end
end
end
return operators
end
"""
GenericOperatorEnum(; binary_operators=[], unary_operators=[], extend_user_operators::Bool=false)
Construct a `GenericOperatorEnum` object, defining possible expressions.
Unlike `OperatorEnum`, this enum one will work arbitrary operators and data types.
This will also redefine operators for `Node` types, as well as `show`, `print`,
and `(::Node)(X)`.
# Arguments
- `binary_operators::Vector{Function}`: A vector of functions, each of which is a binary
operator on real scalars.
- `unary_operators::Vector{Function}`: A vector of functions, each of which is a unary
operator on real scalars.
- `extend_user_operators::Bool=false`: Whether to extend the user's operators to
`Node` types. All operators defined in `Base` will already be extended automatically.
"""
function GenericOperatorEnum(;
binary_operators=[], unary_operators=[], extend_user_operators::Bool=false
)
binary_operators = Tuple(binary_operators)
unary_operators = Tuple(unary_operators)
@assert length(binary_operators) > 0 || length(unary_operators) > 0
@assert length(binary_operators) <= max_ops && length(unary_operators) <= max_ops
for (op, f) in enumerate(map(Symbol, binary_operators))
f = if f in [:pow, :safe_pow]
Symbol(^)
else
f
end
if isdefined(Base, f)
f = :(Base.$f)
elseif !extend_user_operators
# Skip non-Base operators!
continue
end
Base.MainInclude.eval(
quote
import DynamicExpressions: Node
function $f(l::Node{T1}, r::Node{T2}) where {T1,T2}
T = promote_type(T1, T2)
l = convert(Node{T}, l)
r = convert(Node{T}, r)
if (l.constant && r.constant)
return Node(; val=$f(l.val, r.val))
else
return Node($op, l, r)
end
end
function $f(l::Node{T1}, r::T2) where {T1,T2}
T = promote_type(T1, T2)
l = convert(Node{T}, l)
r = convert(T, r)
return if l.constant
Node(; val=$f(l.val, r))
else
Node($op, l, Node(; val=r))
end
end
function $f(l::T1, r::Node{T2}) where {T1,T2}
T = promote_type(T1, T2)
l = convert(T, l)
r = convert(Node{T}, r)
return if r.constant
Node(; val=$f(l, r.val))
else
Node($op, Node(; val=l), r)
end
end
end,
)
end
# Redefine Base operations:
for (op, f) in enumerate(map(Symbol, unary_operators))
if isdefined(Base, f)
f = :(Base.$f)
elseif !extend_user_operators
# Skip non-Base operators!
continue
end
Base.MainInclude.eval(
quote
import DynamicExpressions: Node
function $f(l::Node{T})::Node{T} where {T}
return l.constant ? Node(; val=$f(l.val)) : Node($op, l)
end
end,
)
end
operators = GenericOperatorEnum(binary_operators, unary_operators)
@eval begin
Base.print(io::IO, tree::Node) = print(io, string_tree(tree, $operators))
Base.show(io::IO, tree::Node) = print(io, string_tree(tree, $operators))
function (tree::Node)(X; throw_errors::Bool=true)
out, did_finish = eval_tree_array(
tree, X, $operators; throw_errors=throw_errors
)
if !did_finish
return nothing
end
return out
end
end
return operators
end
end