|
| 1 | +# Copyright (c) Meta Platforms, Inc. and affiliates. |
| 2 | +# All rights reserved. |
| 3 | +# |
| 4 | +# This source code is licensed under the BSD-style license found in the |
| 5 | +# LICENSE file in the root directory of this source tree. |
| 6 | + |
| 7 | +import unittest |
| 8 | +from typing import Any, Optional, Tuple, Union |
| 9 | + |
| 10 | +import torch |
| 11 | + |
| 12 | +from executorch.codegen.tools.selective_build import ( # type: ignore[import-not-found] |
| 13 | + _get_io_metadata_for_program_operators, |
| 14 | + _get_program_from_buffer, |
| 15 | + _get_program_operators, |
| 16 | + _IOMetaData, |
| 17 | +) |
| 18 | +from executorch.exir import ExecutorchProgramManager, to_edge |
| 19 | +from executorch.exir.scalar_type import ScalarType |
| 20 | +from torch.export import export |
| 21 | + |
| 22 | + |
| 23 | +class ModuleAdd(torch.nn.Module): |
| 24 | + """The module to serialize and execute.""" |
| 25 | + |
| 26 | + def __init__(self): |
| 27 | + super(ModuleAdd, self).__init__() |
| 28 | + |
| 29 | + def forward(self, x, y): |
| 30 | + return x + y |
| 31 | + |
| 32 | + def get_methods_to_export(self): |
| 33 | + return ("forward",) |
| 34 | + |
| 35 | + |
| 36 | +class ModuleMulti(torch.nn.Module): |
| 37 | + """The module to serialize and execute.""" |
| 38 | + |
| 39 | + def __init__(self): |
| 40 | + super(ModuleMulti, self).__init__() |
| 41 | + |
| 42 | + def forward(self, x, y): |
| 43 | + return x + y |
| 44 | + |
| 45 | + def forward2(self, x, y): |
| 46 | + return x + y + 1 |
| 47 | + |
| 48 | + def get_methods_to_export(self): |
| 49 | + return ("forward", "forward2") |
| 50 | + |
| 51 | + |
| 52 | +def create_program( |
| 53 | + eager_module: Optional[Union[ModuleAdd, ModuleMulti]] = None, |
| 54 | +) -> Tuple[ExecutorchProgramManager, Tuple[Any, ...]]: |
| 55 | + """Returns an executorch program based on ModuleAdd, along with inputs.""" |
| 56 | + |
| 57 | + if eager_module is None: |
| 58 | + eager_module = ModuleAdd() |
| 59 | + |
| 60 | + class WrapperModule(torch.nn.Module): |
| 61 | + def __init__(self, fn): |
| 62 | + super().__init__() |
| 63 | + self.fn = fn |
| 64 | + |
| 65 | + def forward(self, *args, **kwargs): |
| 66 | + return self.fn(*args, **kwargs) |
| 67 | + |
| 68 | + # Trace the test module and create a serialized ExecuTorch program. |
| 69 | + inputs = (torch.ones(2, 2), torch.ones(2, 2)) |
| 70 | + input_map = {} |
| 71 | + # pyre-fixme[29]: `Union[torch._tensor.Tensor, torch.nn.modules.module.Module]` |
| 72 | + # is not a function. |
| 73 | + for method in eager_module.get_methods_to_export(): |
| 74 | + input_map[method] = inputs |
| 75 | + |
| 76 | + exported_methods = {} |
| 77 | + # These cleanup passes are required to convert the `add` op to its out |
| 78 | + # variant, along with some other transformations. |
| 79 | + for method_name, method_input in input_map.items(): |
| 80 | + module = WrapperModule(getattr(eager_module, method_name)) |
| 81 | + exported_methods[method_name] = export(module, method_input, strict=True) |
| 82 | + |
| 83 | + exec_prog = to_edge(exported_methods).to_executorch() |
| 84 | + |
| 85 | + # Create the ExecuTorch program from the graph. |
| 86 | + exec_prog.dump_executorch_program(verbose=True) |
| 87 | + return (exec_prog, inputs) |
| 88 | + |
| 89 | + |
| 90 | +class PybindingsTest(unittest.TestCase): |
| 91 | + def test_dump_operators(self): |
| 92 | + # Create and serialize a program. |
| 93 | + orig_program, _ = create_program() |
| 94 | + |
| 95 | + # Deserialize the program and demonstrate that we could get its operator |
| 96 | + # list. |
| 97 | + program = _get_program_from_buffer(orig_program.buffer) |
| 98 | + operators = _get_program_operators(program) |
| 99 | + self.assertEqual(operators, ["aten::add.out"]) |
| 100 | + |
| 101 | + def test_get_op_io_meta(self): |
| 102 | + # Checking whether get_op_io_meta returns the correct metadata for all its ios. |
| 103 | + orig_program, inputs = create_program() |
| 104 | + |
| 105 | + # Deserialize the program and demonstrate that we could get its operator |
| 106 | + # list. |
| 107 | + program = _get_program_from_buffer(orig_program.buffer) |
| 108 | + program_op_io_metadata = _get_io_metadata_for_program_operators(program) |
| 109 | + |
| 110 | + self.assertTrue(len(program_op_io_metadata) == 1) |
| 111 | + self.assertTrue(isinstance(program_op_io_metadata, dict)) |
| 112 | + |
| 113 | + self.assertTrue("aten::add.out" in program_op_io_metadata) |
| 114 | + self.assertTrue(isinstance(program_op_io_metadata["aten::add.out"], set)) |
| 115 | + self.assertTrue(len(program_op_io_metadata["aten::add.out"]) == 1) |
| 116 | + |
| 117 | + for op_io_metadata in program_op_io_metadata["aten::add.out"]: |
| 118 | + self.assertTrue(len(op_io_metadata) == 5) |
| 119 | + self.assertTrue(isinstance(op_io_metadata, tuple)) |
| 120 | + |
| 121 | + for io_idx, io_metadata in enumerate(op_io_metadata): |
| 122 | + self.assertTrue(isinstance(io_metadata, _IOMetaData)) |
| 123 | + if io_idx == 2: |
| 124 | + # TODO(gasoonjia): Create a enum class to map KernelTypes to int, remove the hardcoded 2 and 5 below. |
| 125 | + self.assertEqual(io_metadata.kernel_type, 2) |
| 126 | + else: |
| 127 | + self.assertEqual(io_metadata.kernel_type, 5) |
| 128 | + self.assertEqual(io_metadata.dtype, ScalarType.FLOAT) |
| 129 | + self.assertEqual(io_metadata.dim_order, [0, 1]) |
0 commit comments