.ff -> .pte

Summary: .pte is the file extension for executorch binaries. We should stop using .ff and encourage partners and clients to use .pte. Pytorch/pytorch has never enforced extensions like .pt or .ptl so I'm comfortable not strictly enforcing .pte

Reviewed By: dbort

Differential Revision: D47967450

fbshipit-source-id: 13c5fc2b51d49ae2e63996d5814108b7808ce167

Author: JacobSzwejbka

.github/workflows/pull.yml

@@ -37,4 +37,4 @@ jobs:
         # Export a test model
         python3 -m examples.export.export_example --model_name="linear"
         # Run test model
-        buck2 run //examples/executor_runner:executor_runner -- --model_path ./linear.ff
+        buck2 run //examples/executor_runner:executor_runner -- --model_path ./linear.pte

backends/xnnpack/test/test_xnnpack_utils.py

@@ -116,7 +116,7 @@ def save_bundled_program(representative_inputs, program, ref_output, output_path
     bundled_program_buffer = serialize_from_bundled_program_to_flatbuffer(
         bundled_program
     )
-    output_path_with_postfix = f"{output_path}_bundled.ff"
+    output_path_with_postfix = f"{output_path}_bundled.pte"
     print(f"saving bundled program to {output_path}...")
 
     with open(output_path_with_postfix, "wb") as file:
@@ -223,7 +223,7 @@ def forward(self, *args):
 
         ref_output = delegated_program(*sample_inputs)
         if dump_ff:
-            filename = f"/tmp/xnnpack_test_{randint(1, 99999)}.ff"
+            filename = f"/tmp/xnnpack_test_{randint(1, 99999)}.pte"
             print(f"Writing flatbuffer to {filename} ...")
 
             save_bundled_program(

codegen/tools/targets.bzl

@@ -143,7 +143,7 @@ def define_common_targets(is_fbcode = False):
             srcs = ["test/test_gen_oplist_real_model.py"],
             base_module = "",
             resources = {
-                "//executorch/test/models:exported_programs[ModuleLinear.ff]": "test/ModuleLinear.ff",
+                "//executorch/test/models:exported_programs[ModuleLinear.pte]": "test/ModuleLinear.pte",
             },
             visibility = [
                 "//executorch/...",

codegen/tools/test/test_gen_oplist.py

@@ -132,7 +132,7 @@ def test_get_custom_build_selector_with_both_allowlist_and_yaml(
     ) -> None:
         op_list = ["aten::add", "aten::mul"]
         filename = os.path.join(self.temp_dir.name, "selected_operators.yaml")
-        gen_oplist._dump_yaml(op_list, filename, "model.ff")
+        gen_oplist._dump_yaml(op_list, filename, "model.pte")
         self.assertTrue(os.path.isfile(filename))
         with open(filename) as f:
             es = yaml.safe_load(f)

codegen/tools/test/test_gen_oplist_real_model.py

@@ -15,7 +15,7 @@
 
 from libfb.py import parutil
 
-MODEL_PATH: Final[str] = parutil.get_file_path("ModuleLinear.ff", pkg=__package__)
+MODEL_PATH: Final[str] = parutil.get_file_path("ModuleLinear.pte", pkg=__package__)
 
 
 class TestGenOplistRealModel(unittest.TestCase):

docs/website/docs/tutorials/00_setting_up_executorch.md

@@ -51,10 +51,10 @@ pip install .
 
 Via python script:
 ```bash
-# Creates the file `add.ff`
+# Creates the file `add.pte`
 python3 -m examples.export.export_example --model_name="add"
 
-# Creates the delegated program `composite_model.ff`, other options are "whole" and "partition"
+# Creates the delegated program `composite_model.pte`, other options are "whole" and "partition"
 python3 -m examples.export.export_and_delegate --option "composite"
 ```
 
@@ -65,7 +65,7 @@ $ python3
 >>> from executorch.exir.tests.models import Mul
 >>> m = Mul()
 >>> print(exir.capture(m, m.get_random_inputs()).to_edge())
->>> open("add.ff", "wb").write(exir.capture(m, m.get_random_inputs()).to_edge().to_executorch().buffer)
+>>> open("add.pte", "wb").write(exir.capture(m, m.get_random_inputs()).to_edge().to_executorch().buffer)
 ```
 
 ## Runtime Setup
@@ -119,17 +119,17 @@ conda install -c conda-forge lld
 ### Step 3: Run a binary
 
 ```bash
-# add.ff is the program generated from export_example.py during AOT Setup Step 3
-/tmp/buck2 run //examples/executor_runner:executor_runner -- --model_path add.ff
+# add.pte is the program generated from export_example.py during AOT Setup Step 3
+/tmp/buck2 run //examples/executor_runner:executor_runner -- --model_path add.pte
 
 # To run a delegated model
-/tmp/buck2 run //examples/executor_runner:executor_runner -- --model_path composite_model.ff
+/tmp/buck2 run //examples/executor_runner:executor_runner -- --model_path composite_model.pte
 ```
 
 or execute the binary directly from the `--show-output` path shown when building.
 
 ```bash
-./buck-out/.../executor_runner --model_path add.ff
+./buck-out/.../executor_runner --model_path add.pte
 ```
 
 ## More examples

docs/website/docs/tutorials/backend_delegate.md

@@ -202,7 +202,7 @@ model_inputs = (torch.ones(1), )
 exec_prog = exir.capture(composite_model, model_inputs).to_edge().to_executorch()
 
 # Save the flatbuffer to a local file
-save_path = "delegate.fft"
+save_path = "delegate.pte"
 with open(save_path, "wb") as f:
     f.write(exec_prog.buffer)
 ```
@@ -257,7 +257,7 @@ exec_prog = to_backend(gm, AddMulPartitionerDemo).to_executorch(
 )
 
 # Save the flatbuffer to a local file
-save_path = "delegate.fft"
+save_path = "delegate.pte"
 with open(save_path, "wb") as f:
     f.write(exec_prog.buffer)
 ```

docs/website/docs/tutorials/exporting_to_executorch.md

@@ -196,7 +196,7 @@ executorch_program = edge_dialect.to_executorch(executorch_backend_config)
 buffer = executorch_program.buffer
 
 # Save it to a file and load it in the Executorch runtime
-with open("model.ff", "wb") as file:
+with open("model.pte", "wb") as file:
     file.write(buffer)
 
 # Or you can run the Executorch runtime in python to try it out

docs/website/docs/tutorials/profiling.md

@@ -56,7 +56,7 @@ Here is an example of what a ExecuTorch run + profile + post-procesing workflow
 This runs the sample program with profiling enabled
 ```bash
 cd executorch
-buck2 run -c executorch.prof_enabled=true examples/executor_runner:executor_runner  -- --model_path add.ff
+buck2 run -c executorch.prof_enabled=true examples/executor_runner:executor_runner  -- --model_path add.pte
 ```
 Run the post-processing CLI tool that calls into the same API's listed above and prints out the profiling results in a tabulated format in the terminal.
 

docs/website/docs/tutorials/selective_build.md

@@ -32,7 +32,7 @@ load("@fbsource//xplat/executorch/codegen:codegen.bzl", "et_operator_library")
 
 fb_native.export_file(
   name = "model_1",
-  src = "model_1.ff", # checked in model
+  src = "model_1.pte", # checked in model
 )
 
 et_operator_library(

examples/README.md

@@ -36,13 +36,13 @@ bash examples/install_requirements.sh
 
 python3 -m examples.export.export_example --model_name="mv2" # for MobileNetv2
 
-# This should generate ./mv2.ff file, if successful.
+# This should generate ./mv2.pte file, if successful.
 ```
 
 3. Once we have the model binary (ff) file, then let's run it with Executorch runtime using the `executor_runner`.
 
 ```bash
-buck2 run examples/executor_runner:executor_runner -- --model_path mv2.ff
+buck2 run examples/executor_runner:executor_runner -- --model_path mv2.pte
 ```
 
 For MobileNetv3, change the model name and the corrosponding binary filename from "mv2" to "mv3".

examples/executor_runner/executor_runner.cpp

@@ -32,7 +32,10 @@
 static constexpr size_t kRuntimeMemorySize = 4 * 1024U * 1024U; // 4 MB
 static uint8_t runtime_pool[kRuntimeMemorySize];
 
-DEFINE_string(model_path, "model.ff", "Model serialized in flatbuffer format.");
+DEFINE_string(
+    model_path,
+    "model.pte",
+    "Model serialized in flatbuffer format.");
 DEFINE_string(
     prof_result_path,
     "prof_result.bin",

examples/export/export_and_delegate.py

@@ -84,7 +84,7 @@ def forward(self, *args):
     buffer = exec_prog.buffer
 
     model_name = "composite_model"
-    filename = f"{model_name}.ff"
+    filename = f"{model_name}.pte"
     print(f"Saving exported program to {filename}")
     with open(filename, "wb") as file:
         file.write(buffer)
@@ -134,7 +134,7 @@ def get_example_inputs(self):
     buffer = exec_prog.buffer
 
     model_name = "partition_lowered_model"
-    filename = f"{model_name}.ff"
+    filename = f"{model_name}.pte"
     print(f"Saving exported program to {filename}")
     with open(filename, "wb") as file:
         file.write(buffer)

examples/export/export_example.py

@@ -26,7 +26,7 @@ def export_to_ff(model_name, model, example_inputs):
 
     buffer = exec_prog.buffer
 
-    filename = f"{model_name}.ff"
+    filename = f"{model_name}.pte"
     print(f"Saving exported program to {filename}")
     with open(filename, "wb") as file:
         file.write(buffer)

exir/scripts/serialize.py

@@ -24,9 +24,9 @@ def test() -> None:
     with open("boop.pkl", "wb") as f:
         pickle.dump(program, f)
 
-    save_serialized_model("boop.pkl", "moop.ff")
+    save_serialized_model("boop.pkl", "moop.pte")
 
-    with open("moop.ff", "rb") as f:
+    with open("moop.pte", "rb") as f:
         serialized_flatbuffer_loaded = f.read()
 
     assert serialized_flatbuffer_og == serialized_flatbuffer_loaded

exir/serialize/_flatbuffer.py

@@ -265,7 +265,7 @@ def _program_json_to_flatbuffer(
         )
         file_stem = "data"
         json_path = os.path.join(temp_dir, file_stem + ".json")
-        output_path = os.path.join(temp_dir, file_stem + ".extorch")
+        output_path = os.path.join(temp_dir, file_stem + ".pte")
 
         with open(json_path, "wb") as json_file:
             json_file.write(program_json.encode("ascii"))

runtime/executor/test/targets.bzl

@@ -78,8 +78,8 @@ def define_common_targets(is_fbcode = False):
             # The tests use this var to find the program file to load. This uses
             # an fbcode target path because the authoring/export tools
             # intentionally don't work in xplat (since they're host-only tools).
-            "ET_MODULE_ADD_PATH": "$(location fbcode//executorch/test/models:exported_programs[ModuleAdd.ff])",
-            "ET_MODULE_MULTI_ENTRY_PATH": "$(location fbcode//executorch/test/models:exported_programs[ModuleMultipleEntry.ff])",
+            "ET_MODULE_ADD_PATH": "$(location fbcode//executorch/test/models:exported_programs[ModuleAdd.pte])",
+            "ET_MODULE_MULTI_ENTRY_PATH": "$(location fbcode//executorch/test/models:exported_programs[ModuleMultipleEntry.pte])",
         }
 
         runtime.cxx_test(
@@ -173,8 +173,8 @@ def define_common_targets(is_fbcode = False):
                 # Uses an fbcode target path because the authoring/export tools
                 # intentionally don't work in xplat (since they're host-only
                 # tools).
-                "ET_MODULE_ADD_MUL_NOSEGMENTS_DA1024_PATH": "$(location fbcode//executorch/test/models:exported_delegated_programs[ModuleAddMul-nosegments-da1024.ff])",
-                "ET_MODULE_ADD_MUL_NOSEGMENTS_PATH": "$(location fbcode//executorch/test/models:exported_delegated_programs[ModuleAddMul-nosegments.ff])",
-                "ET_MODULE_ADD_MUL_PATH": "$(location fbcode//executorch/test/models:exported_delegated_programs[ModuleAddMul.ff])",
+                "ET_MODULE_ADD_MUL_NOSEGMENTS_DA1024_PATH": "$(location fbcode//executorch/test/models:exported_delegated_programs[ModuleAddMul-nosegments-da1024.pte])",
+                "ET_MODULE_ADD_MUL_NOSEGMENTS_PATH": "$(location fbcode//executorch/test/models:exported_delegated_programs[ModuleAddMul-nosegments.pte])",
+                "ET_MODULE_ADD_MUL_PATH": "$(location fbcode//executorch/test/models:exported_delegated_programs[ModuleAddMul.pte])",
             },
         )

schema/schema.fbs

@@ -11,7 +11,7 @@ namespace executorch_flatbuffer;
 // Identifier of a valid executor schema.
 file_identifier "ET12";
 // Extension of written files.
-file_extension "extorch";
+file_extension "pte";
 
 // Table that contains the metadata about how
 // to unflatten the flattened input/output from compiler

scripts/test_executorch_jarvis.sh

@@ -7,4 +7,4 @@
 
 buck run @fbcode//on_device_ai/Assistant/Jarvis/mode/Harmony_HiFi4_Opus_Tie_5/dev-eh \
     fbcode//on_device_ai/Assistant/Jarvis/min_runtime:min_runtime_size_test -- \
-    fbcode/executorch/test/models/linear_out.ff
+    fbcode/executorch/test/models/linear_out.pte

sdk/runners/executor_runner.cpp

@@ -69,7 +69,10 @@ DEFINE_bool(print_output, false, "Prints output of the model.");
 
 DEFINE_int32(num_iters, 1, "Number of inference iterations to run.");
 
-DEFINE_string(model_path, "model.ff", "Model serialized in flatbuffer format.");
+DEFINE_string(
+    model_path,
+    "model.pte",
+    "Model serialized in flatbuffer format.");
 
 DEFINE_int32(num_threads, 1, "Number of threads to use.");
 

test/models/export_delegated_program.py

@@ -18,11 +18,11 @@
 from executorch.backends.test.backend_with_compiler_demo import BackendWithCompilerDemo
 from torch import nn
 
-"""Traces and exports delegated nn.Modules to Executorch .ff program files.
+"""Traces and exports delegated nn.Modules to Executorch .pte program files.
 
 Creates two versions of each file:
-- <module-name>.ff: Delegate data stored in segments outside of the flatbuffer data.
-- <module-name>-nosegments.ff: Delegate data is stored directly in the flatbuffer data.
+- <module-name>.pte: Delegate data stored in segments outside of the flatbuffer data.
+- <module-name>-nosegments.pte: Delegate data is stored directly in the flatbuffer data.
 
 This tool mainly exists to export programs for C++ tests, but can also
 be used to export models manually.
@@ -131,7 +131,7 @@ def main() -> None:
     # when possible.
     parser = argparse.ArgumentParser(
         prog="export_delegated_program",
-        description="Exports delegated nn.Module models to Executorch .ff files",
+        description="Exports delegated nn.Module models to Executorch .pte files",
     )
     parser.add_argument(
         "--modules",
@@ -150,7 +150,7 @@ def main() -> None:
         "--outdir",
         type=str,
         required=True,
-        help="Path to the directory to write <classname>[-<suffix>[...]].ff "
+        help="Path to the directory to write <classname>[-<suffix>[...]].pte "
         + "files to.",
     )
     args = parser.parse_args()
@@ -174,7 +174,7 @@ def main() -> None:
             # the data to accidentally be aligned to it in the default case.
             for delegate_alignment in (None, 1024):
                 suffix += f"-da{delegate_alignment}" if delegate_alignment else ""
-                outfile = os.path.join(args.outdir, f"{module_name}{suffix}.ff")
+                outfile = os.path.join(args.outdir, f"{module_name}{suffix}.pte")
                 with open(outfile, "wb") as fp:
                     fp.write(
                         export_module_to_program(

test/models/export_program.py

@@ -14,7 +14,7 @@
 from executorch.test.end2end.exported_module import ExportedModule
 from torch import nn
 
-"""Traces and exports nn.Modules to Executorch .ff program files.
+"""Traces and exports nn.Modules to Executorch .pte program files.
 
 This tool mainly exists to export programs for C++ tests, but can also
 be used to export models manually.
@@ -130,7 +130,7 @@ def main() -> None:
     # when possible.
     parser = argparse.ArgumentParser(
         prog="export_program",
-        description="Exports nn.Module models to Executorch .ff files",
+        description="Exports nn.Module models to Executorch .pte files",
     )
     parser.add_argument(
         "--modules",
@@ -142,7 +142,7 @@ def main() -> None:
         "--outdir",
         type=str,
         required=True,
-        help="Path to the directory to write <classname>.ff files to",
+        help="Path to the directory to write <classname>.pte files to",
     )
     args = parser.parse_args()
 
@@ -158,7 +158,7 @@ def main() -> None:
     # Export and write to the output files.
     os.makedirs(args.outdir, exist_ok=True)
     for module_name, module_class in module_names_to_classes.items():
-        outfile = os.path.join(args.outdir, f"{module_name}.ff")
+        outfile = os.path.join(args.outdir, f"{module_name}.pte")
         with open(outfile, "wb") as fp:
             fp.write(export_module_to_program(module_class))
         print(f"Exported {module_name} and wrote program data to {outfile}")

test/models/generate_linear_out_bundled_program.py

@@ -101,7 +101,7 @@ def main() -> None:
         subprocess.run(["hg", "root"], stdout=subprocess.PIPE).stdout.decode().strip()
     )
     with open(
-        f"{fbsource_base_path}/fbcode/executorch/test/models/linear_out_bundled_program.ff",
+        f"{fbsource_base_path}/fbcode/executorch/test/models/linear_out_bundled_program.pte",
         "wb",
     ) as file:
         file.write(bundled_program_flatbuffer)

test/models/targets.bzl

@@ -65,12 +65,12 @@ def define_common_targets():
         "ModuleMultipleEntry",
     ]
 
-    # Generates Executorch .ff program files for various modules at build time.
-    # To use one, depend on a target like ":exported_programs[ModuleAdd.ff]".
+    # Generates Executorch .pte program files for various modules at build time.
+    # To use one, depend on a target like ":exported_programs[ModuleAdd.pte]".
     runtime.genrule(
         name = "exported_programs",
         cmd = "$(exe :export_program) --modules " + ",".join(MODULES_TO_EXPORT) + " --outdir $OUT",
-        outs = {fname + ".ff": [fname + ".ff"] for fname in MODULES_TO_EXPORT},
+        outs = {fname + ".pte": [fname + ".pte"] for fname in MODULES_TO_EXPORT},
         default_outs = ["."],
         visibility = [
             "//executorch/...",
@@ -121,10 +121,10 @@ def define_common_targets():
     # Name of the backend to use when exporting delegated programs.
     BACKEND_ID = "StubBackend"
 
-    # Generates Executorch .ff program files for various modules at build time.
+    # Generates Executorch .pte program files for various modules at build time.
     # To use one, depend on a target like
-    # ":exported_delegated_programs[ModuleAdd.ff]" or
-    # ":exported_delegated_programs[ModuleAdd-nosegments.ff]" (which does not
+    # ":exported_delegated_programs[ModuleAdd.pte]" or
+    # ":exported_delegated_programs[ModuleAdd-nosegments.pte]" (which does not
     # extract the delegate data blobs into segments).
     runtime.genrule(
         name = "exported_delegated_programs",
@@ -133,7 +133,7 @@ def define_common_targets():
               " --backend_id " + BACKEND_ID +
               " --outdir $OUT",
         outs = {
-            fname + seg_suffix + da_suffix + ".ff": [fname + seg_suffix + da_suffix + ".ff"]
+            fname + seg_suffix + da_suffix + ".pte": [fname + seg_suffix + da_suffix + ".pte"]
             for fname in DELEGATED_MODULES_TO_EXPORT
             for seg_suffix in ["", "-nosegments"]
             # "da" = delegate alignment