154 lines
4.5 KiB
Python
154 lines
4.5 KiB
Python
# Copyright 2018 The JAX Authors.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# https://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Callable
|
|
import types
|
|
from typing import Any, TypeVar
|
|
|
|
from jax._src import core
|
|
from jax._src.core import typeof
|
|
from jax._src import traceback_util
|
|
from jax._src.core import Primitive
|
|
from jax._src.tree_util import register_pytree_node, tree_map
|
|
from jax._src.typing import Array, ArrayLike
|
|
from jax._src.util import safe_map
|
|
|
|
traceback_util.register_exclusion(__file__)
|
|
|
|
T = TypeVar('T')
|
|
|
|
map = safe_map
|
|
|
|
def add_jaxvals(x: ArrayLike, y: ArrayLike) -> Array:
|
|
from jax._src.hijax import HiType # pytype: disable=import-error
|
|
ty = typeof(x)
|
|
if isinstance(ty, HiType):
|
|
return ty.vspace_add(x, y)
|
|
x, y = core.standard_insert_pvary(x, y)
|
|
return add_jaxvals_p.bind(x, y)
|
|
|
|
add_jaxvals_p = Primitive('add_any')
|
|
add_any_p = add_jaxvals_p
|
|
|
|
@add_jaxvals_p.def_impl
|
|
def add_impl(x, y):
|
|
return raw_jaxval_adders[type(x)](x, y)
|
|
raw_jaxval_adders = {}
|
|
|
|
@add_jaxvals_p.def_abstract_eval
|
|
def add_abstract(x, y):
|
|
assert core.typematch(x, y), (x, y)
|
|
return x
|
|
|
|
def zeros_like_aval(aval: core.AbstractValue) -> Array:
|
|
from jax._src.hijax import HiType # pytype: disable=import-error
|
|
if isinstance(aval, HiType):
|
|
return aval.vspace_zero()
|
|
return aval_zeros_likers[type(aval)](aval)
|
|
aval_zeros_likers: dict[type, Callable[[Any], Array]] = {}
|
|
|
|
def zeros_like_jaxval(val):
|
|
return zeros_like_aval(core.typeof(val))
|
|
|
|
def instantiate(z: Zero | Array) -> Array:
|
|
if isinstance(z, Zero):
|
|
return zeros_like_aval(z.aval)
|
|
return z
|
|
|
|
|
|
class Zero:
|
|
__slots__ = ['aval']
|
|
def __init__(self, aval: core.AbstractValue):
|
|
self.aval = aval
|
|
def __repr__(self) -> str:
|
|
return f'Zero({self.aval})'
|
|
def instantiate(self):
|
|
return zeros_like_aval(self.aval)
|
|
|
|
register_pytree_node(Zero, lambda z: ((), z.aval), lambda aval, _: Zero(aval))
|
|
|
|
def p2tz(primal_value):
|
|
return Zero(typeof(primal_value).to_tangent_aval())
|
|
|
|
def p2cz(primal_value):
|
|
return Zero(typeof(primal_value).to_ct_aval())
|
|
|
|
def a2tz(primal_aval):
|
|
return Zero(primal_aval.to_tangent_aval())
|
|
|
|
|
|
def _stop_gradient_impl(x: T) -> T:
|
|
if not core.valid_jaxtype(x):
|
|
raise TypeError("stop_gradient only works on valid JAX arrays, but "
|
|
f"input argument is: {x}")
|
|
return x
|
|
|
|
stop_gradient_p : Primitive = Primitive('stop_gradient')
|
|
stop_gradient_p.def_impl(_stop_gradient_impl)
|
|
stop_gradient_p.def_abstract_eval(lambda x: x)
|
|
|
|
|
|
# User-facing version of `Zero`
|
|
class SymbolicZero:
|
|
def __init__(self, aval: core.AbstractValue) -> None:
|
|
self.aval = aval
|
|
|
|
def __repr__(self) -> str:
|
|
return self.__class__.__name__
|
|
|
|
# TODO(mattjj,frostig): this forwards attr lookup to self.aval delegate;
|
|
# should dedup with core.Tracer.__getattr__ which does the same thing
|
|
def __getattr__(self, name):
|
|
# if the aval property raises an AttributeError, gets caught here
|
|
try:
|
|
attr = getattr(self.aval, name)
|
|
except KeyError as err:
|
|
raise AttributeError(
|
|
f"{self.__class__.__name__} has no attribute {name}"
|
|
) from err
|
|
else:
|
|
t = type(attr)
|
|
if t is core.aval_property:
|
|
return attr.fget(self)
|
|
elif t is core.aval_method:
|
|
return types.MethodType(attr.fun, self)
|
|
else:
|
|
return attr
|
|
|
|
@staticmethod
|
|
def from_primal_value(val: Any) -> SymbolicZero:
|
|
return SymbolicZero(typeof(val).to_tangent_aval())
|
|
|
|
def zero_from_primal(val, symbolic_zeros=False):
|
|
def f(x):
|
|
t_aval = typeof(x).to_tangent_aval()
|
|
return SymbolicZero(t_aval) if symbolic_zeros else zeros_like_aval(t_aval)
|
|
return tree_map(f, val)
|
|
|
|
|
|
JaxTypeOrTracer = Any
|
|
|
|
def replace_internal_symbolic_zeros(
|
|
x: JaxTypeOrTracer | Zero) -> JaxTypeOrTracer | SymbolicZero:
|
|
return SymbolicZero(x.aval) if type(x) is Zero else x
|
|
|
|
def replace_rule_output_symbolic_zeros(
|
|
x: JaxTypeOrTracer | SymbolicZero) -> JaxTypeOrTracer | Zero:
|
|
return Zero(x.aval) if type(x) is SymbolicZero else x
|
|
|
|
|
|
# TODO(mattjj): remove these after fixing downstream users relying on them
|
|
zeros_like_p: Primitive = Primitive('zeros_like')
|