Skip to content
Merged
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
34 changes: 17 additions & 17 deletions src/transformers/modeling_rope_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,23 +61,23 @@ def longrope_frequency_update(self, position_ids, device, layer_type=None):
"original_max_position_embeddings"
]

if seq_len > original_max_position_embeddings:
if not hasattr(self, f"{layer_type}_long_inv_freq"):
rope_init_fn = ROPE_INIT_FUNCTIONS[rope_type]
long_inv_freq, _ = rope_init_fn(
self.config,
device,
seq_len=original_max_position_embeddings + 1,
layer_type=layer_type,
)
self.register_buffer(f"{prefix}inv_freq", long_inv_freq, persistent=False)
setattr(self, f"{prefix}long_inv_freq", long_inv_freq)
else:
# This .to() is needed if the model has been moved to a device after being initialized (because
# the buffer is automatically moved, but not the original copy)
original_inv_freq = original_inv_freq.to(device)
self.register_buffer(f"{prefix}inv_freq", original_inv_freq, persistent=False)
setattr(self, f"{prefix}original_inv_freq", original_inv_freq)
long_inv_freq = getattr(self, f"{prefix}long_inv_freq", None)
if long_inv_freq is None:
rope_init_fn = ROPE_INIT_FUNCTIONS[rope_type]
long_inv_freq, _ = rope_init_fn(
self.config,
device,
seq_len=original_max_position_embeddings + 1,
layer_type=layer_type,
)
# `long_inv_freq` is a plain attribute and does not follow `model.to(...)`, so move it here
long_inv_freq = long_inv_freq.to(device)
original_inv_freq = original_inv_freq.to(device)
setattr(self, f"{prefix}long_inv_freq", long_inv_freq)

# `seq_len` is a scalar, so this picks the long or short set for all positions, like an if/else but traceable
inv_freq = torch.where(seq_len > original_max_position_embeddings, long_inv_freq, original_inv_freq)
self.register_buffer(f"{prefix}inv_freq", inv_freq, persistent=False)

def dynamic_frequency_update(self, position_ids, device, layer_type=None):
"""
Comment on lines 82 to 83

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you want to try and make dynamic rope compilable? 😄

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to look at it, but I'd rather do it in a separate PR. Dynamic rope keeps state: it grows the cached length and resets it when the input gets short again. So it needs more care than longrope, and I'd like to keep this PR small since it touches core RoPE code. We can discuss the approach there.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait, it might be possible with little changes. Let me try, I will give you feedback once I figured it out.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 0ed7ffb

Expand Down
3 changes: 1 addition & 2 deletions src/transformers/models/axk1/modeling_axk1.py
Original file line number Diff line number Diff line change
Expand Up @@ -285,9 +285,8 @@ def yarn_get_mscale(scale=1, mscale=1):
def yarn_apply_mscale(rope_parameters, scaling):
if rope_parameters.get("rope_type", "default") != "default":
mscale_all_dim = rope_parameters.get("mscale_all_dim", 0)
scaling_factor = rope_parameters["factor"]
if mscale_all_dim:
mscale = yarn_get_mscale(scaling_factor, mscale_all_dim)
mscale = yarn_get_mscale(rope_parameters["factor"], mscale_all_dim)
scaling = scaling * mscale * mscale
return scaling

Expand Down
3 changes: 1 addition & 2 deletions src/transformers/models/axk2/modeling_axk2.py
Original file line number Diff line number Diff line change
Expand Up @@ -454,9 +454,8 @@ def yarn_get_mscale(scale=1, mscale=1):
def yarn_apply_mscale(rope_parameters, scaling):
if rope_parameters.get("rope_type", "default") != "default":
mscale_all_dim = rope_parameters.get("mscale_all_dim", 0)
scaling_factor = rope_parameters["factor"]
if mscale_all_dim:
mscale = yarn_get_mscale(scaling_factor, mscale_all_dim)
mscale = yarn_get_mscale(rope_parameters["factor"], mscale_all_dim)
scaling = scaling * mscale * mscale
return scaling

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -244,9 +244,8 @@ def yarn_get_mscale(scale=1, mscale=1):
def yarn_apply_mscale(rope_parameters, scaling):
if rope_parameters.get("rope_type", "default") != "default":
mscale_all_dim = rope_parameters.get("mscale_all_dim", 0)
scaling_factor = rope_parameters["factor"]
if mscale_all_dim:
mscale = yarn_get_mscale(scaling_factor, mscale_all_dim)
mscale = yarn_get_mscale(rope_parameters["factor"], mscale_all_dim)
scaling = scaling * mscale * mscale
return scaling

Expand Down
3 changes: 1 addition & 2 deletions src/transformers/models/deepseek_v2/modeling_deepseek_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -281,9 +281,8 @@ def yarn_get_mscale(scale=1, mscale=1):
def yarn_apply_mscale(rope_parameters, scaling):
if rope_parameters.get("rope_type", "default") != "default":
mscale_all_dim = rope_parameters.get("mscale_all_dim", 0)
scaling_factor = rope_parameters["factor"]
if mscale_all_dim:
mscale = yarn_get_mscale(scaling_factor, mscale_all_dim)
mscale = yarn_get_mscale(rope_parameters["factor"], mscale_all_dim)
scaling = scaling * mscale * mscale
return scaling

Expand Down
3 changes: 1 addition & 2 deletions src/transformers/models/deepseek_v2/modular_deepseek_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -242,9 +242,8 @@ def yarn_get_mscale(scale=1, mscale=1):
def yarn_apply_mscale(rope_parameters, scaling):
if rope_parameters.get("rope_type", "default") != "default":
mscale_all_dim = rope_parameters.get("mscale_all_dim", 0)
scaling_factor = rope_parameters["factor"]
if mscale_all_dim:
mscale = yarn_get_mscale(scaling_factor, mscale_all_dim)
mscale = yarn_get_mscale(rope_parameters["factor"], mscale_all_dim)
scaling = scaling * mscale * mscale
return scaling

Expand Down
3 changes: 1 addition & 2 deletions src/transformers/models/deepseek_v3/modeling_deepseek_v3.py
Original file line number Diff line number Diff line change
Expand Up @@ -268,9 +268,8 @@ def yarn_get_mscale(scale=1, mscale=1):
def yarn_apply_mscale(rope_parameters, scaling):
if rope_parameters.get("rope_type", "default") != "default":
mscale_all_dim = rope_parameters.get("mscale_all_dim", 0)
scaling_factor = rope_parameters["factor"]
if mscale_all_dim:
mscale = yarn_get_mscale(scaling_factor, mscale_all_dim)
mscale = yarn_get_mscale(rope_parameters["factor"], mscale_all_dim)
scaling = scaling * mscale * mscale
return scaling

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -287,9 +287,8 @@ def yarn_get_mscale(scale=1, mscale=1):
def yarn_apply_mscale(rope_parameters, scaling):
if rope_parameters.get("rope_type", "default") != "default":
mscale_all_dim = rope_parameters.get("mscale_all_dim", 0)
scaling_factor = rope_parameters["factor"]
if mscale_all_dim:
mscale = yarn_get_mscale(scaling_factor, mscale_all_dim)
mscale = yarn_get_mscale(rope_parameters["factor"], mscale_all_dim)
scaling = scaling * mscale * mscale
return scaling

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,8 @@ def yarn_get_mscale(scale=1, mscale=1):
def yarn_apply_mscale(rope_parameters, scaling):
if rope_parameters.get("rope_type", "default") != "default":
mscale_all_dim = rope_parameters.get("mscale_all_dim", 0)
scaling_factor = rope_parameters["factor"]
if mscale_all_dim:
mscale = yarn_get_mscale(scaling_factor, mscale_all_dim)
mscale = yarn_get_mscale(rope_parameters["factor"], mscale_all_dim)
scaling = scaling * mscale * mscale
return scaling

Expand Down
3 changes: 1 addition & 2 deletions src/transformers/models/glm_moe_dsa/modeling_glm_moe_dsa.py
Original file line number Diff line number Diff line change
Expand Up @@ -288,9 +288,8 @@ def yarn_get_mscale(scale=1, mscale=1):
def yarn_apply_mscale(rope_parameters, scaling):
if rope_parameters.get("rope_type", "default") != "default":
mscale_all_dim = rope_parameters.get("mscale_all_dim", 0)
scaling_factor = rope_parameters["factor"]
if mscale_all_dim:
mscale = yarn_get_mscale(scaling_factor, mscale_all_dim)
mscale = yarn_get_mscale(rope_parameters["factor"], mscale_all_dim)
scaling = scaling * mscale * mscale
return scaling

Expand Down
3 changes: 1 addition & 2 deletions src/transformers/models/hy_v4/modeling_hy_v4.py
Original file line number Diff line number Diff line change
Expand Up @@ -310,9 +310,8 @@ def yarn_get_mscale(scale=1, mscale=1):
def yarn_apply_mscale(rope_parameters, scaling):
if rope_parameters.get("rope_type", "default") != "default":
mscale_all_dim = rope_parameters.get("mscale_all_dim", 0)
scaling_factor = rope_parameters["factor"]
if mscale_all_dim:
mscale = yarn_get_mscale(scaling_factor, mscale_all_dim)
mscale = yarn_get_mscale(rope_parameters["factor"], mscale_all_dim)
scaling = scaling * mscale * mscale
return scaling

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -272,9 +272,8 @@ def yarn_get_mscale(scale=1, mscale=1):
def yarn_apply_mscale(rope_parameters, scaling):
if rope_parameters.get("rope_type", "default") != "default":
mscale_all_dim = rope_parameters.get("mscale_all_dim", 0)
scaling_factor = rope_parameters["factor"]
if mscale_all_dim:
mscale = yarn_get_mscale(scaling_factor, mscale_all_dim)
mscale = yarn_get_mscale(rope_parameters["factor"], mscale_all_dim)
scaling = scaling * mscale * mscale
return scaling

Expand Down
3 changes: 1 addition & 2 deletions src/transformers/models/minicpm3/modeling_minicpm3.py
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,8 @@ def yarn_get_mscale(scale=1, mscale=1):
def yarn_apply_mscale(rope_parameters, scaling):
if rope_parameters.get("rope_type", "default") != "default":
mscale_all_dim = rope_parameters.get("mscale_all_dim", 0)
scaling_factor = rope_parameters["factor"]
if mscale_all_dim:
mscale = yarn_get_mscale(scaling_factor, mscale_all_dim)
mscale = yarn_get_mscale(rope_parameters["factor"], mscale_all_dim)
scaling = scaling * mscale * mscale
return scaling

Expand Down
3 changes: 1 addition & 2 deletions src/transformers/models/mistral4/modeling_mistral4.py
Original file line number Diff line number Diff line change
Expand Up @@ -277,9 +277,8 @@ def yarn_get_mscale(scale=1, mscale=1):
def yarn_apply_mscale(rope_parameters, scaling):
if rope_parameters.get("rope_type", "default") != "default":
mscale_all_dim = rope_parameters.get("mscale_all_dim", 0)
scaling_factor = rope_parameters["factor"]
if mscale_all_dim:
mscale = yarn_get_mscale(scaling_factor, mscale_all_dim)
mscale = yarn_get_mscale(rope_parameters["factor"], mscale_all_dim)
scaling = scaling * mscale * mscale
return scaling

Expand Down
3 changes: 1 addition & 2 deletions src/transformers/models/youtu/modeling_youtu.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,9 +178,8 @@ def yarn_get_mscale(scale=1, mscale=1):
def yarn_apply_mscale(rope_parameters, scaling):
if rope_parameters.get("rope_type", "default") != "default":
mscale_all_dim = rope_parameters.get("mscale_all_dim", 0)
scaling_factor = rope_parameters["factor"]
if mscale_all_dim:
mscale = yarn_get_mscale(scaling_factor, mscale_all_dim)
mscale = yarn_get_mscale(rope_parameters["factor"], mscale_all_dim)
scaling = scaling * mscale * mscale
return scaling

Expand Down
22 changes: 22 additions & 0 deletions tests/models/phi3/test_modeling_phi3.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,28 @@ def test_longrope_generation_crossing_boundary(self, sliding_window):
expected = model(prefix, use_cache=False).logits[:, -1]
torch.testing.assert_close(logits, expected, rtol=1e-4, atol=1e-4)

@parameterized.expand([(8,), (16,)])
def test_longrope_compiled_matches_eager(self, seq_len):
config = self.model_tester.get_config()
config.original_max_position_embeddings = 8
config.max_position_embeddings = 32
rotary_dim = config.hidden_size // config.num_attention_heads // 2
config.rope_parameters = {
"rope_type": "longrope",
"rope_theta": 10000.0,
"short_factor": [1.0] * rotary_dim,
"long_factor": [2.0] * rotary_dim,
"original_max_position_embeddings": 8,
"factor": 4.0,
}
model = Phi3ForCausalLM(config).to(torch_device).eval()
input_ids = torch.arange(1, seq_len + 1, device=torch_device).unsqueeze(0)

with torch.no_grad():
expected = model(input_ids, use_cache=False).logits
Comment on lines +136 to +153

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dynamic matcthes eager in compile test missing 😄

If you wish, feel free to split dynamic into separate PR - just dont want to block you from getting longrope merged. With dynamic we'll need to check perfs, looks sus from the code to re-compute freq all the time

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was test_dynamic_rope_compiled_matches_eager in tests/utils/test_modeling_rope_utils.py, now reverted together with the dynamic change.

compiled = torch.compile(model, fullgraph=True)(input_ids, use_cache=False).logits
torch.testing.assert_close(compiled, expected, rtol=1e-4, atol=1e-4)


@slow
@require_torch
Expand Down
Loading