Generic numeric debugging (#19317)

devtools/intermediate_output_tap/TARGETS

@@ -0,0 +1,85 @@
+load("@fbsource//xplat/executorch/build:runtime_wrapper.bzl", "runtime")
+
+oncall("executorch")
+
+runtime.python_library(
+    name = "spec",
+    srcs = ["_spec.py"],
+)
+
+runtime.python_library(
+    name = "custom_ops_lib",
+    srcs = ["custom_ops_lib.py"],
+    deps = [
+        "//caffe2:torch",
+    ],
+)
+
+runtime.python_library(
+    name = "selectors",
+    srcs = ["_selectors.py"],
+    deps = [
+        "//caffe2:torch",
+    ],
+)
+
+runtime.python_library(
+    name = "reducers",
+    srcs = ["_reducers.py"],
+    deps = [
+        "//caffe2:torch",
+        "//executorch/exir/dialects:lib",
+    ],
+)
+
+runtime.python_library(
+    name = "tap_pass",
+    srcs = ["_tap_pass.py"],
+    deps = [
+        "//caffe2:torch",
+        ":custom_ops_lib",
+        ":reducers",
+        ":selectors",
+        ":spec",
+    ],
+)
+
+runtime.python_library(
+    name = "strip_pass",
+    srcs = ["_strip_pass.py"],
+    deps = [
+        "//caffe2:torch",
+        ":reducers",
+        ":tap_pass",
+    ],
+)
+
+runtime.python_library(
+    name = "convenience",
+    srcs = ["_convenience.py"],
+    deps = [
+        "fbsource//third-party/pypi/pandas:pandas",
+        "//caffe2:torch",
+        "//executorch/exir:lib",
+        "//executorch/runtime:runtime",
+        ":reducers",
+        ":selectors",
+        ":spec",
+        ":strip_pass",
+        ":tap_pass",
+    ],
+)
+
+runtime.python_library(
+    name = "lib",
+    srcs = ["__init__.py"],
+    deps = [
+        ":convenience",
+        ":custom_ops_lib",
+        ":reducers",
+        ":selectors",
+        ":spec",
+        ":strip_pass",
+        ":tap_pass",
+    ],
+)

devtools/intermediate_output_tap/__init__.py

@@ -0,0 +1,99 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+#
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+# pyre-unsafe
+
+"""
+Public API for the ExecuTorch numerical debugger.
+
+Backend-agnostic intermediate-value tap:
+
+- Runtime side : USER_OUTPUT taps (this module — works through delegates without
+                 any backend-side changes)
+
+Typical usage:
+
+    from executorch.devtools.intermediate_output_tap import (
+        compare_aot_runtime_dataframe,
+        tap_intermediate_outputs, strip_taps_, STATS,
+    )
+
+    ep = export(model, example_inputs)
+    ep_tapped, specs = tap_intermediate_outputs(ep, reducer=STATS)
+    aot_flat, _ = pytree.tree_flatten(ep_tapped.module()(*example_inputs))
+    edge = to_edge_transform_and_lower(ep_tapped, partitioner=[XnnpackPartitioner()])
+    strip_taps_(edge)
+    et_program = edge.to_executorch()
+
+    rt_flat = runtime.forward(*example_inputs)
+    df = compare_aot_runtime_dataframe(specs, aot_flat, rt_flat)
+"""
+
+# Importing this module registers torch.ops.executorch_devtools.tap.Tensor.
+from executorch.devtools.intermediate_output_tap import custom_ops_lib  # noqa: F401
+from executorch.devtools.intermediate_output_tap._convenience import (
+    compare_aot_runtime_dataframe,
+    specs_to_dataframe,
+    tap_all_and_run,
+    tap_compare,
+)
+from executorch.devtools.intermediate_output_tap._reducers import (
+    FULL_TENSOR,
+    get_reducer,
+    StatReducer,
+    STATS,
+)
+from executorch.devtools.intermediate_output_tap._selectors import (
+    NodeSelector,
+    select_all,
+    select_all_call_function,
+    select_any,
+    select_by_meta_tag,
+    select_by_module_class,
+    select_by_module_path,
+    select_by_op_type,
+    select_not,
+)
+from executorch.devtools.intermediate_output_tap._spec import TapSpec
+from executorch.devtools.intermediate_output_tap._strip_pass import strip_taps_
+from executorch.devtools.intermediate_output_tap._tap_pass import (
+    find_tap_nodes,
+    is_tap_node,
+    tap_intermediate_outputs,
+    TapRule,
+)
+
+
+__all__ = [
+    # Core API
+    "tap_intermediate_outputs",
+    "strip_taps_",
+    "TapSpec",
+    "TapRule",
+    # Convenience
+    "tap_compare",
+    "tap_all_and_run",
+    "specs_to_dataframe",
+    "compare_aot_runtime_dataframe",
+    # Reducers
+    "StatReducer",
+    "FULL_TENSOR",
+    "STATS",
+    "get_reducer",
+    # Selectors
+    "NodeSelector",
+    "select_all_call_function",
+    "select_by_op_type",
+    "select_by_module_path",
+    "select_by_module_class",
+    "select_by_meta_tag",
+    "select_any",
+    "select_all",
+    "select_not",
+    # Helpers
+    "find_tap_nodes",
+    "is_tap_node",
+]