locoformer 0.0.11__tar.gz → 0.0.30__tar.gz

{locoformer-0.0.11 → locoformer-0.0.30}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: locoformer
-Version: 0.0.11
+Version: 0.0.30
 Summary: LocoFormer
 Project-URL: Homepage, https://pypi.org/project/locoformer/
 Project-URL: Repository, https://github.com/lucidrains/locoformer
@@ -38,6 +38,7 @@ Requires-Dist: assoc-scan
 Requires-Dist: beartype
 Requires-Dist: einops>=0.8.0
 Requires-Dist: einx>=0.3.0
+Requires-Dist: hl-gauss-pytorch>=0.2.0
 Requires-Dist: rotary-embedding-torch
 Requires-Dist: torch>=2.4
 Requires-Dist: x-mlps-pytorch
@@ -54,7 +55,7 @@ Description-Content-Type: text/markdown
 
 [LocoFormer - Generalist Locomotion via Long-Context Adaptation](https://generalist-locomotion.github.io/)
 
-The gist is they trained a simple Transformer-XL in simulation on robots with many different bodies (cross-embodiment) with extreme domain randomization. When transferring to the real-world, they noticed the robot now gains the ability to adapt to insults. The XL memories span across multiple trials, which allowed the robot to learn in-context adaptation.
+The gist is they trained a simple Transformer-XL in simulation on robots with many different bodies (cross-embodiment) and extreme domain randomization. When transferring to the real-world, they noticed the robot now gains the ability to adapt to insults. The XL memories span across multiple trials, which allowed the robot to learn in-context adaptation.
 
 ## Sponsors
 

{locoformer-0.0.11 → locoformer-0.0.30}/README.md

@@ -4,7 +4,7 @@
 
 [LocoFormer - Generalist Locomotion via Long-Context Adaptation](https://generalist-locomotion.github.io/)
 
-The gist is they trained a simple Transformer-XL in simulation on robots with many different bodies (cross-embodiment) with extreme domain randomization. When transferring to the real-world, they noticed the robot now gains the ability to adapt to insults. The XL memories span across multiple trials, which allowed the robot to learn in-context adaptation.
+The gist is they trained a simple Transformer-XL in simulation on robots with many different bodies (cross-embodiment) and extreme domain randomization. When transferring to the real-world, they noticed the robot now gains the ability to adapt to insults. The XL memories span across multiple trials, which allowed the robot to learn in-context adaptation.
 
 ## Sponsors
 

{locoformer-0.0.11 → locoformer-0.0.30}/locoformer/locoformer.py

@@ -1,8 +1,10 @@
 from __future__ import annotations
+from typing import Callable
 from functools import partial
 
 from pathlib import Path
 from contextlib import contextmanager
+from collections import namedtuple
 
 import numpy as np
 from numpy import ndarray
@@ -15,8 +17,9 @@ import torch
 from torch import nn, cat, stack, arange, Tensor, tensor, is_tensor, from_numpy
 import torch.nn.functional as F
 from torch.nn import Module, ModuleList, Linear, RMSNorm, Identity, Sequential
-from torch.utils._pytree import tree_map
+from torch.utils._pytree import tree_map, tree_flatten, tree_unflatten
 from torch.utils.data import Dataset, DataLoader
+from torch.optim import Optimizer
 
 import einx
 from einops import rearrange, einsum
@@ -24,10 +27,16 @@ from einops.layers.torch import Rearrange
 
 from rotary_embedding_torch import RotaryEmbedding
 
+from hl_gauss_pytorch import HLGaussLoss
+
 from assoc_scan import AssocScan
 
+# constants
+
 LinearNoBias = partial(Linear, bias = False)
 
+Cache = namedtuple('Cache', ('curr_timestep', 'kv_cache')) # (int, Tensor)
+
 # helper functions
 
 def exists(v):
@@ -39,15 +48,23 @@ def default(v, d):
 def first(arr):
     return arr[0]
 
+def xnor(x, y):
+    return not (x ^ y)
+
 def divisible_by(num, den):
     return (num % den) == 0
 
+# tensor helpers
+
+def log(t, eps = 1e-20):
+    return t.clamp_min(eps).log()
+
+def is_empty(t):
+    return t.numel() == 0
+
 def tree_map_tensor(x, fn):
     return tree_map(lambda t: t if not is_tensor(t) else fn(t), x)
 
-def detach_all(x):
-    return tree_map_tensor(x, lambda t: t.detach())
-
 def pad_at_dim(
     t,
     pad: tuple[int, int],
@@ -61,13 +78,20 @@ def pad_at_dim(
     zeros = ((0, 0) * dims_from_right)
     return F.pad(t, (*zeros, *pad), value = value)
 
+def normalize(t, eps = 1e-5):
+    return (t - t.mean()) / t.std().clamp_min(eps)
+
+def calc_entropy(logits):
+    prob = logits.softmax(dim = -1)
+    return -(prob * log(prob)).sum(dim = -1)
+
 # generalized advantage estimate
 
 @torch.no_grad()
 def calc_gae(
     rewards,
     values,
-    masks,
+    masks = None,
     gamma = 0.99,
     lam = 0.95,
     use_accelerated = None
@@ -78,6 +102,9 @@ def calc_gae(
     values = F.pad(values, (0, 1), value = 0.)
     values, values_next = values[..., :-1], values[..., 1:]
 
+    if not exists(masks):
+        masks = torch.ones_like(values)
+
     delta = rewards + gamma * values_next * masks - values
     gates = gamma * lam * masks
 
@@ -87,7 +114,7 @@ def calc_gae(
 
     returns = gae + values
 
-    return returns
+    return gae, returns
 
 # transformer-xl mask w/ flex attn
 
@@ -129,8 +156,8 @@ def create_xl_mask(
         # handle intra-episodic attention if needed
 
         if exists(episode_ids):
-            q_episode = episodes[b, q + offset]
-            k_episode = episodes[b, k]
+            q_episode = episode_ids[b, q + offset]
+            k_episode = episode_ids[b, k]
 
             intra_episode_mask = q_episode == k_episode
             mask = mask & intra_episode_mask
@@ -231,12 +258,63 @@ class ReplayDataset(Dataset):
 
         episode_len = self.episode_lens[episode_index]
 
-        data = {field: torch.from_numpy(memmap[episode_index, :episode_len]) for field, memmap in self.memmaps.items()}
+        data = {field: from_numpy(memmap[episode_index, :episode_len].copy()) for field, memmap in self.memmaps.items()}
 
         data['_lens'] = tensor(episode_len)
 
         return data
 
+class RemappedReplayDataset(Dataset):
+    def __init__(
+        self,
+        dataset: ReplayDataset,
+        episode_mapping: Tensor | list[list[int]],
+        shuffle_episodes = False
+    ):
+        assert len(dataset) > 0
+        self.dataset = dataset
+
+        if is_tensor(episode_mapping):
+            assert episode_mapping.dtype in (torch.int, torch.long) and episode_mapping.ndim == 2
+            episode_mapping = episode_mapping.tolist()
+
+        self.episode_mapping = episode_mapping
+        self.shuffle_episodes = shuffle_episodes
+
+    def __len__(self):
+        return len(self.episode_mapping)
+
+    def __getitem__(self, idx):
+
+        episode_indices = self.episode_mapping[idx]
+
+        episode_indices = tensor(episode_indices)
+        episode_indices = episode_indices[(episode_indices >= 0) & (episode_indices < len(self.dataset))]
+
+        assert not is_empty(episode_indices)
+
+        if self.shuffle_episodes and episode_indices.numel() > 1:
+            num_episodes = len(episode_indices)
+            episode_indices = episode_indices[torch.randperm(num_episodes)]
+
+        episode_data = [self.dataset[i] for i in episode_indices.tolist()]
+
+        episode_lens = stack([data.pop('_lens') for data in episode_data])
+
+        keys = first(episode_data).keys()
+
+        values = [list(data.values()) for data in episode_data]
+
+        values = [cat(field_values) for field_values in zip(*values)] # concat across time
+
+        multi_episode_data = dict(zip(keys, values))
+
+        multi_episode_data['_lens'] = episode_lens.sum()
+
+        multi_episode_data['_episode_indices'] = cat([torch.full((episode_len,), episode_index) for episode_len, episode_index in zip(episode_lens, episode_indices)])
+
+        return multi_episode_data
+
 class ReplayBuffer:
 
     @beartype
@@ -299,6 +377,16 @@ class ReplayBuffer:
             self.shapes[field_name] = shape
             self.dtypes[field_name] = dtype
 
+        self.memory_namedtuple = namedtuple('Memory', list(fields.keys()))
+
+    def __len__(self):
+        return (self.episode_lens > 0).sum().item()
+
+    def reset_(self):
+        self.episode_lens[:] = 0
+        self.episode_index = 0
+        self.timestep_index = 0
+
     def advance_episode(self):
         self.episode_index = (self.episode_index + 1) % self.max_episodes
         self.timestep_index = 0
@@ -353,15 +441,93 @@ class ReplayBuffer:
 
         self.timestep_index += 1
 
-    def dataset(self) -> Dataset:
+        return self.memory_namedtuple(**data)
+
+    def dataset(
+        self,
+        episode_mapping: Tensor | list[list[int]] | None = None,
+    ) -> Dataset:
         self.flush()
 
-        return ReplayDataset(self.folder)
+        dataset = ReplayDataset(self.folder)
+
+        if not exists(episode_mapping):
+            return dataset
 
-    def dataloader(self, **kwargs) -> DataLoader:
+        return RemappedReplayDataset(dataset, episode_mapping)
+
+    def dataloader(
+        self,
+        batch_size,
+        episode_mapping: Tensor | list[list[int]] | None = None,
+        **kwargs
+    ) -> DataLoader:
         self.flush()
 
-        return DataLoader(self.dataset(), collate_fn = collate_var_time, **kwargs)
+        return DataLoader(self.dataset(episode_mapping), batch_size = batch_size, collate_fn = collate_var_time, **kwargs)
+
+# normalization + conditioning (needed for the commands to the robot)
+
+class MaybeAdaRMSNormWrapper(Module):
+    def __init__(
+        self,
+        fn: Module,
+        dim,
+        dim_cond = None
+    ):
+        super().__init__()
+        condition = exists(dim_cond)
+
+        self.fn = fn
+        self.norm = nn.RMSNorm(dim, elementwise_affine = not condition)
+
+        self.accept_condition = condition
+
+        if condition:
+            self.to_gamma = LinearNoBias(dim_cond, dim)
+            self.to_ada_norm_zero = nn.Linear(dim_cond, dim)
+
+            nn.init.zeros_(self.to_gamma.weight, 0.)
+            nn.init.zeros_(self.to_ada_norm_zero.weight, 0.)
+            nn.init.constant_(self.to_ada_norm_zero.bias, -5.)
+
+    def forward(
+        self,
+        x,
+        cond = None,
+        **kwargs
+    ):
+
+        need_cond = self.accept_condition
+        assert xnor(exists(cond), need_cond)
+
+        prenormed = self.norm(x)
+
+        if need_cond:
+            if cond.ndim == 2:
+                cond = rearrange(cond, 'b d -> b 1 d')
+
+            scale_in = self.to_gamma(cond)
+            prenormed = prenormed * (scale_in + 1.)
+
+        all_fn_out = self.fn(prenormed, **kwargs)
+
+        if not need_cond:
+            return all_fn_out
+
+        # function may return multiple args
+
+        (out, *rest), tree_spec = tree_flatten(all_fn_out)
+
+        if need_cond:
+            scale_out = self.to_ada_norm_zero(cond).sigmoid()
+            out = out * scale_out
+
+        # restore
+
+        all_fn_out = tree_unflatten((out, *rest), tree_spec)
+
+        return all_fn_out
 
 # transformer-xl with ppo
 
@@ -372,15 +538,12 @@ class Attention(Module):
         window_size,
         dim_head = 64,
         heads = 8,
-        pre_rmsnorm = True,
         fixed_window_size = False,
         accept_value_residual = False
     ):
         super().__init__()
         self.scale = dim_head ** -0.5
 
-        self.norm = RMSNorm(dim) if pre_rmsnorm else Identity()
-
         self.split_heads = Rearrange('b n (h d) -> b h n d', h = heads)
         self.merge_heads = Rearrange('b h n d -> b n (h d)')
 
@@ -421,12 +584,9 @@ class Attention(Module):
         return_kv_cache = False,
     ):
         seq_len = tokens.shape[-2]
-        assert seq_len <= self.window_size
 
         device = tokens.device
 
-        tokens = self.norm(tokens)
-
         q, k, v = (self.to_q(tokens), *self.to_kv(tokens).chunk(2, dim = -1))
 
         q, k, v = map(self.split_heads, (q, k, v))
@@ -515,19 +675,24 @@ class TransformerXL(Module):
         dim_head = 64,
         heads = 8,
         expansion_factor = 4.,
+        dim_cond = None,
         final_norm = True,
         fixed_window_size = False,
     ):
         super().__init__()
 
+        condition = exists(dim_cond)
+
+        norm_fn = partial(MaybeAdaRMSNormWrapper, dim = dim, dim_cond = dim_cond)
+
         layers = ModuleList([])
 
         for i in range(depth):
             is_first = i == 0
 
-            attn = Attention(dim = dim, dim_head = dim_head, heads = heads, fixed_window_size = fixed_window_size, window_size = window_size, accept_value_residual = not is_first)
+            attn = norm_fn(Attention(dim = dim, dim_head = dim_head, heads = heads, fixed_window_size = fixed_window_size, window_size = window_size, accept_value_residual = not is_first))
 
-            ff = FeedForward(dim = dim, expansion_factor = expansion_factor)
+            ff = norm_fn(FeedForward(dim = dim, expansion_factor = expansion_factor))
 
             layers.append(ModuleList([
                 attn, ff
@@ -582,7 +747,21 @@ class Locoformer(Module):
         embedder: Module,
         unembedder: Module,
         transformer: dict | TransformerXL,
-        value_network: Module | None = None
+        discount_factor = 0.999,
+        gae_lam = 0.95,
+        ppo_eps_clip = 0.2,
+        ppo_entropy_weight = 0.01,
+        ppo_value_clip = 0.4,
+        dim_value_input = None, # needs to be set for value network to be available
+        value_network: Module = nn.Identity(),
+        reward_range: tuple[float, float] | None = None,
+        reward_shaping_fns: list[Callable[[Tensor], float | Tensor]] | None = None,
+        num_reward_bins = 32,
+        hl_gauss_loss_kwargs = dict(),
+        value_loss_weight = 0.5,
+        calc_gae_kwargs: dict = dict(),
+        recurrent_kv_cache = True,
+        use_spo = False # simple policy optimization https://arxiv.org/abs/2401.16025 - Levine's group (PI) verified it is more stable than PPO
     ):
         super().__init__()
 
@@ -594,11 +773,58 @@ class Locoformer(Module):
         self.embedder = embedder
         self.unembedder = unembedder
 
-        self.value_network = value_network
-
         self.fixed_window_size = transformer.fixed_window_size
         self.window_size = transformer.window_size
 
+        # determine value network, using HL Gauss Layer
+
+        self.to_value_pred = None
+
+        if exists(dim_value_input):
+            assert exists(reward_range)
+
+            self.to_value_pred = nn.Sequential(
+                value_network,
+                LinearNoBias(dim_value_input, num_reward_bins)
+            )
+
+            reward_min, reward_max = reward_range
+
+            self.hl_gauss_loss = HLGaussLoss(
+                min_value = reward_min,
+                max_value = reward_max,
+                num_bins = num_reward_bins,
+                **hl_gauss_loss_kwargs
+            )
+
+        # ppo related
+
+        self.discount_factor = discount_factor
+        self.gae_lam = gae_lam
+        self.ppo_eps_clip = ppo_eps_clip
+        self.ppo_entropy_weight = ppo_entropy_weight
+        self.ppo_value_clip = ppo_value_clip
+        self.value_loss_weight = value_loss_weight
+
+        self.calc_gae_kwargs = calc_gae_kwargs
+
+        # maybe use spo
+
+        self.use_spo = use_spo
+
+        # maybe recurrent kv cache, from Ding et al. https://arxiv.org/abs/2012.15688
+
+        self.recurrent_kv_cache = recurrent_kv_cache
+
+        # reward shaping function
+
+        self.has_reward_shaping = exists(reward_shaping_fns)
+        self.reward_shaping_fns = reward_shaping_fns
+
+        # loss related
+
+        self.register_buffer('zero', tensor(0.), persistent = False)
+
     @property
     def device(self):
         return next(self.parameters()).device
@@ -607,33 +833,163 @@ class Locoformer(Module):
         return self.unembedder.parameters()
 
     def critic_parameters(self):
-        if not exists(self.value_network):
+        if not exists(self.to_value_pred):
             return []
 
-        return self.value_network.parameters()
+        return self.to_value_pred.parameters()
+
+    def ppo(
+        self,
+        state,
+        action,
+        old_action_log_prob,
+        reward,
+        old_value,
+        mask,
+        episode_lens,
+        actor_optim: Optimizer | None = None,
+        critic_optim: Optimizer | None = None
+    ):
+        window_size = self.window_size
+        total_learnable_tokens = mask.sum().item()
+
+        seq_len = state.shape[1]
+        gae_mask = einx.less('j, i -> i j', arange(seq_len, device = self.device), episode_lens)
+
+        advantage, returns = calc_gae(reward, old_value, masks = gae_mask, lam = self.gae_lam, gamma = self.discount_factor, **self.calc_gae_kwargs)
+
+        advantage = normalize(advantage)
+
+        windowed_tensors = [
+            t.split(window_size, dim = 1) for t in
+            (
+                state,
+                action,
+                old_action_log_prob,
+                reward,
+                old_value,
+                mask,
+                advantage,
+                returns
+            )
+        ]
+
+        mean_actor_loss = self.zero.clone()
+        mean_critic_loss = self.zero.clone()
+
+        # learn across windows
+
+        cache = None
+
+        for (
+            state,
+            action,
+            old_action_log_prob,
+            reward,
+            old_value,
+            mask,
+            advantage,
+            returns
+        ) in zip(*windowed_tensors):
+
+            (action_logits, value_logits), cache = self.forward(state, cache = cache, detach_cache = True, return_values = True, return_raw_value_logits = True)
+            entropy = calc_entropy(action_logits)
+
+            action = rearrange(action, 'b t -> b t 1')
+            log_prob = action_logits.gather(-1, action)
+            log_prob = rearrange(log_prob, 'b t 1 -> b t')
+
+            # update actor, classic clipped surrogate loss
+
+            eps_clip = self.ppo_eps_clip
+            ratio = (log_prob - old_action_log_prob).exp()
+
+            if self.use_spo:
+                actor_loss = -(ratio * advantage - (advantage.abs() * (ratio - 1.).square()) / (2 * eps_clip))
+            else:
+                actor_loss = -torch.min(ratio * advantage, ratio.clamp(1. - eps_clip, 1. + eps_clip) * advantage)
+
+            actor_loss = actor_loss - self.ppo_entropy_weight * entropy
+
+            windowed_actor_loss = actor_loss[mask].sum() / total_learnable_tokens
+            windowed_actor_loss.backward(retain_graph = True)
+
+            # update critic
+
+            value_loss = self.hl_gauss_loss(value_logits, returns, reduction = 'none')
+
+            value_clip = self.ppo_value_clip
+            value = self.hl_gauss_loss(value_logits)
+
+            clipped_value = old_value + (value - old_value).clamp(-value_clip, value_clip)
+            clipped_value_loss = self.hl_gauss_loss(clipped_value, returns, reduction = 'none')
+
+            critic_loss = torch.maximum(value_loss, clipped_value_loss) * self.value_loss_weight
+
+            windowed_critic_loss = critic_loss[mask].sum() / total_learnable_tokens
+            windowed_critic_loss.backward(retain_graph = True)
+
+            # accumulate
+
+            mean_actor_loss.add_(windowed_actor_loss)
+            mean_critic_loss.add_(windowed_critic_loss)
+
+        # optimizer update
+
+        if exists(actor_optim):
+            actor_optim.step()
+            actor_optim.zero_grad()
+
+        if exists(critic_optim):
+            critic_optim.step()
+            critic_optim.zero_grad()
+
+        # return losses for logging
+
+        return mean_actor_loss.detach(), mean_critic_loss.detach()
+
+    def state_to_rewards(
+        self,
+        state
+    ) -> Tensor:
+
+        assert self.has_reward_shaping
+
+        rewards = [fn(state) for fn in self.reward_shaping_fns]
+
+        rewards = [tensor(reward) if not is_tensor(reward) else reward for reward in rewards]
+        return stack(rewards)
 
     def wrap_env_functions(self, env):
 
-        def wrapped_reset(*args, **kwargs):
-            state, _ =  env.reset(*args, **kwargs)
+        def transform_output(el):
+            if isinstance(el, ndarray):
+                return from_numpy(el)
+            elif isinstance(el, (int, bool, float)):
+                return tensor(el)
+            else:
+                return el
 
-            if isinstance(state, ndarray):
-                state = from_numpy(state)
+        def wrapped_reset(*args, **kwargs):
+            env_reset_out =  env.reset(*args, **kwargs)
 
-            return state, _
+            return tree_map(transform_output, env_reset_out)
 
         def wrapped_step(action, *args, **kwargs):
-            out = env.step(action.item(), *args, **kwargs)
 
-            def transform_output(el):
-                if isinstance(el, ndarray):
-                    return from_numpy(el)
-                elif isinstance(el, (int, bool, float)):
-                    return tensor(el)
-                else:
-                    return el
+            if is_tensor(action):
+                action = action.item()
+
+            env_step_out = env.step(action, *args, **kwargs)
+
+            env_step_out_torch = tree_map(transform_output, env_step_out)
 
-            return tree_map(transform_output, out)
+            if not self.has_reward_shaping:
+                return env_step_out_torch
+
+            shaped_rewards = self.state_to_rewards(env_step_out_torch)
+
+            return env_step_out_torch, shaped_rewards
 
         return wrapped_reset, wrapped_step
 
@@ -643,6 +999,7 @@ class Locoformer(Module):
         inference_mode = False,
         has_batch_dim = False,
         has_time_dim = False,
+        state_time_dim = 1,
         **kwargs
     ):
         window_size = self.window_size
@@ -658,23 +1015,16 @@ class Locoformer(Module):
                 state = rearrange(state, '... -> 1 ...')
 
             if not has_time_dim:
-                state = rearrange(state, '... d -> ... 1 d')
+                state = state.unsqueeze(state_time_dim)
 
             # forwards
 
             out, cache = self.forward(state, cache = cache, **{**kwargs, **override_kwargs})
 
-            # handle cache
-
-            cache_len = cache.shape[-2]
-
-            if self.fixed_window_size or divisible_by(cache_len, window_size * 2):
-                cache = cache[..., -window_size:, :]
-
             # maybe remove batch or time
 
             if not has_time_dim:
-                out = tree_map_tensor(out, lambda t: rearrange(t, '... 1 d -> ... d'))
+                out = tree_map_tensor(out, lambda t: t.squeeze(state_time_dim))
 
             if not has_batch_dim:
                 out = tree_map_tensor(out, lambda t: rearrange(t, '1 ... -> ...'))
@@ -703,16 +1053,35 @@ class Locoformer(Module):
     def forward(
         self,
         state: Tensor,
-        cache: Tensor | None = None,
+        cache: Cache | None = None,
         detach_cache = False,
-        return_values = False
+        return_values = False,
+        return_raw_value_logits = False
     ):
 
         state = state.to(self.device)
 
         tokens = self.embedder(state)
 
-        embed, kv_cache = self.transformer(tokens, cache = cache, return_kv_cache = True)
+        # time
+
+        time = tokens.shape[-2]
+
+        # destruct the cache for the current timestep and the cache
+
+        prev_kv_cache = None
+        timestep_start = 0
+
+        if exists(cache):
+            timestep_start, prev_kv_cache = cache
+
+        # an assert - make sure during training or inference, forward never gets anything that crosses the window segment boundary, to open up some possibilities with extending memory
+
+        assert ((timestep_start % self.window_size) + time) <= self.window_size
+
+        # attention
+
+        embed, kv_cache = self.transformer(tokens, cache = prev_kv_cache, return_kv_cache = True)
 
         # unembed to actions - in language models this would be the next state
 
@@ -723,21 +1092,34 @@ class Locoformer(Module):
         # maybe detach cache
 
         if detach_cache:
-            kv_cache = detach_all(kv_cache)
+            kv_cache = kv_cache.detach()
 
         # handle returning of values
 
         if return_values:
-            assert exists(self.value_network)
+            assert exists(self.to_value_pred)
 
-            values = self.value_network(embed)
+            values = self.to_value_pred(embed)
 
-            if values.ndim == 3:
-                assert values.shape[-1] == 1
-                values = rearrange(values, '... 1 -> ...')
+            if not return_raw_value_logits:
+                values = self.hl_gauss_loss(values) # converts the value logits to scalar values
 
             out = (out, values)
 
         # output and cache
 
-        return out, kv_cache
+        next_timestep = time + timestep_start
+
+        # handle curtailing kv cache at the right intervals
+
+        window_size = self.window_size
+
+        if self.fixed_window_size or divisible_by(next_timestep, window_size * 2):
+            kv_cache = kv_cache[..., -window_size:, :]
+
+        # maybe recurrent cache - shift the kv cache from one layer above to the one below, for extending on receptive field of past
+
+        if self.recurrent_kv_cache and divisible_by(next_timestep, window_size):
+            kv_cache = torch.roll(kv_cache, shifts = -1, dims = 0)
+
+        return out, (next_timestep, kv_cache)

{locoformer-0.0.11 → locoformer-0.0.30}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "locoformer"
-version = "0.0.11"
+version = "0.0.30"
 description = "LocoFormer"
 authors = [
     { name = "Phil Wang", email = "lucidrains@gmail.com" }
@@ -30,6 +30,7 @@ dependencies = [
     "beartype",
     "einx>=0.3.0",
     "einops>=0.8.0",
+    "hl-gauss-pytorch>=0.2.0",
     "rotary-embedding-torch",
     "torch>=2.4",
     "x-mlps-pytorch",

{locoformer-0.0.11 → locoformer-0.0.30}/tests/test_locoformer.py

@@ -2,18 +2,25 @@ import pytest
 param = pytest.mark.parametrize
 
 import torch
+from torch import nn
 from x_mlps_pytorch import MLP
 
 from einops import rearrange
 
-def test_locoformer():
-    from locoformer.locoformer import Locoformer
-    from torch import nn
+from locoformer.locoformer import Locoformer
+
+@param('recurrent_kv_cache', (False, True))
+def test_locoformer(
+    recurrent_kv_cache
+):
     
     model = Locoformer(
         embedder = nn.Embedding(256, 128),
         unembedder = nn.Linear(128, 256, bias = False),
-        value_network = MLP(128, 32, 1),
+        value_network = MLP(128, 64, 32),
+        dim_value_input = 32,
+        reward_range = (-100., 100.),
+        recurrent_kv_cache = recurrent_kv_cache,
         transformer = dict(
             dim = 128,
             depth = 1,
@@ -83,4 +90,58 @@ def test_replay():
 
     dataloader = replay_buffer.dataloader(batch_size = 3)
 
-    assert next(iter(dataloader))['state'].shape[0] == 3
+    assert next(iter(dataloader))['state'].shape[0] == 3
+
+    # we will now consider consecutive pairs of episodes as 2 trials to be used for in-context adaptation
+    # but realistically there will be a function that converts a given ReplayBuffer -> Int[batch, episode_indices]
+
+    from torch import stack, arange
+
+    episode_indices = arange(len(replay_buffer))
+    remapped_episodes = stack((episode_indices[:-1], episode_indices[1:]))
+
+    dataloader = replay_buffer.dataloader(
+        batch_size = 1,
+        episode_mapping = remapped_episodes
+    )
+
+    assert next(iter(dataloader))['_lens'][0] == (3 + 5) # first and second episodes are concatted together timewise
+
+def test_reward_shaping():
+
+    model = Locoformer(
+        embedder = nn.Embedding(256, 128),
+        unembedder = nn.Linear(128, 256, bias = False),
+        value_network = MLP(128, 64, 32),
+        dim_value_input = 32,
+        reward_range = (-100., 100.),
+        reward_shaping_fns = [
+            lambda state: (state[3] - 2.5).pow(2).mean(),
+            lambda state: state[4:6].norm(dim = -1)
+        ],
+        transformer = dict(
+            dim = 128,
+            depth = 1,
+            window_size = 512
+        )
+    )
+
+    import numpy as np
+
+    class MockEnv:
+        def reset(self):
+            return np.random.normal(size = (10,))
+
+        def step(self, *args, **kwargs):
+            return np.random.normal(size = (10,))
+
+
+    env = MockEnv()
+
+    reset_fn, step_fn = model.wrap_env_functions(env)
+
+    reset_fn()
+
+    _, rewards = step_fn(3)
+
+    assert len(rewards) == 2

{locoformer-0.0.11 → locoformer-0.0.30}/train.py

@@ -160,7 +160,7 @@ for i in range(NUM_BATCHES):
         optim.step()
         optim.zero_grad()
 
-    if divisible_by(i + 1, GENERATE_EVERY):
+    if divisible_by(i, GENERATE_EVERY):
         model.eval()
 
         val_seq = next(val_loader_iter)
@@ -169,7 +169,7 @@ for i in range(NUM_BATCHES):
         prime = prime.to(model.device)
         out = prime
 
-        stateful_forward, logits = model.get_stateful_forward(has_batch_dim = False, initial_states = prime, inference_mode = True)
+        stateful_forward, logits = model.get_stateful_forward(has_batch_dim = False, has_time_dim = True, initial_states = prime, inference_mode = True)
 
         # sample
 

{locoformer-0.0.11 → locoformer-0.0.30}/train_gym.py

@@ -3,7 +3,7 @@
 #     "accelerate",
 #     "fire",
 #     "gymnasium[box2d]>=1.0.0",
-#     "locoformer",
+#     "locoformer>=0.0.12",
 #     "moviepy",
 #     "tqdm"
 # ]
@@ -13,13 +13,14 @@ from fire import Fire
 from shutil import rmtree
 from tqdm import tqdm
 from collections import deque
+from types import SimpleNamespace
 
 from accelerate import Accelerator
 
 import gymnasium as gym
 
 import torch
-from torch import from_numpy, randint, tensor, stack
+from torch import from_numpy, randint, tensor, stack, arange
 import torch.nn.functional as F
 from torch.utils.data import TensorDataset, DataLoader
 from torch.optim import Adam
@@ -47,26 +48,64 @@ def gumbel_sample(logits, temperature = 1., eps = 1e-6):
     noise = gumbel_noise(logits)
     return ((logits / max(temperature, eps)) + noise).argmax(dim = -1)
 
+# learn
+
+def learn(
+    model,
+    actor_optim,
+    critic_optim,
+    accelerator,
+    replay,
+    batch_size = 16,
+    epochs = 2,
+):
+    dl = replay.dataloader(batch_size = batch_size, shuffle = True)
+    model, dl, actor_optim, critic_optim = accelerator.prepare(model, dl, actor_optim, critic_optim)
+
+    for _ in range(epochs):
+        for data in dl:
+
+            data = SimpleNamespace(**data)
+
+            actor_loss, critic_loss = model.ppo(
+                state = data.state,
+                action = data.action,
+                old_action_log_prob = data.action_log_prob,
+                reward = data.reward,
+                old_value = data.value,
+                mask = data.learnable,
+                episode_lens = data._lens,
+                actor_optim = actor_optim,
+                critic_optim = critic_optim
+            )
+
+            accelerator.print(f'actor: {actor_loss.item():.3f} | critic: {critic_loss.item():.3f}')
+
 # main function
 
 def main(
     env_name = 'LunarLander-v3',
     num_episodes = 50_000,
     max_timesteps = 500,
-    num_timestep_before_learn = 5000,
+    num_episodes_before_learn = 64,
     clear_video = True,
     video_folder = 'recordings',
     record_every_episode = 250,
+    learning_rate = 8e-4,
     discount_factor = 0.99,
-    learning_rate = 1e-4,
+    betas = (0.9, 0.99),
+    gae_lam = 0.95,
+    ppo_eps_clip = 0.2,
+    ppo_entropy_weight = .01,
     batch_size = 16,
-    epochs = 2
+    epochs = 3,
+    reward_range = (-100., 100.)
 ):
 
     # accelerate
 
-    accelerate = Accelerator()
-    device = accelerate.device
+    accelerator = Accelerator()
+    device = accelerator.device
 
     # environment
 
@@ -91,14 +130,15 @@ def main(
     replay = ReplayBuffer(
         'replay',
         num_episodes,
-        max_timesteps,
+        max_timesteps + 1, # one extra node for bootstrap node - not relevant for locoformer, but for completeness
         fields = dict(
             state = ('float', (dim_state,)),
             action = 'int',
             action_log_prob = 'float',
             reward = 'float',
             value = 'float',
-            done = 'bool'
+            done = 'bool',
+            learnable = 'bool'
         )
     )
 
@@ -107,20 +147,30 @@ def main(
     locoformer = Locoformer(
         embedder = MLP(dim_state, 64, bias = False),
         unembedder = MLP(64, num_actions, bias = False),
-        value_network = MLP(64, 1, bias = False),
         transformer = dict(
             dim = 64,
             dim_head = 32,
             heads = 4,
             depth = 4,
             window_size = 16
-        )
+        ),
+        discount_factor = discount_factor,
+        gae_lam = gae_lam,
+        ppo_eps_clip = ppo_eps_clip,
+        ppo_entropy_weight = ppo_entropy_weight,
+        use_spo = True,
+        value_network = MLP(64, 64),
+        dim_value_input = 64,
+        reward_range = reward_range,
+        hl_gauss_loss_kwargs = dict(),
+        recurrent_kv_cache = True,
+        calc_gae_kwargs = dict(
+            use_accelerated = False
+        ),
     ).to(device)
 
-    optim_actor = Adam([*locoformer.transformer.parameters(), *locoformer.actor_parameters()], lr = learning_rate)
-    optim_critic = Adam([*locoformer.transformer.parameters(), *locoformer.critic_parameters()], lr = learning_rate)
-
-    timesteps_learn = 0
+    optim_actor = Adam([*locoformer.transformer.parameters(), *locoformer.actor_parameters()], lr = learning_rate, betas = betas)
+    optim_critic = Adam([*locoformer.transformer.parameters(), *locoformer.critic_parameters()], lr = learning_rate, betas = betas)
 
     # able to wrap the env for all values to torch tensors and back
     # all environments should follow usual MDP interface, domain randomization should be given at instantiation
@@ -129,7 +179,8 @@ def main(
 
     # loop
 
-    for _ in tqdm(range(num_episodes)):
+    for episodes_index in tqdm(range(num_episodes)):
+
         state, *_ = env_reset()
 
         timestep = 0
@@ -151,42 +202,59 @@ def main(
 
                 # append to memory
 
-                done = truncated or terminated
+                exceeds_max_timesteps = timestep == (max_timesteps - 1)
+                done = truncated or terminated or tensor(exceeds_max_timesteps)
 
                 # get log prob of action
 
                 action_log_prob = action_logits.gather(-1, rearrange(action, '-> 1'))
                 action_log_prob = rearrange(action_log_prob, '1 ->')
 
-                replay.store(
+                memory = replay.store(
                     state = state,
                     action = action,
                     action_log_prob = action_log_prob,
                     reward = reward,
                     value = value,
-                    done = done
+                    done = done,
+                    learnable = tensor(True)
                 )
 
                 # increment counters
 
                 timestep += 1
-                timesteps_learn += 1
 
-                # learn if hit the number of learn timesteps
+                # break if done or exceed max timestep
 
-                if timesteps_learn >= num_timestep_before_learn:
-                    # todo - carry out learning
+                if done:
 
-                    timesteps_learn = 0
-                    memories.clear()
+                    # handle bootstrap value, which is a non-learnable timestep added with the next value for GAE
+                    # only if terminated signal not detected
 
-                # break if done or exceed max timestep
+                    if not terminated:
+                        _, next_value = stateful_forward(next_state, return_values = True)
+
+                        memory._replace(value = next_value, learnable = False)
+
+                        replay.store(**memory._asdict())
 
-                if done or timestep >= max_timesteps:
                     break
 
                 state = next_state
 
+            # learn if hit the number of learn timesteps
+
+            if divisible_by(episodes_index + 1, num_episodes_before_learn):
+
+                learn(
+                    locoformer,
+                    optim_actor,
+                    optim_critic,
+                    accelerator,
+                    replay,
+                    batch_size,
+                    epochs,
+                )
 # main
 
 if __name__ == '__main__':