Skip to content

Fix BatchRotatingKVCache rotated flag deserializing to True #1251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
odysa wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix BatchRotatingKVCache rotated flag deserializing to True #1251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion mlx_lm/models/cache.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1312,7 +1312,7 @@ def meta_state(self, v):
int,
v[:3],
)
self.rotated = bool(v[3])
self.rotated = v[3] == "True"

def is_trimmable(self):
return self._offset < self.max_size
Expand Down
29 changes: 29 additions & 0 deletions tests/test_prompt_cache.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,35 @@ def test_save_load_rotating_cache(self):
self.assertTrue(mx.array_equal(k, lk))
self.assertTrue(mx.array_equal(v, lv))

def test_save_load_batch_rotating_cache(self):
cache_file = os.path.join(self.test_dir, "prompt_cache.safetensors")

# rotated=False round-trip (regression: bool("False") was True)
cache = [BatchRotatingKVCache(max_size=10, left_padding=[0])]
cache[0].update_and_fetch(
mx.random.uniform(shape=(1, 4, 3, 4)),
mx.random.uniform(shape=(1, 4, 3, 4)),
)
self.assertFalse(cache[0].rotated)

save_prompt_cache(cache_file, cache)
loaded = load_prompt_cache(cache_file)
self.assertEqual(cache[0].rotated, loaded[0].rotated)
self.assertEqual(cache[0].max_size, loaded[0].max_size)

# rotated=True round-trip — fill past max_size to trigger rotation
cache = [BatchRotatingKVCache(max_size=4, left_padding=[0])]
for _ in range(6):
cache[0].update_and_fetch(
mx.random.uniform(shape=(1, 4, 1, 4)),
mx.random.uniform(shape=(1, 4, 1, 4)),
)
self.assertTrue(cache[0].rotated)

save_prompt_cache(cache_file, cache)
loaded = load_prompt_cache(cache_file)
self.assertEqual(cache[0].rotated, loaded[0].rotated)

def test_save_load_mixed_cache(self):
cache_file = os.path.join(self.test_dir, "prompt_cache.safetensors")

Expand Down