torchzero 0.3.14__py3-none-any.whl → 0.4.0__py3-none-any.whl

torchzero/core/transform.py

@@ -1,440 +1,336 @@
 from abc import ABC, abstractmethod
-from collections.abc import Iterable, Mapping, Sequence
-from typing import Any, Literal, final
+from collections.abc import Mapping, Sequence
+from operator import itemgetter
+from typing import Any, final, cast, TYPE_CHECKING
 
 import torch
 
-from ..utils import TensorList, set_storage_, vec_to_tensors
-from .module import Chain, Chainable, Module, Var
+from .module import Module
+from ..utils import vec_to_tensors, safe_dict_update_
 
-Target = Literal['grad', 'update', 'closure', 'params_direct', 'params_difference', 'update_difference']
+if TYPE_CHECKING:
+    from .chain import Chainable
+    from .objective import Objective
 
 
-class Transform(Module, ABC):
-    """Base class for a transform.
-    This is an abstract class, to use it, subclass it and override ``update_tensors`` and ``apply_tensors`` methods.
+class Transform(Module):
+    """``Transform`` is a ``Module`` with only optional children.
 
-    A transform is a module that can also be applied manually to an arbitrary sequence of tensors.
-    It has two methods:
+    ``Transform`` if more flexible in that as long as there are no children, it can use a custom list of states
+    and settings instead of ``self.state`` and ``self.setting``.
 
-    - ``update_tensors`` updates the internal state of this transform, it doesn't modify tensors. \
-            It may be called multiple times before ``apply_tensors``.
-    - ``apply_tensors`` applies this transform to tensors, without modifying the internal state if possible.
+    To use, subclass this and override ``update_states`` and ``apply_states``.
+    """
+    def __init__(self, defaults: dict[str, Any] | None = None, update_freq: int = 1, inner: "Chainable | None" = None):
+
+        # store update_freq in defaults so that it is scheduleable
+        if defaults is None: defaults = {}
+        safe_dict_update_(defaults, {"__update_freq": update_freq})
+
+        super().__init__(defaults)
+
+        self._objective = None
+        if inner is not None:
+            self.set_child("inner", inner)
+
+    # settings shouldn't mutate, so they are typed as Sequence[Mapping]
+    def update_states(self, objective: "Objective", states: list[dict[str, Any]], settings: Sequence[Mapping[str, Any]]) -> None:
+        """Updates ``states``. This should not modify ``objective.update``."""
+
+    @abstractmethod
+    def apply_states(self, objective: "Objective", states: list[dict[str, Any]], settings: Sequence[Mapping[str, Any]]) -> "Objective":
+        """Updates ``objective`` using ``states``."""
+
+    def _get_states_settings(self, objective: "Objective") -> tuple[list, tuple]:
+        # itemgetter is faster
+        # but need to make sure it returns a tuple, as if there is a single param, it returns the value
+        getter = itemgetter(*objective.params)
+        is_single = len(objective.params) == 1
+        states = getter(self.state)
+        settings = getter(self.settings)
 
-    Alternatively, if update-apply structure doesn't make sense for a transform, all logic can be defined within ``apply_tensors``.
+        if is_single:
+            states = [states, ]
+            settings = (settings, )
 
-    Transform can be applied to tensors corresponding to custom parameters
-    by calling ``keyed_transform_update`` and ``keyed_transform_apply``,
-    parameters will be keys to store per-parameter states, so they should remain the same python objects.
+        else:
+            states = list(states) # itemgetter returns tuple
+
+        return states, settings
+
+    @final
+    def update(self, objective:"Objective"):
+        step = self.increment_counter("__step", 0)
+
+        if step % self.settings[objective.params[0]]["__update_freq"] == 0:
+            states, settings = self._get_states_settings(objective)
+            self.update_states(objective=objective, states=states, settings=settings)
+
+    @final
+    def apply(self, objective: "Objective"):
 
-    Alternatively you can manually create a list of state dictionaries per each tensor and pass it to
-    ``transform_update`` and ``transform_apply``.
+        # inner step
+        if "inner" in self.children:
+            inner = self.children["inner"]
+            objective = inner.step(objective)
 
-    A transform can modify the closure instead of directly modifying update by passing ``target="closure"``.
+        # apply and return
+        states, settings = self._get_states_settings(objective)
+        return self.apply_states(objective=objective, states=states, settings=settings)
 
-    Args:
-        defaults (dict[str,Any] | None): dict with default values.
-        uses_grad (bool):
-            Set this to True if `transform` method uses the `grad` argument. This will ensure
-            `grad` is always computed and can't be None. Otherwise set to False.
-        target (Target, optional):
-            what to set on var. Defaults to 'update'.
 
+
+class TensorTransform(Transform):
+    """``TensorTransform`` is a ``Transform`` that doesn't use ``Objective``, instead it operates
+    on lists of tensors directly.
+
+    This has a ``concat_params`` setting which is used in quite a few modules, for example it is optional
+    in all full-matrix method like Quasi-Newton or full-matrix Adagrad.
+
+    To use, subclass this and override one of ``single_tensor_update`` or ``multi_tensor_update``,
+    and one of ``single_tensor_apply`` or ``multi_tensor_apply``.
+
+    For copying:
+
+    multi tensor:
+    ```
+    def multi_tensor_initialize(self, tensors, params, grads, loss, states, settings):
+        ...
+    def multi_tensor_update(self, tensors, params, grads, loss, states, settings):
+        ...
+    def multi_tensor_apply(self, tensors, params, grads, loss, states, settings):
+        ...
+    ```
+
+    single tensor:
+
+    ```
+    def single_tensor_initialize(self, tensor, param, grad, loss, state, setting):
+        ...
+    def single_tensor_update(self, tensor, param, grad, loss, state, setting):
+        ...
+    def single_tensor_apply(self, tensor, param, grad, loss, state, setting):
+        ...
+    ```
     """
     def __init__(
         self,
-        defaults: dict[str,Any] | None,
+        defaults: dict[str, Any] | None = None,
+        update_freq: int = 1,
+        concat_params: bool = False,
         uses_grad: bool = False,
         uses_loss: bool = False,
-        concat_params: bool = False,
-        update_freq: int = 1,
-        inner: Chainable | None = None,
-        target: Target = 'update',
+        inner: "Chainable | None" = None,
     ):
-        super().__init__(defaults)
-        self._target: Target = target
+        super().__init__(defaults, update_freq=update_freq, inner=inner)
+
+        self._concat_params = concat_params
         self._uses_grad = uses_grad
         self._uses_loss = uses_loss
-        self._concat_params = concat_params
-        self._update_freq = update_freq
-        self._inner = inner
-        self._var = None
 
-    def update_tensors(
+    # ------------------------------- single tensor ------------------------------ #
+    def single_tensor_initialize(
         self,
-        tensors: list[torch.Tensor],
-        params: list[torch.Tensor],
-        grads: list[torch.Tensor] | None,
-        loss: torch.Tensor | float | None,
-        states: list[dict[str, Any]],
-        settings: Sequence[Mapping[str, Any]],
+        tensor: torch.Tensor,
+        param: torch.Tensor,
+        grad: torch.Tensor | None,
+        loss: torch.Tensor | None,
+        state: dict[str, Any],
+        setting: Mapping[str, Any],
     ) -> None:
-        """update function, this shouldn't be called directly. Updates this module."""
+        """initialize ``state`` before first ``update``.
+        """
 
-    @abstractmethod
-    def apply_tensors(
+    def single_tensor_update(
+        self,
+        tensor: torch.Tensor,
+        param: torch.Tensor,
+        grad: torch.Tensor | None,
+        loss: torch.Tensor | None,
+        state: dict[str, Any],
+        setting: Mapping[str, Any],
+    ) -> None:
+        """Updates ``state``. This should not modify ``tensor``.
+        """
+
+    def single_tensor_apply(
+        self,
+        tensor: torch.Tensor,
+        param: torch.Tensor,
+        grad: torch.Tensor | None,
+        loss: torch.Tensor | None,
+        state: dict[str, Any],
+        setting: Mapping[str, Any],
+    ) -> torch.Tensor:
+        """Updates ``tensor`` and returns it. This shouldn't modify ``state`` if possible.
+        """
+        raise NotImplementedError(f"{self.__class__.__name__} doesn't implement `single_tensor_apply`.")
+
+    # ------------------------------- multi tensor ------------------------------- #
+    def multi_tensor_initialize(
         self,
         tensors: list[torch.Tensor],
         params: list[torch.Tensor],
         grads: list[torch.Tensor] | None,
-        loss: torch.Tensor | float | None,
+        loss: torch.Tensor | None,
         states: list[dict[str, Any]],
         settings: Sequence[Mapping[str, Any]],
-    ) -> Sequence[torch.Tensor]:
-        """apply function, this shouldn't be called directly. Applies the update rule to `tensors` and returns them.
-        If possible, this shouldn't modify the internal state of this transform."""
+    ) -> None:
+        """initialize ``states`` before first ``update``.
+        By default calls ``single_tensor_initialize`` on all tensors.
+        """
+        if grads is None:
+            grads = cast(list, [None] * len(tensors))
 
-    @final
-    @torch.no_grad
-    def transform_update(
+        for tensor, param, grad, state, setting in zip(tensors, params, grads, states, settings):
+            self.single_tensor_initialize(tensor=tensor, param=param, grad=grad, loss=loss, state=state, setting=setting)
+
+    def multi_tensor_update(
         self,
         tensors: list[torch.Tensor],
         params: list[torch.Tensor],
         grads: list[torch.Tensor] | None,
-        loss: torch.Tensor | float | None,
+        loss: torch.Tensor | None,
         states: list[dict[str, Any]],
-        settings: Sequence[Mapping[str, Any]] | None,
+        settings: Sequence[Mapping[str, Any]],
     ) -> None:
-        """Updates this transform from an arbitrary sequence of tensors."""
-        if self._concat_params:
-            tensors = [torch.cat([t.ravel() for t in tensors])]
-            params = [torch.cat([p.ravel() for p in params])]
-            grads = [torch.cat([g.ravel() for g in grads])] if grads is not None else None
-
-        if settings is None:
-            settings = [self.defaults for _ in tensors]
-
-        step = self.global_state.get('__step', 0) # that way it gets reset correctly
-        self.global_state['__step'] = step + 1
-
-        num = len(tensors)
-        states = states[:num]
-        settings = settings[:num]
+        """Updates ``states``. This should not modify ``tensor``.
+        By default calls ``single_tensor_update`` on all tensors.
+        """
 
-        # update transform
-        if step % self._update_freq == 0:
-            self.update_tensors(tensors=tensors, params=params, grads=grads, loss=loss, states=states, settings=settings)
+        if grads is None:
+            grads = cast(list, [None] * len(tensors))
 
-        # store for transform_apply
-        self.global_state["__tensors"] = tensors
-        self.global_state["__params"] = params
-        self.global_state["__grads"] = grads
+        for tensor, param, grad, state, setting in zip(tensors, params, grads, states, settings):
+            self.single_tensor_update(tensor=tensor, param=param, grad=grad, loss=loss, state=state, setting=setting)
 
-
-    @final
-    @torch.no_grad
-    def transform_apply(
+    def multi_tensor_apply(
         self,
         tensors: list[torch.Tensor],
         params: list[torch.Tensor],
         grads: list[torch.Tensor] | None,
-        loss: torch.Tensor | float | None,
+        loss: torch.Tensor | None,
         states: list[dict[str, Any]],
-        settings: Sequence[Mapping[str, Any]] | None,
-    ) -> list[torch.Tensor]:
-        """Applies this transform to an arbitrary sequence of tensors.
-        This can be used after ``transform_update`` has been used at least once."""
-
-        if settings is None:
-            settings = [self.defaults for _ in tensors]
+        settings: Sequence[Mapping[str, Any]],
+    ) -> Sequence[torch.Tensor]:
+        """Updates ``tensors`` and returns it. This shouldn't modify ``state`` if possible.
+         By default calls ``single_tensor_apply`` on all tensors.
+         """
 
-        num = len(tensors)
-        states = states[:num]
-        settings = settings[:num]
+        if grads is None:
+            grads = cast(list, [None] * len(tensors))
 
-        un_tensors = tensors
-        un_params = params
-        un_grads = grads
+        ret = []
+        for tensor, param, grad, state, setting in zip(tensors, params, grads, states, settings):
+            u = self.single_tensor_apply(tensor=tensor, param=param, grad=grad, loss=loss, state=state, setting=setting)
+            ret.append(u)
 
-        tensors = self.global_state.pop("__tensors")
-        params  = self.global_state.pop("__params")
-        grads   = self.global_state.pop("__grads")
+        return ret
 
-        # step with inner
-        if self._inner is not None:
-            tensors = apply_transform(self._inner, tensors=un_tensors, params=un_params, grads=un_grads, var=self._var)
-            if self._concat_params:
-                tensors = [torch.cat([t.ravel() for t in tensors])]
+    def _get_grads_loss(self, objective: "Objective"):
+        """evaluates grads and loss only if needed"""
 
-        # apply transform
-        tensors = list(self.apply_tensors(tensors=tensors, params=params, grads=grads, loss=loss, states=states, settings=settings))
+        if self._uses_grad: grads = objective.get_grads()
+        else: grads = None # better explicitly set to None rather than objective.grads because it shouldn't be used
 
-        if self._concat_params:
-            tensors = vec_to_tensors(vec=tensors[0], reference=un_tensors)
+        if self._uses_loss: loss = objective.get_loss(backward=False)
+        else: loss = None
 
-        return tensors
+        return grads, loss
 
-    def _get_keyed_states_settings(self, params: list[torch.Tensor]):
-        if self._concat_params:
-            p = params[0]
-            states = [self.state[p]]
-            settings = [self.settings[p]]
+    @torch.no_grad
+    def _get_cat_updates_params_grads(self, objective: "Objective", grads: list[torch.Tensor] | None):
+        assert self._concat_params
 
-        else:
-            states = []
-            settings = []
-            for p in params:
-                states.append(self.state[p])
-                settings.append(self.settings[p])
+        cat_updates = [torch.cat([u.ravel() for u in objective.get_updates()])]
+        cat_params = [torch.cat([p.ravel() for p in objective.params])]
 
-        return states, settings
+        if grads is None: cat_grads = None
+        else: cat_grads = [torch.cat([g.ravel() for g in grads])]
 
-    @final
-    @torch.no_grad
-    def keyed_transform_update(
-        self,
-        tensors: list[torch.Tensor],
-        params: list[torch.Tensor],
-        grads: list[torch.Tensor] | None,
-        loss: torch.Tensor | float | None,
-    ):
-        """`params` will be used as keys and need to always point to same tensor objects.`"""
-        states, settings = self._get_keyed_states_settings(params)
-        self.transform_update(tensors=tensors, params=params, grads=grads, loss=loss, states=states, settings=settings)
+        return cat_updates, cat_params, cat_grads
 
+    def _gather_tensors(self, objective: "Objective", states: list[dict[str, Any]], settings: Sequence[Mapping[str, Any]]):
+        """returns everything for ``multi_tensor_*``. Concatenates if ```self._concat_params``.
+        evaluates grads and loss if ``self._uses_grad`` and ``self._uses_loss``"""
 
-    @final
-    @torch.no_grad
-    def keyed_transform_apply(
-        self,
-        tensors: list[torch.Tensor],
-        params: list[torch.Tensor],
-        grads: list[torch.Tensor] | None,
-        loss: torch.Tensor | float | None,
-    ):
-        """`params` will be used as keys and need to always point to same tensor objects.`"""
-        states, settings = self._get_keyed_states_settings(params)
-        return self.transform_apply(tensors=tensors, params=params, grads=grads, loss=loss, states=states, settings=settings)
+        # evaluate grads and loss if `self._uses_grad` and `self._uses_loss`
+        grads, loss = self._get_grads_loss(objective)
 
+        # gather all things
+        # concatenate everything to a vec if `self._concat_params`
+        if self._concat_params:
+            tensors, params, grads = self._get_cat_updates_params_grads(objective, grads)
+            states = [states[0]]; settings = [settings[0]]
 
-    def pre_step(self, var: Var) -> None:
-        """Logic to run pre-transform, this way transform has access to  Var."""
-    def post_step(self, var: Var) -> None:
-        """Logic to run post-transform, this way transform has access to  Var."""
+        # or take original values
+        else:
+            tensors=objective.get_updates()
+            params = objective.params
 
-    def update(self, var: Var):
-        if self._target != 'update':
-            raise ValueError("Target must be 'update' to use `update` and `apply` methods. "
-                             f"With {self._target = } only `step` method can be used.")
+        return tensors, params, grads, loss, states, settings
 
-        # var may change, therefore current params and grads have to be extracted and passed explicitly
-        update = var.get_update() # this sets loss
-        if self._uses_grad: var.get_grad()
-        if self._uses_loss: var.get_loss(False)
-        params=var.params
-        self.pre_step(var)
+    @final
+    def update_states(self, objective: "Objective", states: list[dict[str, Any]], settings: Sequence[Mapping[str, Any]]) -> None:
+        tensors, params, grads, loss, states, settings = self._gather_tensors(objective, states, settings)
+
+        # initialize before the first update
+        num_updates = self.increment_counter("__num_updates", 0)
+        if num_updates == 0:
+            self.multi_tensor_initialize(
+                tensors=tensors,
+                params=params,
+                grads=grads,
+                loss=loss,
+                states=states,
+                settings=settings
+            )
 
         # update
-        self._var = var
-        self.keyed_transform_update(update, params, var.grad, var.loss)
-        self._var = None
-
-    def apply(self, var: Var):
-        if self._target != 'update':
-            raise ValueError("Target must be 'update' to use `update` and `apply` methods. "
-                             f"With {self._target = } only `step` method can be used.")
+        self.multi_tensor_update(
+            tensors=tensors,
+            params=params,
+            grads=grads,
+            loss=loss,
+            states=states,
+            settings=settings
+        )
 
-        # var may change, therefore current params and grads have to be extracted and passed explicitly
-        update = var.get_update() # this sets loss
-        if self._uses_grad: var.get_grad()
-        if self._uses_loss: var.get_loss(False)
-        params=var.params
+    @final
+    def apply_states(self, objective: "Objective", states: list[dict[str, Any]], settings: Sequence[Mapping[str, Any]]) -> "Objective":
+        tensors, params, grads, loss, states, settings = self._gather_tensors(objective, states, settings)
+        # note: _gather tensors will re-cat again if `_concat_params`, this is necessary because objective
+        # may have been modified in functional logic, there is no way to know if that happened
 
         # apply
-        self._var = var
-        var.update = self.keyed_transform_apply(update, params, var.grad, var.loss)
-        self._var = None
-
-        self.post_step(var)
-        return var
-
-    def step(self, var: Var) -> Var:
-
-        # var may change, therefore current params and grads have to be extracted and passed explicitly
-        if self._target in ('update', 'update_difference'): var.get_update() # this sets loss
-        if self._uses_grad or self._target == 'grad': var.get_grad()
-        if self._uses_loss: var.get_loss(False)
-        params=var.params
-        self.pre_step(var)
-        self._var = var
-
-        # ---------------------------------- update ---------------------------------- #
-        if self._target == 'update':
-            update = var.get_update()
-            self.keyed_transform_update(update, params, var.grad, var.loss)
-            var.update = list(self.keyed_transform_apply(update, params, var.grad, var.loss))
-            self._var = None
-            return var
-
-        # ----------------------------------- grad ----------------------------------- #
-        if self._target == 'grad':
-            grad = var.get_grad()
-            self.keyed_transform_update(grad, params, grad, var.loss)
-            var.grad = list(self.keyed_transform_apply(grad, params, grad, var.loss))
-            self._var = None
-            return var
-
-        # ------------------------------- params_direct ------------------------------ #
-        if self._target == 'params_direct':
-            self.keyed_transform_update(var.params, params, var.grad, var.loss)
-            new_params = self.keyed_transform_apply(var.params, params, var.grad, var.loss)
-            for p, new_p in zip(var.params, new_params): set_storage_(p, new_p)
-            self._var = None
-            return var
-
-        # ----------------------------- params_differnce ----------------------------- #
-        if self._target == 'params_difference':
-            p_clone = [p.clone() for p in var.params]
-            self.keyed_transform_update(p_clone, params, var.grad, var.loss)
-            new_params = tuple(self.keyed_transform_apply(p_clone, params, var.grad, var.loss))
-            var.update = list(torch._foreach_sub(var.params, new_params))
-            self._var = None
-            return var
-
-        # ----------------------------- update_difference ---------------------------- #
-        if self._target == 'update_difference':
-            update = var.get_update()
-            u_clone = [u.clone() for u in update]
-            self.keyed_transform_update(u_clone, params, var.grad, var.loss)
-            new_update = tuple(self.keyed_transform_apply(u_clone, params, var.grad, var.loss))
-            var.update = list(torch._foreach_sub(update, new_update))
-            self._var = None
-            return var
-
-        # ---------------------------------- closure --------------------------------- #
-        if self._target == 'closure':
-            original_closure = var.closure
-            if original_closure is None: raise ValueError('Target = "closure", but closure is None')
-
-            params = var.params
-            parent_var = self._var
-            def transformed_closure(backward=True):
-                if backward:
-                    loss = original_closure()
-                    current_grad = [p.grad if p.grad is not None else torch.zeros_like(p) for p in params]
-
-                    self._var = parent_var
-                    self.keyed_transform_update(current_grad, params, var.grad, var.loss)
-                    transformed_grad = list(self.keyed_transform_apply(current_grad, params, var.grad, var.loss))
-                    self._var = None
-
-                    for p, g in zip(params, transformed_grad):
-                        p.grad = g
-
-                else:
-                    loss = original_closure(False)
-
-                return loss
-
-            var.closure = transformed_closure
-            self.post_step(var)
-            self._var = None
-            return var
-
-        # ---------------------------------- invalid --------------------------------- #
-        raise ValueError(f'Invalid target: {self._target}')
-
-
-class TensorwiseTransform(Transform, ABC):
-    """Base class for a parameter-wise transform.
-
-    This is an abstract class, to use it, subclass it and override `update_tensor` and `apply_tensor`.
-
-    Args:
-        defaults (dict[str,Any] | None): dict with default values.
-        uses_grad (bool):
-            Set this to True if `transform` method uses the `grad` argument. This will ensure
-            `grad` is always computed and can't be None. Otherwise set to False.
-        target (Target, optional):
-            what to set on var. Defaults to 'update'.
-    """
-    def __init__(
-        self,
-        defaults: dict[str,Any] | None,
-        uses_grad: bool = False,
-        uses_loss: bool = False,
-        concat_params: bool = False,
-        update_freq: int = 1,
-        inner: Chainable | None = None,
-        target: Target = 'update',
-    ):
-        super().__init__(
-            defaults=defaults,
-            uses_grad=uses_grad,
-            concat_params=concat_params,
-            update_freq=update_freq,
-            uses_loss=uses_loss,
-            inner=inner,
-            target=target,
+        ret = self.multi_tensor_apply(
+            tensors=tensors,
+            params=params,
+            grads=grads,
+            loss=loss,
+            states=states,
+            settings=settings
         )
 
-    def update_tensor(
-        self,
-        tensor: torch.Tensor,
-        param: torch.Tensor,
-        grad: torch.Tensor | None,
-        loss: torch.Tensor | float | None,
-        state: dict[str, Any],
-        setting: Mapping[str, Any],
-    ) -> None:
-        """Updates this transform. By default does nothing - if logic is in `apply` method."""
+        # uncat if needed and set objective.updates and return objective
+        if self._concat_params:
+            objective.updates = vec_to_tensors(ret[0], objective.params)
 
-    @abstractmethod
-    def apply_tensor(
-        self,
-        tensor: torch.Tensor,
-        param: torch.Tensor,
-        grad: torch.Tensor | None,
-        loss: torch.Tensor | float | None,
-        state: dict[str, Any],
-        setting: Mapping[str, Any],
-    ) -> torch.Tensor:
-        """Applies the update rule to `tensor`."""
+        else:
+            objective.updates = list(ret)
 
-    @final
-    def update_tensors(self, tensors, params, grads, loss, states, settings):
-        if grads is None: grads = [None]*len(tensors)
-        for t,p,g,state,setting in zip(tensors, params, grads, states, settings):
-            self.update_tensor(t, p, g, loss, state, setting)
+        return objective
 
-    @final
-    def apply_tensors(self, tensors, params, grads, loss, states, settings):
-        applied = []
-        if grads is None: grads = [None]*len(tensors)
-        for t,p,g,state,setting in zip(tensors, params, grads, states, settings):
-            applied.append(self.apply_tensor(t, p, g, loss, state, setting))
-        return applied
-
-def apply_transform(
-    tfm: Chainable,
-    tensors: list[torch.Tensor],
-    params: list[torch.Tensor],
-    grads: list[torch.Tensor] | None,
-    loss: torch.Tensor | float | None = None,
-    var: Var | None = None,
-    current_step: int = 0,
-):
-    if var is None:
-        var = Var(params=params, closure=None, model=None, current_step=current_step)
-        var.loss = loss
-
-    if isinstance(tfm, Transform) and tfm._target == 'update':
-        if tfm._uses_grad and grads is None: grads = var.get_grad()
-        tfm.keyed_transform_update(tensors, params, grads, loss)
-        return list(tfm.keyed_transform_apply(tensors, params, grads, loss))
-
-    if isinstance(tfm, Chain): tfm = tfm.get_children_sequence() # pyright: ignore[reportAssignmentType]
-    if isinstance(tfm, Sequence):
-        for module in tfm:
-            tensors = apply_transform(module, tensors=tensors, params=params, grads=grads, var=var)
-        return tensors
-
-    if isinstance(tfm, Module):
-        cvar = var.clone(clone_update=False)
-        cvar.update = tensors
-        cvar = tfm.step(cvar)
-        var.update_attrs_from_clone_(cvar)
-        assert cvar.update is not None
-        return cvar.update
-
-    raise TypeError(type(tfm))
+
+    # make sure _concat_params, _uses_grad and _uses_loss are saved in `state_dict`
+    def _extra_pack(self):
+        return {
+            "__concat_params": self._concat_params,
+            "__uses_grad": self._uses_grad,
+            "__uses_loss": self._uses_loss,
+        }
+
+    def _extra_unpack(self, d):
+        self._concat_params = d["__concat_params"]
+        self._uses_grad = d["__uses_grad"]
+        self._uses_loss = d["__uses_loss"]