|
| 1 | +# Copyright 2026 Arm Limited and/or its affiliates. |
| 2 | +# |
| 3 | +# This source code is licensed under the BSD-style license found in the |
| 4 | +# LICENSE file in the root directory of this source tree. |
| 5 | + |
| 6 | +import pytest |
| 7 | +import torch |
| 8 | +from executorch.backends.arm._passes.decompose_embedding_pass import ( |
| 9 | + DecomposeEmbeddingPass, |
| 10 | +) |
| 11 | +from executorch.backends.arm.quantizer.arm_quantizer_utils import NodeFinder |
| 12 | +from executorch.backends.cortex_m.quantizer.node_finders import ( |
| 13 | + ModuleNameNodeFinder, |
| 14 | + ModuleTypeNodeFinder, |
| 15 | +) |
| 16 | +from torch.fx import Node |
| 17 | + |
| 18 | + |
| 19 | +class Embedding(torch.nn.Module): |
| 20 | + """Exercise the exported aten.embedding op from a real named submodule.""" |
| 21 | + |
| 22 | + def __init__(self): |
| 23 | + super().__init__() |
| 24 | + self.embedding = torch.nn.Embedding(16, 4) |
| 25 | + |
| 26 | + def forward(self, indices: torch.Tensor) -> torch.Tensor: |
| 27 | + return self.embedding(indices) |
| 28 | + |
| 29 | + def get_inputs(self, dtype: torch.dtype = torch.int32) -> tuple[torch.Tensor]: |
| 30 | + return (torch.tensor([[1, 2, 3], [4, 5, 6]], dtype=dtype),) |
| 31 | + |
| 32 | + |
| 33 | +def _decompose_embedding(model: Embedding, inputs: tuple[torch.Tensor]): |
| 34 | + graph_module = torch.export.export(model, inputs).module() |
| 35 | + source_nodes = [ |
| 36 | + node |
| 37 | + for node in graph_module.graph.nodes |
| 38 | + if node.target == torch.ops.aten.embedding.default |
| 39 | + ] |
| 40 | + assert len(source_nodes) == 1 |
| 41 | + original_stack = source_nodes[0].meta.get("nn_module_stack") |
| 42 | + assert original_stack, "Export must preserve Embedding module provenance" |
| 43 | + |
| 44 | + result = DecomposeEmbeddingPass(tfa_pass=True)(graph_module) |
| 45 | + assert result is not None, "Embedding decomposition must return a PassResult" |
| 46 | + nodes = list(result.graph_module.graph.nodes) |
| 47 | + lookup_nodes = [ |
| 48 | + node for node in nodes if node.target == torch.ops.aten.index_select.default |
| 49 | + ] |
| 50 | + assert len(lookup_nodes) == 1 |
| 51 | + lookup = lookup_nodes[0] |
| 52 | + |
| 53 | + flattened_indices = lookup.args[2] |
| 54 | + assert isinstance(flattened_indices, Node) |
| 55 | + assert flattened_indices.target == torch.ops.aten.reshape.default |
| 56 | + |
| 57 | + restored_outputs = [ |
| 58 | + node |
| 59 | + for node in nodes |
| 60 | + if node.target == torch.ops.aten.reshape.default and node.args[0] is lookup |
| 61 | + ] |
| 62 | + assert len(restored_outputs) == 1 |
| 63 | + restored_output = restored_outputs[0] |
| 64 | + |
| 65 | + return ( |
| 66 | + result.graph_module, |
| 67 | + (flattened_indices, lookup, restored_output), |
| 68 | + original_stack, |
| 69 | + ) |
| 70 | + |
| 71 | + |
| 72 | +@pytest.mark.parametrize("index_dtype", [torch.int32, torch.int64]) |
| 73 | +def test_embedding_decomposition_preserves_module_metadata(index_dtype: torch.dtype): |
| 74 | + """Both reshapes and the lookup must inherit the original module stack.""" |
| 75 | + model = Embedding().eval() |
| 76 | + inputs = model.get_inputs(dtype=index_dtype) |
| 77 | + graph_module, generated_nodes, original_stack = _decompose_embedding(model, inputs) |
| 78 | + |
| 79 | + assert all( |
| 80 | + node.meta.get("nn_module_stack") == original_stack for node in generated_nodes |
| 81 | + ) |
| 82 | + assert generated_nodes[0].meta["val"].dtype == index_dtype |
| 83 | + assert generated_nodes[1].meta["val"].is_floating_point() |
| 84 | + torch.testing.assert_close(graph_module(*inputs), model(*inputs)) |
| 85 | + |
| 86 | + |
| 87 | +@pytest.mark.parametrize("selector", ["module_type", "module_name"]) |
| 88 | +def test_embedding_decomposition_remains_selectable_by_module(selector: str): |
| 89 | + """The replacement ops must match selectors used by the Arm quantizer.""" |
| 90 | + model = Embedding().eval() |
| 91 | + graph_module, generated_nodes, _ = _decompose_embedding(model, model.get_inputs()) |
| 92 | + |
| 93 | + finder: NodeFinder |
| 94 | + if selector == "module_type": |
| 95 | + finder = ModuleTypeNodeFinder(torch.nn.Embedding) |
| 96 | + else: |
| 97 | + finder = ModuleNameNodeFinder("embedding") |
| 98 | + |
| 99 | + selected_nodes = set(finder.find_nodes(graph_module)) |
| 100 | + assert set(generated_nodes) <= selected_nodes |
0 commit comments