File size: 50,791 Bytes
5ccb4fd | 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 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 | # Copyright 2022 DeepMind Technologies Limited. All Rights Reserved.
#
# 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
#
# http://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.
"""K-FAC tracing functionality for functions needed for curvature estimation."""
from collections.abc import Iterable
import dataclasses
import functools
import itertools
from typing import Any, Callable, Generic, Sequence, TypeVar
from absl import logging
import jax
import jax.extend as jex
import jax.numpy as jnp
from kfac_jax._src import layers_and_loss_tags as tags
from kfac_jax._src import loss_functions
from kfac_jax._src import tag_graph_matcher as tgm
from kfac_jax._src import utils
from typing_extensions import TypeAlias
# Types for annotations
T = TypeVar("T")
Array = utils.Array
Shape = utils.Shape
Params = utils.Params
FuncArgs = utils.FuncArgs
FuncOuts = utils.FuncOuts
Var = jex.core.Var
LossFunction = loss_functions.LossFunction
LossFunctionInputs = loss_functions.LossFunctionInputs
ProcJaxpr: TypeAlias = "ProcessedJaxpr"
TaggedFunction = Callable[..., tuple[LossFunction, ...]]
Func = Callable[..., T]
FunctionTransformation = Callable[..., T]
TransformedFunction = Callable[..., T]
JaxprExtractor = Callable[..., "ProcessedJaxpr"]
@dataclasses.dataclass(frozen=True, kw_only=True, unsafe_hash=True)
@jax.tree_util.register_pytree_node_class
class LayerVjpData(Generic[T]):
"""A compact class for all data related to layer tag information during VJP."""
primals: tags.LayerData[T]
tangents: tags.LayerData[T]
def tree_flatten(self) -> tuple[
tuple[tags.LayerData[T], tags.LayerData[T]],
None,
]:
return (self.primals, self.tangents), None
@classmethod
def tree_unflatten(cls, aux_data, children):
assert aux_data is None
primals, tangents = children
return cls(primals=primals, tangents=tangents)
LossTagsVjp = tuple[
tuple[LossFunction, ...], Callable[[Sequence[LossFunctionInputs]], Params]
]
LossTagsJvp = tuple[
tuple[LossFunction, ...],
tuple[LossFunctionInputs, ...],
]
LayerTagVjp = tuple[
tuple[LossFunction, ...],
Callable[
[tuple[LossFunctionInputs, ...]],
tuple[LayerVjpData[Array], ...], # pytype: disable=invalid-annotation
],
]
LayerTagVjpAndValueAndGrad = tuple[
tuple[LossFunction, ...],
Callable[
[tuple[LossFunctionInputs, ...]],
tuple[LayerVjpData[Array], ...], # pytype: disable=invalid-annotation
],
Array,
Params,
]
JaxprOrClosedJaxpr = jex.core.Jaxpr | jex.core.ClosedJaxpr
def shape_and_type(x: Array) -> tuple[Shape, jnp.dtype]:
"""Returns the shape and type of the given array."""
return x.shape, x.dtype
def make_cache_key(
func_args: FuncArgs, *args: Any
) -> tuple[utils.PyTreeDef, tuple[tuple[Shape, jnp.dtype], ...]]:
"""Creates a key for caching Jax function arguments."""
args_flat, tree_structure = jax.tree_util.tree_flatten((func_args, args))
return tree_structure, tuple(map(shape_and_type, args_flat))
def extract_tags(
jaxpr: jex.core.Jaxpr,
) -> tuple[tuple[tags.LayerTagEqn, ...], tuple[tags.LossTagEqn, ...]]:
"""Extracts the layer and the loss tags from the given Jaxpr."""
return (
tuple(
eqn for eqn in jaxpr.eqns if isinstance(eqn.primitive, tags.LayerTag)
),
tuple(
eqn for eqn in jaxpr.eqns if isinstance(eqn.primitive, tags.LossTag)
),
)
def name_layer_tags(layer_tags: tuple[tags.LayerTagEqn, ...]) -> None:
# This adds names to all registrations when `auto_register_tags=False`
tag_counter = {}
for layer_tag in layer_tags:
meta = layer_tag.params.get("meta")
if meta is None:
raise ValueError("Layer tag %s has no meta parameter" % layer_tag)
assert isinstance(meta, tags.LayerMetaData)
if meta.name is None:
n = tag_counter.get(layer_tag.primitive.name, 0)
tag_counter[layer_tag.primitive.name] = n + 1
meta.name = f"Manual[{layer_tag.primitive.name}|{n}]"
def order_layer_tags(
params_vars_flat: Sequence[Var],
layer_tags: Sequence[tags.LayerTagEqn],
allow_left_out_params: bool = False,
) -> tuple[tuple[tags.LayerTagEqn, ...], tuple[tuple[int, ...], ...]]:
"""Sorts the layer tags based on the index of the parameters they contain.
Args:
params_vars_flat: A sequence of all parameter variables.
layer_tags: A sequence of all layer tags.
allow_left_out_params: Whether to raise an error if there are any parameter
variables which are not part of a layer tag.
Returns:
A pair of tuples ``(layer_tags, tags_indices)``, where ``layer_tags`` has
the ordered sequence of the input ``layer_tags`` and ``tags_indices``
contains a sequence of tuples, where each tuple has the indices of the
parameters associated with the corresponding layer tag.
"""
tags_param_indices = []
used_indices = set()
for eqn in layer_tags:
# Collect the equation parameter indices
tag_vars = tags.layer_eqn_data(eqn).params
vars_indices = tuple(params_vars_flat.index(v) for v in tag_vars)
meta = eqn.params.get("meta")
if meta is None or not isinstance(meta, tags.LayerMetaData):
raise ValueError(f"Layer tag {eqn} has invalid metadata.")
meta.params_canonical_order = tuple(
i for i, _ in sorted(enumerate(vars_indices), key=lambda x: x[1])
)
if any(i in used_indices for i in vars_indices):
raise ValueError("Reusing variable in a second block.")
used_indices = used_indices.union(vars_indices)
tags_param_indices.append(vars_indices)
left_out_indices = set(range(len(params_vars_flat))) - used_indices
if left_out_indices and not allow_left_out_params:
raise ValueError(
"The following parameter indices were not assigned a "
f"block: {left_out_indices}."
)
if not layer_tags:
return (), ()
else:
# Sort by the vars minimum index
sorted_index_and_blocks = sorted(
zip(layer_tags, tags_param_indices), key=lambda x: min(x[1])
)
return tuple(zip(*sorted_index_and_blocks))
class ProcessedJaxpr(utils.Finalizable):
"""A wrapper around Jaxpr, with useful additional data.
Attributes:
jaxpr: The original Jaxpr that is being wrapped.
consts: The constants returned from the tracing of the original Jaxpr.
in_tree: The PyTree structure of the inputs to the function that the
original Jaxpr has been created from.
params_index: Specifies, which inputs to the function are to be considered a
parameter variable. Specifically - ``inputs[params_index]``.
loss_tags: A tuple of all of the loss tags in the original Jaxpr.
layer_tags: A sorted tuple of all of the layer tags in the original Jaxpr.
The sorting order is based on the indices of the parameters associated
with each layer tag.
layer_indices: A sequence of tuples, where each tuple has the indices of the
parameters associated with the corresponding layer tag.
"""
def __init__(
self,
jaxpr: jex.core.Jaxpr,
consts: list[Any],
in_tree: utils.PyTreeDef,
params_index: int,
allow_left_out_params: bool = False,
):
"""Initializes the instance.
Args:
jaxpr: The raw Jaxpr.
consts: The constants needed for evaluation of the raw Jaxpr.
in_tree: The PyTree structure of the inputs to the function that the
``jaxpr`` has been created from.
params_index: Specifies, which inputs to the function are to be considered
a parameter variable. Specifically - ``inputs[params_index]``.
allow_left_out_params: Whether to raise an error if any of the parameter
variables is not included in any layer tag.
"""
super().__init__()
self.jaxpr = jaxpr
self.consts = consts
self.in_tree = in_tree
self.params_index = params_index
# Positional construction works before and after JAX 0.11's
# Jaxpr/ClosedJaxpr merge; keyword ``jaxpr=`` no longer does.
closed_jaxpr = jex.core.ClosedJaxpr(self.jaxpr, self.consts)
self.jaxpr, self.layer_tags = tgm.clean_layer_tags_jaxpr(closed_jaxpr)
self.jaxpr = self.jaxpr.jaxpr
_, self.loss_tags = extract_tags(self.jaxpr)
name_layer_tags(self.layer_tags)
self.layer_tags, self.layer_indices = order_layer_tags(
params_vars_flat=self.params_vars_flat,
layer_tags=self.layer_tags,
allow_left_out_params=allow_left_out_params,
)
self.finalize()
@property
def in_vars_flat(self) -> list[Var]:
"""A flat list of all of the abstract input variables."""
return self.jaxpr.invars
@property
def in_vars(self) -> utils.PyTree[Var]:
"""The abstract input variables, as an un-flatten structure."""
return jax.tree_util.tree_unflatten(self.in_tree, self.in_vars_flat)
@property
def params_vars(self) -> utils.PyTree[Var]:
"""The abstract parameter variables, as an un-flatten structure."""
return self.in_vars[self.params_index]
@property
def params_vars_flat(self) -> list[Var]:
"""A flat list of all abstract parameter variables."""
return jax.tree_util.tree_leaves(self.params_vars)
@property
def params_tree(self) -> utils.PyTreeDef:
"""The PyTree structure of the parameter variables."""
return jax.tree_util.tree_structure(self.params_vars)
def log_registered_losses(self):
logging.info("Graph registered losses:")
for loss_tag in self.loss_tags:
meta = loss_tag.params.get("meta")
assert meta is not None and isinstance(meta, tags.LossMetaData)
assert len(loss_tag.invars) == len(meta.argument_names)
args = []
for name, var in zip(meta.argument_names, loss_tag.invars):
args.append(f"{name}={var}")
args_str = ", ".join(args)
logging.info("%s(%s)", tags.loss_eqn_class_name(loss_tag), args_str)
logging.info("=" * 50)
def reconstruct_losses(
self,
losses_inputs: tuple[LossFunctionInputs, ...],
) -> tuple[LossFunction, ...]:
losses = []
for eqn, loss_args in zip(self.loss_tags, losses_inputs):
loss: LossFunction = tags.loss_eqn_construct_loss(eqn, *loss_args)
losses.append(loss)
return tuple(losses)
@classmethod
def make_from_func(
cls,
func: Func[Any],
func_args: FuncArgs,
params_index: int = 0,
auto_register_tags: bool = True,
allow_left_out_params: bool = False,
**auto_registration_kwargs: Any,
) -> ProcJaxpr:
"""Constructs a :class:`~ProcessedJaxpr` from a the given function.
Args:
func: The model function, which will be traced.
func_args: Function arguments to use for tracing.
params_index: The variables from the function arguments which are at this
index (e.g. ``func_args[params_index]``) are to be considered model
parameters.
auto_register_tags: Whether to run an automatic layer registration on the
function (e.g. :func:`~auto_register_tags`).
allow_left_out_params: If this is set to ``False`` an error would be
raised if there are any model parameters that have not be assigned to a
layer tag.
**auto_registration_kwargs: Any additional keyword arguments, to be passed
to the automatic registration pass.
Returns:
A :class:`~ProcessedJaxpr` representing the model function.
"""
func_args = tuple(func_args)
if auto_register_tags:
func = tgm.auto_register_tags(
func=func,
func_args=func_args,
params_index=params_index,
**auto_registration_kwargs,
)
typed_jaxpr = jax.make_jaxpr(func)(*func_args)
jaxpr, consts = typed_jaxpr.jaxpr, typed_jaxpr.literals
in_tree = jax.tree_util.tree_structure(func_args)
processed_jaxpr = ProcessedJaxpr(
jaxpr=jaxpr,
consts=consts,
in_tree=in_tree,
params_index=params_index,
allow_left_out_params=allow_left_out_params,
)
processed_jaxpr.log_registered_losses()
return processed_jaxpr
def __eq__(self, other: ProcJaxpr) -> bool:
"""Compares two ProcessedJaxpr instances by tree structure."""
# Verify whether input trees are equivalent
if self.in_tree != other.in_tree:
return False
# Verify whether layer indices are equivalent
if len(self.layer_indices) != len(other.layer_indices):
return False
for ref_l_index, l_index in zip(self.layer_indices, other.layer_indices):
if len(ref_l_index) != len(l_index):
return False
if any(p_i != p_j for p_i, p_j in zip(ref_l_index, l_index)):
return False
# Verify layer tags are equivalent
if len(self.layer_tags) != len(other.layer_tags):
return False
if any(
ref_tag.primitive != tag.primitive
for ref_tag, tag in zip(self.layer_tags, other.layer_tags)
):
return False
# Verify whether parameter shapes are equivalent
if any(
p_i.aval.shape != p_j.aval.shape # pytype: disable=attribute-error
for p_i, p_j in zip(self.params_vars_flat, other.params_vars_flat)
):
return False
return True
def cached_transformation(
func: Func[T],
transformation: FunctionTransformation[T],
params_index: int = 0,
auto_register_tags: bool = True,
allow_left_out_params: bool = False,
allow_no_losses: bool = False,
raise_error_on_diff_jaxpr: bool = True,
**auto_registration_kwargs: Any,
) -> tuple[TransformedFunction[T], JaxprExtractor]:
"""Caches ``transformation(preprocessed_jaxpr, func_args, *args)``.
The caching mechanism uses the ``func_args`` PyTree, dtypes and shapes for
hashing.
Args:
func: The main model function, which will be transformed.
transformation: The actual transformation of ``func``.
params_index: The variables from the function arguments which are at this
index (e.g. ``func_args[params_index]``) are to be considered model
parameters.
auto_register_tags: Whether to run an automatic layer registration on the
function (e.g. :func:`~auto_register_tags`).
allow_left_out_params: If this is set to ``False`` an error would be raised
if there are any model parameters that have not be assigned to a layer
tag.
allow_no_losses: If this is set to ``False`` an error would be raised if no
registered losses have been found when tracing the function.
raise_error_on_diff_jaxpr: Whether to raise an exception if the function has
been traced before, with different arguments, and the new Jaxpr graph
differs in more than just the shapes and dtypes of the Jaxpr equations.
**auto_registration_kwargs: Any additional keyword arguments, to be passed
to the automatic registration pass.
Returns:
A function with a signature ``f(func_args, *args, return_only_jaxpr)`` which
evaluates the transformation of ``func`` at ``func_args``. The extra
``args`` are any additional array arguments passed to the transformation,
while the last flag indicates whether to just return the
:class:`~ProcessedJaxpr` instead of the transformation output. Also returns
a function that returns the processed Jaxpr of `func` for a given set of
function arguments.
"""
cache = {}
def retrieve(func_args):
# Construct a key and check cache for hits
key = make_cache_key(func_args)
if key not in cache:
# Process the function
processed_jaxpr = ProcessedJaxpr.make_from_func(
func=func,
func_args=func_args,
params_index=params_index,
auto_register_tags=auto_register_tags,
allow_left_out_params=allow_left_out_params,
**auto_registration_kwargs,
)
if not allow_no_losses and not processed_jaxpr.loss_tags:
raise ValueError("No registered losses have been found during tracing.")
if cache and raise_error_on_diff_jaxpr:
# If any previous `ProcessedJaxpr` exists verify that it is equivalent
ref_jaxpr, _ = cache[next(iter(cache))]
if ref_jaxpr != processed_jaxpr:
raise ValueError(
"The consecutive tracing of the provided function "
"yielded a non-equivalent `ProcessedJaxpr`."
)
f = functools.partial(transformation, processed_jaxpr)
cache[key] = (processed_jaxpr, f)
return cache[key]
@functools.wraps(transformation)
def wrapped_transformation(func_args: FuncArgs, *args: Any) -> T:
_, f = retrieve(func_args)
return f(func_args, *args)
def get_processed_jaxpr(func_args: FuncArgs, *_: Any) -> ProcessedJaxpr:
closed_jaxpr, _ = retrieve(func_args)
return closed_jaxpr
return wrapped_transformation, get_processed_jaxpr
def construct_compute_losses_inputs(
processed_jaxpr: ProcessedJaxpr,
primal_func_args: FuncArgs,
params_index: int,
drop_loss_tags: bool = True,
) -> Callable[
[Params],
tuple[tuple[LossFunctionInputs, ...], tuple[LossFunctionInputs, ...]],
]:
"""Constructs a function that computes the inputs to all loss tags.
The returned function takes as input only the parameters, as specified by
``params_index``, and returns a tuple containing the input values to the first
``num_losses`` loss tags in the Jaxpr. This is done by iterating sequentially
over all equations in the Jaxpr, evaluating each equation, until the correct
number of loss tags have been discovered and returning the values of their
inputs.
Args:
processed_jaxpr: The `ProcessedJaxpr` representing the function.
primal_func_args: The concrete values for the inputs to the Jaxpr.
params_index: The variables from the function arguments which are at this
index (e.g. ``func_args[params_index]``) are to be considered model
parameters.
drop_loss_tags: Whether to remove the loss tags primitive when computing the
loss functions inputs.
Returns:
A function which computes the inputs to the first ``num_losses`` loss tags.
"""
def forward_compute_losses(
primal_params: Params,
) -> tuple[tuple[LossFunctionInputs, ...], tuple[LossFunctionInputs, ...]]:
"""Computes and returns the inputs to the first ``num_losses`` loss tags."""
# Check the provided inputs match the original primals.
local_func_args = list(primal_func_args)
original_params = local_func_args[params_index]
if not utils.abstract_objects_equal(original_params, primal_params):
raise ValueError(
"The `primal_params` should have the same abstract "
"structure as the original parameters passed in to the "
"function."
)
local_func_args[params_index] = primal_params
flat_args = jax.tree_util.tree_leaves(local_func_args)
# Mapping from variable -> value
env = {}
read = functools.partial(tgm.read_env, env)
write = functools.partial(tgm.write_env, env)
# Bind args and consts to environment
write(processed_jaxpr.jaxpr.invars, flat_args)
write(processed_jaxpr.jaxpr.constvars, processed_jaxpr.consts)
# Loop through equations and evaluate primitives using `bind`
losses_so_far = 0
losses_p_deps = []
losses_inputs = []
for eqn in processed_jaxpr.jaxpr.eqns:
if isinstance(eqn.primitive, tags.LossTag):
assert eqn == processed_jaxpr.loss_tags[losses_so_far]
if not drop_loss_tags:
write(eqn.outvars, tgm.eval_jaxpr_eqn(eqn, read(eqn.invars)))
losses_inputs.append(read(eqn.invars))
losses_p_deps.append(read(tags.loss_eqn_parameter_dependants(eqn)))
losses_so_far += 1
else:
write(eqn.outvars, tgm.eval_jaxpr_eqn(eqn, read(eqn.invars)))
if losses_so_far == len(processed_jaxpr.loss_tags):
break
return tuple(tuple(p) for p in losses_p_deps), tuple(losses_inputs) # pytype: disable=bad-return-type
return forward_compute_losses
def _compute_all_losses(
p_jaxpr: ProcessedJaxpr,
primal_func_args: FuncArgs,
) -> tuple[LossFunction, ...]:
"""Returns all loss functions objects."""
if not p_jaxpr.loss_tags:
raise ValueError("The provided `ProcessedJaxpr` has no loss tags.")
losses_func = construct_compute_losses_inputs(
processed_jaxpr=p_jaxpr,
primal_func_args=primal_func_args,
params_index=p_jaxpr.params_index,
)
_, losses_inputs = losses_func(primal_func_args[p_jaxpr.params_index])
return p_jaxpr.reconstruct_losses(losses_inputs)
def _loss_tags_vjp(
p_jaxpr: ProcessedJaxpr,
primal_func_args: FuncArgs,
) -> LossTagsVjp:
"""Computes a (backward-mode) vector-Jacobian product for the vector of losses given by the loss tags.
The function has similar interface to :func:`jax.vjp`. It takes as inputs the
concrete values of the primals at which the Jacobian will be evaluated. It
returns a pair of ``(losses, losses_vjp)``, where losses is a tuple of
:class:`~LossFunction` objects and ``vjp_func`` is a function
taking as inputs the concrete values of the tangents of the inputs for each
loss tag (corresponding to a loss object in ``losses``) and returns the
corresponding tangents of the parameters.
Args:
p_jaxpr: The :class:``~ProcessedJaxpr`` representing the model function.
This must include at least one loss tag.
primal_func_args: The primals at which to evaluate the Jacobian.
Returns:
The computed ``losses`` and ``losses_vjp`` pair.
"""
if not p_jaxpr.loss_tags:
raise ValueError("The provided `ProcessedJaxpr` has no loss tags.")
losses_func = construct_compute_losses_inputs(
processed_jaxpr=p_jaxpr,
primal_func_args=primal_func_args,
params_index=p_jaxpr.params_index,
)
primal_params = primal_func_args[p_jaxpr.params_index]
_, full_vjp_func, losses_inputs = jax.vjp(
losses_func, primal_params, has_aux=True
)
def losses_vjp_func(losses_tangents: Sequence[LossFunctionInputs]) -> Params:
"""Computes the vector-Jacobian product w.r.t. the parameters.
Args:
losses_tangents: The tangents to all loss tag's inputs.
Returns:
The parameters' tangents, as a result of the vector-Jacobian product.
"""
if len(losses_tangents) != len(p_jaxpr.loss_tags):
raise ValueError(
"The argument `tangents` must be a sequence of the "
"tangents to each loss tag in the same order as the "
"loss objects that have been returned. The number of "
f"loss_tags is {len(p_jaxpr.loss_tags)}, but the length "
f"of `tangents` is {len(losses_tangents)}."
)
for i, loss_tangents in enumerate(losses_tangents):
if not isinstance(loss_tangents, Sequence):
raise ValueError(
"Each element of the argument `tangents` must be "
f"a sequence, but tangents[{i}] has type "
f"{type(loss_tangents)}."
)
[params_tangents] = full_vjp_func(losses_tangents)
return params_tangents
return p_jaxpr.reconstruct_losses(losses_inputs), losses_vjp_func
def _loss_tags_jvp(
p_jaxpr: ProcessedJaxpr,
primal_func_args: FuncArgs,
params_tangents: Params,
) -> LossTagsJvp:
"""Computes a (forward-mode) Jacobian-vector product for the losses given by the loss tags.
The function has similar interface to :func:`jax.jvp`. It takes as inputs the
concrete values of the primals at which the Jacobian will be evaluated at and
the concrete values of the tangents for the **parameters**, as specified by
``processed_jaxpr.params_index``. It returns a pair of
``(losses, losses_tangents)``, where ``losses`` is a tuple of
:class:`~LossFunction` objects, and ``losses_tangents`` is
a tuple containing the tangents of the inputs for each loss tag (corresponding
to a loss object in ``losses``).
Args:
p_jaxpr: The :class:`~ProcessedJaxpr` representing the model function. This
must include at least one loss tag.
primal_func_args: The primals at which to evaluate the Jacobian.
params_tangents: The vector of tangents which to multiply with the Jacobian.
Returns:
The computed ``losses`` and ``losses_tangents`` pair.
"""
if not p_jaxpr.loss_tags:
raise ValueError("The provided `ProcessedJaxpr` has no loss tags.")
losses_func = construct_compute_losses_inputs(
processed_jaxpr=p_jaxpr,
primal_func_args=primal_func_args,
params_index=p_jaxpr.params_index,
)
primal_params = (primal_func_args[p_jaxpr.params_index],)
tangents = (params_tangents,)
(_, losses_tangents, losses_inputs) = jax.jvp(
losses_func, primal_params, tangents, has_aux=True
)
return p_jaxpr.reconstruct_losses(losses_inputs), losses_tangents
def _loss_tags_hvp(
processed_jaxpr: ProcessedJaxpr,
primal_func_args: FuncArgs,
params_tangents: Params,
) -> tuple[Params, tuple[LossFunction, ...]]:
"""Computes a Hessian-vector product of the function w.r.t. all loss tags.
The function takes as inputs the concrete values of the primals for the
function arguments at which the Hessian will be evaluated at and the concrete
values of the tangents for the **parameters**, as specified by
``processed_jaxpr.params_index``. It returns the product of the Hessian with
this tangents via backward-over-forward mode.
Args:
processed_jaxpr: The :class:`~ProcessedJaxpr` representing the model
function. This must include at least one loss tag.
primal_func_args: The primals at which to evaluate the Hessian.
params_tangents: The vector of tangents which to multiply with the Hessian.
Returns:
The parameter-structured vector representing the Hessian-vector product and
the resulting :class:`~LossFunction` objects that correspond to every
loss tag.
"""
if not processed_jaxpr.loss_tags:
raise ValueError("The provided `ProcessedJaxpr` has no loss tags.")
losses_func = construct_compute_losses_inputs(
processed_jaxpr=processed_jaxpr,
primal_func_args=primal_func_args,
params_index=processed_jaxpr.params_index,
)
def losses_sum(param_primals: Params) -> Array:
# This computes the sum of losses evaluated. Makes it easier because we can
# now use jax.grad rather than jax.vjp for taking derivatives.
_, losses_inputs = losses_func(param_primals)
losses = processed_jaxpr.reconstruct_losses(losses_inputs)
return sum(jnp.sum(loss.evaluate()) for loss in losses)
# Directional derivative function
df_dot_dv = lambda p: (jax.jvp(losses_sum, [p], [params_tangents])[1])
hvp = jax.grad(df_dot_dv)(primal_func_args[processed_jaxpr.params_index])
_, losses_inputs = losses_func(primal_func_args[processed_jaxpr.params_index])
return hvp, processed_jaxpr.reconstruct_losses(losses_inputs)
@jax.tree_util.register_dataclass
@dataclasses.dataclass(frozen=True)
class VarMap:
"""A mapping from jaxpr variables to values.
Variables in a jaxpr are not ordered, and thus ``dict[Var, ...]`` cannot be
passed to PyTree APIs. This class works around that by indexing the dict
on the ID of each variable instead of the variable itself.
"""
id_to_var: dict[int, Var] = dataclasses.field(
default_factory=dict, metadata=dict(static=True)
)
var_to_val: dict[int, Any] = dataclasses.field(default_factory=dict)
def __contains__(self, var: Var) -> bool:
return id(var) in self.id_to_var
def __getitem__(self, var: Var) -> Any:
return self.var_to_val[id(var)]
def get(self, var: Var) -> Any:
return self.var_to_val[id(var)]
def update(self, it: Iterable[tuple[Var, Any]]) -> None:
for var, val in it:
self.id_to_var[id(var)] = var
self.var_to_val[id(var)] = val
@classmethod
def create(cls, it: Iterable[tuple[Var, Any]]) -> "VarMap":
self = cls()
self.update(it)
return self
def _layer_tag_vjp(
processed_jaxpr: ProcessedJaxpr,
primal_func_args: FuncArgs,
) -> LayerTagVjp:
"""Computes primal values and tangents w.r.t. all layer tags.
The returned function has similar interface to :func:`jax.vjp`. It takes as
inputs the concrete values of the primals at which the Jacobian will be
evaluated. It returns a pair of ``(losses, vjp_func)``, where losses is a
tuple of :class:`~LossFunction` objects and ``vjp_func`` is a function taking
as inputs the concrete values of the tangents of the inputs for each loss tag
(corresponding to a loss object in ``losses``) and returns a list of
quantities computed for each layer tag in ``processed_jaxpr``. Each entry of
the list is a :class:`~LayerVjpData` with the keys ``"primals", "tangents"``
mapping to LayerData objects that each separate the primals (or tangents) into
inputs, outputs, and parameters.
Args:
processed_jaxpr: The :class:`~ProcessedJaxpr` representing the model
function. This must include at least one loss tag.
primal_func_args: The primals at which to evaluate the Jacobian.
Returns:
The computed ``losses`` and ``vjp_func`` pair.
"""
layer_tag_invars = jax.tree_util.tree_leaves(
[tag.invars for tag in processed_jaxpr.layer_tags]
)
# We exclude literals because they are not hashable. Their values will be read
# properly for the primals due to the special handling in tgm.read_env. For
# the tangents they won't matter, since only layer inputs (which together with
# the layer outputs and params form the layer tag invars) can be literals, and
# we explicitly exclude the inputs from the tangents (since their computation
# isn't generally correct anyway).
layer_tag_invars = list(set(v for v in layer_tag_invars
if not isinstance(v, jex.core.Literal)))
def forward() -> tuple[Array, ...]:
"""Computes the values of all inputs to all **layer** tags."""
own_func_args = primal_func_args
# Mapping from variable -> value
env = {}
read = functools.partial(tgm.read_env, env)
write = functools.partial(tgm.write_env, env)
# Bind args and consts to environment
write(
processed_jaxpr.jaxpr.invars, jax.tree_util.tree_leaves(own_func_args)
)
write(processed_jaxpr.jaxpr.constvars, processed_jaxpr.consts)
# Loop through equations and evaluate them
num_losses_passed = 0
for eqn in processed_jaxpr.jaxpr.eqns:
if isinstance(eqn.primitive, tags.LossTag):
num_losses_passed += 1
if num_losses_passed == len(processed_jaxpr.loss_tags):
break
else:
write(eqn.outvars, tgm.eval_jaxpr_eqn(eqn, read(eqn.invars)))
assert num_losses_passed == len(processed_jaxpr.loss_tags)
return tuple(read(layer_tag_invars))
def forward_aux(
aux: dict[Var, Array],
) -> tuple[tuple[LossFunctionInputs, ...], tuple[LossFunctionInputs, ...]]:
"""Computes the inputs and kwargs of all **loss** tags.
Args:
aux: A mapping from an Jaxpr variable to an additional auxiliary value.
For each variable in this mapping, we add to the value computed during
standard evaluation the auxiliary value. This is done in order to be
able to compute gradients wrt all intermediate expressions corresponding
to the Jaxpr variables in this mapping
Returns:
The pair of ``(losses_inputs, losses_kwargs)`` where ``losses_inputs``
is a tuple of the input values for each loss tag, and ``losses_kwargs``
is a tuple of the kwargs values of each loss tag.
"""
own_func_args = primal_func_args
# Mapping from variable -> value
env: dict[jex.core.Var, Array] = {}
read = functools.partial(tgm.read_env, env)
def write(variables: list[jex.core.Var], values: list[Array]) -> None:
tgm.write_env(env, variables, values)
for v in variables:
if not isinstance(v, jex.core.Literal) and v in aux:
env[v] = env[v] + aux[v]
# Bind args and consts to environment
write(
processed_jaxpr.jaxpr.invars, jax.tree_util.tree_leaves(own_func_args)
)
write(processed_jaxpr.jaxpr.constvars, processed_jaxpr.consts)
# Loop through equations and evaluate primitives using `bind`
num_losses_passed = 0
losses_p_dependants = []
losses_inputs_values = []
for eqn in processed_jaxpr.jaxpr.eqns:
input_values = read(eqn.invars)
if isinstance(eqn.primitive, tags.LossTag):
loss: LossFunction = tags.loss_eqn_construct_loss(eqn, *input_values)
losses_p_dependants.append(loss.parameter_dependants)
losses_inputs_values.append(tuple(input_values))
num_losses_passed += 1
if num_losses_passed == len(processed_jaxpr.loss_tags):
break
else:
write(eqn.outvars, tgm.eval_jaxpr_eqn(eqn, input_values))
assert num_losses_passed == len(processed_jaxpr.loss_tags)
# Read the inputs to the loss functions, but also return the target values
return tuple(losses_p_dependants), tuple(losses_inputs_values)
# First compute the primal values for the inputs to all layer tags
layer_input_values = forward()
primals = zip(layer_tag_invars, layer_input_values)
# Update with the values of all parameters, which are inputs to the function
primals = itertools.chain(
primals,
zip(
processed_jaxpr.jaxpr.invars,
jax.tree_util.tree_leaves(primal_func_args),
),
)
primals_dict = VarMap.create(primals)
# Create auxiliary values all equal to zero.
aux_values = jax.tree_util.tree_map(jnp.zeros_like, layer_input_values)
# Create a mapping from all layer tag inputs to the zero values
aux_dict = VarMap.create(zip(layer_tag_invars, aux_values))
# These values would now allow us to compute gradients wrt the layer tags
# inputs, which are intermediate expressions in the Jaxpr.
_, aux_vjp, losses_inputs = jax.vjp(forward_aux, aux_dict, has_aux=True)
# Compute the actual loss objects.
losses: list[LossFunction] = [
tags.loss_eqn_construct_loss(tag, *inputs)
for tag, inputs in zip(processed_jaxpr.loss_tags, losses_inputs)
]
def vjp_func(
tangents: tuple[LossFunctionInputs, ...], # pytype: disable=invalid-annotation
) -> tuple[LayerVjpData[Array], ...]: # pytype: disable=invalid-annotation
"""Computes a (reverse-mode) vector-Jacobian product w.r.t. all layer tags.
Args:
tangents: The concrete tangent values for the tangents of the inputs to
all **loss** tags.
Returns:
A tuple containing both the primal and tangent values for the inputs to
all **layer** tags. The values are provided as a dictionary with keys:
``inputs, outputs, params, outputs_tangent, params_tangent``.
"""
[tangents_dict] = aux_vjp(tangents)
read_primals = functools.partial(tgm.read_env, primals_dict)
read_tangents = functools.partial(tgm.read_env, tangents_dict)
layers_info = []
for tag in processed_jaxpr.layer_tags:
primals = read_primals(tag.invars) # pytype: disable=wrong-arg-types
tangents = read_tangents(tag.invars)
# The input tangents could be potentially wrong, so we don't include them.
# This is because the one of the invars could be a Literal, which breaks
# the above logic, or one of the invars could be shared with another
# layer, so that both layers would get the sum of the input tangents for
# that variable. There is also the possibility of "input preprocessing",
# which affects the tag inputs but not the corresponding layer in the
# graph.
layers_info.append(LayerVjpData(
primals=tag.primitive.layer_data(primals, tag.params),
tangents=tag.primitive.layer_data(tangents, tag.params,
exclude_inputs=True),
))
return tuple(layers_info)
return tuple(losses), vjp_func
def _layer_tag_vjp_and_value_and_grad_from_surrogate(
processed_jaxpr: ProcessedJaxpr,
primal_func_args: FuncArgs,
) -> LayerTagVjpAndValueAndGrad:
"""Transposes one tagged forward for KFAC and ordinary gradients.
The source function returns ``(primal_loss, gradient_surrogate)``. Its
surrogate has the desired first-order parameter gradient, while the first
result is the loss value reported by the optimizer. Artificial injections at
every layer operand (including every owned model parameter) are exposed to
one VJP. Exact-Fisher seeds and the surrogate gradient therefore reuse the
same model primal evaluation, while curvature retains the established
aux-only transpose structure. This is only first-order reverse mode: unlike
transforming a custom-JVP or an already transposed value-and-grad graph, it
cannot introduce Hessian-vector work.
"""
layer_tag_invars = jax.tree_util.tree_leaves(
[tag.invars for tag in processed_jaxpr.layer_tags]
)
layer_tag_invars = list(
set(
var
for var in layer_tag_invars
if not isinstance(var, jex.core.Literal)
)
)
def forward_aux(aux: VarMap):
env: dict[jex.core.Var, Array] = {}
read = functools.partial(tgm.read_env, env)
def write(variables: list[jex.core.Var], values: list[Array]) -> None:
tgm.write_env(env, variables, values)
for var in variables:
if not isinstance(var, jex.core.Literal) and var in aux:
env[var] = env[var] + aux[var]
write(
processed_jaxpr.jaxpr.invars,
jax.tree_util.tree_leaves(primal_func_args),
)
write(processed_jaxpr.jaxpr.constvars, processed_jaxpr.consts)
losses_inputs_values = []
losses_p_dependants = []
for eqn in processed_jaxpr.jaxpr.eqns:
input_values = read(eqn.invars)
if isinstance(eqn.primitive, tags.LossTag):
loss = tags.loss_eqn_construct_loss(eqn, *input_values)
losses_inputs_values.append(tuple(input_values))
losses_p_dependants.append(loss.parameter_dependants)
write(eqn.outvars, tgm.eval_jaxpr_eqn(eqn, input_values))
if len(losses_inputs_values) != len(processed_jaxpr.loss_tags):
raise ValueError(
"The shared-forward interpreter did not encounter every "
"registered loss."
)
forward_outputs = tuple(read(processed_jaxpr.jaxpr.outvars))
if len(forward_outputs) != 2:
raise ValueError(
"The shared-forward source must return exactly "
"`(primal_loss, gradient_surrogate)`; got "
f"{len(forward_outputs)} flattened outputs."
)
primal_loss, gradient_surrogate = forward_outputs
for name, value in (
("primal_loss", primal_loss),
("gradient_surrogate", gradient_surrogate),
):
if value.shape:
raise ValueError(
f"The shared-forward `{name}` must be scalar; got shape "
f"{value.shape}."
)
return (
(tuple(losses_p_dependants), gradient_surrogate),
(
tuple(losses_inputs_values),
tuple(read(layer_tag_invars)),
primal_loss,
gradient_surrogate,
),
)
aux_values = tuple(
jnp.zeros(var.aval.shape, var.aval.dtype) for var in layer_tag_invars
)
aux_dict = VarMap.create(zip(layer_tag_invars, aux_values))
_, aux_vjp, forward_values = jax.vjp(
forward_aux,
aux_dict,
has_aux=True,
)
(
losses_inputs,
layer_input_values,
primal_loss,
gradient_surrogate,
) = forward_values
primals = itertools.chain(
zip(layer_tag_invars, layer_input_values),
zip(
processed_jaxpr.jaxpr.invars,
jax.tree_util.tree_leaves(primal_func_args),
),
)
primals_dict = VarMap.create(primals)
losses = tuple(
tags.loss_eqn_construct_loss(tag, *inputs)
for tag, inputs in zip(processed_jaxpr.loss_tags, losses_inputs)
)
def losses_vjp(
tangents: tuple[LossFunctionInputs, ...],
) -> tuple[LayerVjpData[Array], ...]:
[tangents_dict] = aux_vjp(
(tangents, jnp.zeros_like(gradient_surrogate))
)
read_primals = functools.partial(tgm.read_env, primals_dict)
read_tangents = functools.partial(tgm.read_env, tangents_dict)
return tuple(
LayerVjpData(
primals=tag.primitive.layer_data(
read_primals(tag.invars), tag.params
),
tangents=tag.primitive.layer_data(
read_tangents(tag.invars),
tag.params,
exclude_inputs=True,
),
)
for tag in processed_jaxpr.layer_tags
)
zero_loss_tangents = tuple(
jax.tree_util.tree_map(jnp.zeros_like, loss.parameter_dependants)
for loss in losses
)
[gradient_tangents_dict] = aux_vjp(
(zero_loss_tangents, jnp.ones_like(gradient_surrogate))
)
grads = jax.tree_util.tree_unflatten(
processed_jaxpr.params_tree,
tuple(
gradient_tangents_dict[var]
for var in processed_jaxpr.params_vars_flat
),
)
return losses, losses_vjp, primal_loss, grads
def compute_all_losses(
func: Func[Any],
params_index: int = 0,
) -> tuple[TransformedFunction[tuple[LossFunction, ...]], JaxprExtractor]:
"""Creates a function that when called, returns all loss objects.
The returned function takes as inputs the concrete values of the primals for
which to compute the loss objects.
Args:
func: The model function, which must include at least one loss registration.
params_index: The variables from the function arguments which are at this
index (e.g. `func_args[params_index]`) are to be considered model
parameters.
Returns:
A function that computes all loss objects with signature
`Callable[[FuncArgs], tuple[LossFunction, ...]]`, and a function that
returns the processed Jaxpr of `func` for a given set of function arguments.
"""
# Note that this function is independent of any layer tags, hence we can avoid
# calling the auto registration.
return cached_transformation(
func=func,
transformation=_compute_all_losses,
verifier=lambda: None,
params_index=params_index,
auto_register_tags=False,
allow_left_out_params=True,
)
def loss_tags_vjp(
func: Func[Any],
params_index: int = 0,
) -> tuple[TransformedFunction[LossTagsVjp], JaxprExtractor]:
"""Creates a function for the vector-Jacobian product w.r.t. all loss tags.
The returned function has a similar interface to :func:`jax.vjp`. It takes as
inputs the concrete values of the primals at which the Jacobian will be
evaluated. It returns a pair ``(losses, losses_vjp)``, where losses is a
tuple of :class:`~LossFunction` objects and ``vjp_func`` is a function taking
as inputs the concrete values of the tangents of the inputs for each loss tag
(corresponding to a loss object in ``losses``) and returns the corresponding
tangents of the parameters.
Args:
func: The model function, which must include at least one loss registration.
params_index: The variables from the function arguments which are at this
index (e.g. `func_args[params_index]`) are to be considered model
parameters.
Returns:
A function that computes the vector-Jacobian product with signature
`Callable[[FuncArgs], LossTagsVjp]`, and a function that returns the
processed Jaxpr of `func` for a given set of function arguments.
"""
# Note that this function is independent of any layer tags, hence we can avoid
# calling the auto registration.
return cached_transformation(
func=func,
transformation=_loss_tags_vjp,
verifier=lambda: None,
params_index=params_index,
auto_register_tags=False,
allow_left_out_params=True,
)
def loss_tags_jvp(
func: Func[Any],
params_index: int = 0,
) -> tuple[TransformedFunction[LossTagsJvp], JaxprExtractor]:
"""Creates a function for the Jacobian-vector product w.r.t. all loss tags.
The returned function has a similar interface to :func:`jax.jvp`. It takes as
inputs the concrete values of the primals at which the Jacobian will be
evaluated at and the concrete values of the tangents for the **parameters**,
as specified by ``processed_jaxpr.params_index``. It returns a pair
``(losses, losses_tangents)``, where ``losses`` is a tuple of
:class:`~LossFunction` objects, and ``losses_tangents`` is a tuple containing
the tangents of the inputs for each loss tag (corresponding to a loss object
in ``losses``).
Args:
func: The model function, which must include at least one loss registration.
params_index: The variables from the function arguments which are at this
index (e.g. `func_args[params_index]`) are to be considered model
parameters.
Returns:
A function that computes the Jacobian-vector product with signature
`Callable[[FuncArgs, Params], LossTagsVjp]`, and a function that returns
the processed Jaxpr of `func` for a given set of function arguments.
"""
# Note that this function is independent of any layer tags, hence we can avoid
# calling the auto registration.
return cached_transformation(
func=func,
transformation=_loss_tags_jvp,
verifier=lambda: None,
params_index=params_index,
auto_register_tags=False,
allow_left_out_params=True,
)
def loss_tags_hvp(
func: Func[Any],
params_index: int = 0,
) -> tuple[
TransformedFunction[tuple[Params, tuple[LossFunction, ...]]], JaxprExtractor
]:
"""Creates a function for the Hessian-vector product w.r.t. all loss tags.
The returned function takes as inputs the concrete values of the primals for
the function arguments at which the Hessian will be evaluated at and the
concrete values of the tangents for the **parameters**, as specified by
``processed_jaxpr.params_index``. It returns the product of the Hessian with
these tangents via backward-over-forward mode autodiff.
Args:
func: The model function, which must include at least one loss registration.
params_index: The variables from the function arguments which are at this
index (e.g. `func_args[params_index]`) are to be considered model
parameters.
Returns:
A function that computes the Hessian-vector product and also returns all
losses, with signature `Callable[[FuncArgs, Params],
tuple[LossTagsVjp, tuple[LossFunction, ...]]`, and a function that returns
the processed Jaxpr of `func` for a given set of function arguments.
"""
# Note that this function is independent of any layer tags, hence we can avoid
# calling the auto registration.
return cached_transformation(
func=func,
transformation=_loss_tags_hvp,
verifier=lambda: None,
params_index=params_index,
auto_register_tags=False,
allow_left_out_params=True,
)
def layer_tags_vjp(
func: Func[Any],
params_index: int = 0,
auto_register_tags: bool = True,
raise_error_on_diff_jaxpr: bool = True,
**auto_registration_kwargs,
) -> tuple[TransformedFunction[LayerTagVjp], JaxprExtractor]:
"""Creates a function for primal values and tangents w.r.t. all layer tags.
The returned function has a similar interface to :func:`jax.vjp`. It takes as
inputs the concrete values of the primals at which the Jacobian will be
evaluated. It returns a pair ``(losses, vjp_func)``, where ``losses`` is a
tuple of :class:`~LossFunction` objects and ``vjp_func`` is a function taking
as inputs the concrete values of the tangents of the inputs for each loss tag
(corresponding to a loss object in ``losses``) and returns a list of
quantities computed for each layer tag in ``processed_jaxpr``. Each entry of
the list is a :class:`~LayerVjpData` with the keys ``"primals", "tangents"``
mapping to LayerData objects that each separate the primals (or tangents) into
inputs, outputs, and parameters.
Args:
func: The model function, which must include at least one loss registration.
params_index: The variables from the function arguments which are at this
index (e.g. ``func_args[params_index]``) are to be considered model
parameters.
auto_register_tags: Whether to run an automatic layer registration on the
function (e.g. :func:`~auto_register_tags`).
raise_error_on_diff_jaxpr: When tracing with different arguments, if the
returned jaxpr has a different graph will raise an exception.
**auto_registration_kwargs: Any additional keyword arguments, to be passed
to the automatic registration pass.
Returns:
Returns the above described function, and a function that returns the
processed Jaxpr of `func` for a given set of function arguments.
"""
return cached_transformation(
func=func,
transformation=_layer_tag_vjp,
params_index=params_index,
auto_register_tags=auto_register_tags,
allow_left_out_params=False,
raise_error_on_diff_jaxpr=raise_error_on_diff_jaxpr,
**auto_registration_kwargs,
)
def layer_tags_vjp_and_value_and_grad(
value_func: Func[Any],
params_index: int = 0,
auto_register_tags: bool = True,
raise_error_on_diff_jaxpr: bool = True,
**auto_registration_kwargs,
) -> tuple[
TransformedFunction[LayerTagVjpAndValueAndGrad],
JaxprExtractor,
]:
"""Creates a layer VJP that also returns loss and surrogate gradient.
``value_func`` must return exactly ``(primal_loss, gradient_surrogate)``.
Both are scalars, and the gradient of the second result with respect to the
parameters must equal the training gradient associated with the first. The
transformed callable receives the ordinary function arguments and executes
the tagged source graph once for exact-Fisher statistics, the reported loss,
and the ordinary parameter gradient.
"""
# The ordinary layer-VJP auto-tagger deliberately discards the function's
# declared outputs. This transform must retain
# `(primal_loss, gradient_surrogate)`, while the matcher itself still stops
# registering layers at the loss tags.
auto_registration_kwargs["compute_only_loss_tags"] = False
return cached_transformation(
func=value_func,
transformation=_layer_tag_vjp_and_value_and_grad_from_surrogate,
params_index=params_index,
auto_register_tags=auto_register_tags,
allow_left_out_params=False,
raise_error_on_diff_jaxpr=raise_error_on_diff_jaxpr,
**auto_registration_kwargs,
)
|