Skip to content

New DynamicSlidingWindowLayer & associated Cache #40039

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.

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
wants to merge 28 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
369 changes: 218 additions & 151 deletions src/transformers/cache_utils.py

Large diffs are not rendered by default.

18 changes: 14 additions & 4 deletions src/transformers/generation/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -1801,7 +1801,7 @@ def _get_initial_cache_position(self, seq_length, device, model_kwargs):
# Support for BC tuple cache format
if isinstance(cache, tuple):
past_length = cache[0][0].shape[2]
elif hasattr(cache, "get_seq_length") and cache.get_seq_length() is not None:
elif hasattr(cache, "get_seq_length"):
past_length = cache.get_seq_length()

cache_position = cache_position[past_length:]
Expand Down Expand Up @@ -1947,6 +1947,16 @@ def _prepare_cache_for_generation(
generation_config.cache_implementation = generation_config.cache_implementation or getattr(
self.config.get_text_config(decoder=True), "cache_implementation", None
)

# assisted decoding and contrastive search need to roll-back the Cache, which is not supported if
# it has sliding layers - so if we use any of those 2, do not pass the config to DynamicCache, which
# will result in creating a Cache with only full layers even if model uses sliding window
generation_mode = generation_config.get_generation_mode(assistant_model)
dynamic_cache_kwargs = (
{"config": self.config}
if generation_mode not in (GenerationMode.ASSISTED_GENERATION, GenerationMode.CONTRASTIVE_SEARCH)
else {}
)
if generation_config.cache_implementation is not None:
if generation_config.cache_implementation in NEED_SETUP_CACHE_CLASSES_MAPPING:
if generation_config.cache_implementation == "static" and not self._can_compile_fullgraph:
Expand Down Expand Up @@ -1989,15 +1999,15 @@ def _prepare_cache_for_generation(
elif generation_config.cache_implementation == "offloaded":
model_kwargs[cache_name] = OffloadedCache()
elif generation_config.cache_implementation == "dynamic":
model_kwargs[cache_name] = DynamicCache()
model_kwargs[cache_name] = DynamicCache(**dynamic_cache_kwargs)

# Use DynamicCache() instance by default. This will avoid back and forth from legacy format that
# keeps copying the cache thus using much more memory
else:
model_kwargs[cache_name] = (
DynamicCache()
DynamicCache(**dynamic_cache_kwargs)
if not requires_cross_attention_cache
else EncoderDecoderCache(DynamicCache(), DynamicCache())
else EncoderDecoderCache(DynamicCache(**dynamic_cache_kwargs), DynamicCache(**dynamic_cache_kwargs))
)

def _supports_logits_to_keep(self) -> bool:
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/arcee/modeling_arcee.py
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/aria/modeling_aria.py
Original file line number Diff line number Diff line change
Expand Up @@ -744,7 +744,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/bitnet/modeling_bitnet.py
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/cohere/modeling_cohere.py
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/cohere2/modeling_cohere2.py
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ def forward(
inputs_embeds = self.embed_tokens(input_ids)

if use_cache and past_key_values is None and not self.training:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/cohere2/modular_cohere2.py
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ def forward(
inputs_embeds = self.embed_tokens(input_ids)

if use_cache and past_key_values is None and not self.training:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/csm/modeling_csm.py
Original file line number Diff line number Diff line change
Expand Up @@ -702,7 +702,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -556,7 +556,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/diffllama/modeling_diffllama.py
Original file line number Diff line number Diff line change
Expand Up @@ -628,7 +628,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/doge/modeling_doge.py
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@ def forward(
raise ValueError("You must specify exactly one of input_ids or inputs_embeds")

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if inputs_embeds is None:
inputs_embeds = self.embed_tokens(input_ids)
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/dots1/modeling_dots1.py
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@ def forward(
inputs_embeds = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/emu3/modeling_emu3.py
Original file line number Diff line number Diff line change
Expand Up @@ -1186,7 +1186,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/ernie4_5/modeling_ernie4_5.py
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/exaone4/modeling_exaone4.py
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ def forward(
inputs_embeds = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/exaone4/modular_exaone4.py
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ def forward(
inputs_embeds = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
5 changes: 4 additions & 1 deletion src/transformers/models/fsmt/configuration_fsmt.py
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,10 @@ def __init__(
self.activation_function = activation_function

self.decoder = DecoderConfig(
vocab_size=tgt_vocab_size, bos_token_id=eos_token_id, is_encoder_decoder=is_encoder_decoder
vocab_size=tgt_vocab_size,
bos_token_id=eos_token_id,
is_encoder_decoder=is_encoder_decoder,
num_hidden_layers=encoder_layers,
)
if "decoder" in common_kwargs:
del common_kwargs["decoder"]
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/gemma2/modeling_gemma2.py
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@ def forward(
inputs_embeds = self.embed_tokens(input_ids)

if use_cache and past_key_values is None and not self.training:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/gemma2/modular_gemma2.py
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,7 @@ def forward(
inputs_embeds = self.embed_tokens(input_ids)

if use_cache and past_key_values is None and not self.training:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/gemma3/modeling_gemma3.py
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@ def forward(
inputs_embeds = self.embed_tokens(input_ids)

if use_cache and past_key_values is None and not self.training:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/gemma3/modular_gemma3.py
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,7 @@ def forward(
inputs_embeds = self.embed_tokens(input_ids)

if use_cache and past_key_values is None and not self.training:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/glm/modeling_glm.py
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/glm4/modeling_glm4.py
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/glm4_moe/modeling_glm4_moe.py
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/gpt_oss/modeling_gpt_oss.py
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ def forward(
raise ValueError("You must specify exactly one of input_ids or inputs_embeds")

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if inputs_embeds is None:
inputs_embeds = self.embed_tokens(input_ids)
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/gpt_oss/modular_gpt_oss.py
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ def forward(
raise ValueError("You must specify exactly one of input_ids or inputs_embeds")

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if inputs_embeds is None:
inputs_embeds = self.embed_tokens(input_ids)
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/helium/modeling_helium.py
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/llama/modeling_llama.py
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/llama4/modeling_llama4.py
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,7 @@ def forward(
inputs_embeds = self.embed_tokens(input_ids.to(self.embed_tokens.weight.device))

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/mistral/modeling_mistral.py
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ def forward(
inputs_embeds = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/mistral/modular_mistral.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ def forward(
inputs_embeds = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/mixtral/modeling_mixtral.py
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ def forward(
raise ValueError("You must specify exactly one of input_ids or inputs_embeds")

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if inputs_embeds is None:
inputs_embeds = self.embed_tokens(input_ids)
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/mixtral/modular_mixtral.py
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ def forward(
raise ValueError("You must specify exactly one of input_ids or inputs_embeds")

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if inputs_embeds is None:
inputs_embeds = self.embed_tokens(input_ids)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ def forward(

# Handle past_key_values and cache setup
if use_cache and past_key_values is None and not self.training:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -505,7 +505,7 @@ def forward(

# Handle past_key_values and cache setup
if use_cache and past_key_values is None and not self.training:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/olmo/modeling_olmo.py
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/olmo2/modeling_olmo2.py
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ def forward(
inputs_embeds: torch.Tensor = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/models/phi3/modeling_phi3.py
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ def forward(
inputs_embeds = self.embed_tokens(input_ids)

if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if cache_position is None:
past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1664,7 +1664,7 @@ def forward(
if (input_ids is None) ^ (inputs_embeds is not None):
raise ValueError("You must specify exactly one of input_ids or inputs_embeds")
if use_cache and past_key_values is None:
past_key_values = DynamicCache()
past_key_values = DynamicCache(config=self.config)

if inputs_embeds is None:
inputs_embeds = self.embed_tokens(input_ids)
Expand Down
Loading