schema.fbs -> program.fbs

Summary: schema.flatbuffer_schema is a poor name. Program is more specific (in the context of the full path)

Reviewed By: dbort

Differential Revision: D47969015

fbshipit-source-id: 0fa6777b1845406438582ad85d6d2292dc56c944

Author: JacobSzwejbka

.gitignore

@@ -3,4 +3,4 @@ executorch.egg-info
 __pycache__/
 build/lib/
 exir/serialize/scalar_type.fbs
-exir/serialize/schema.fbs
+exir/serialize/program.fbs

backends/compile_spec_schema.py

@@ -7,7 +7,7 @@
 from dataclasses import dataclass
 
 """
-Please refer to executorch/schema/schema.fbs for source of truth.
+Please refer to executorch/schema/program.fbs for source of truth.
 """
 
 

docs/website/docs/contributors/program_file_format.md

@@ -84,7 +84,7 @@ Example:
 
 ## Program data
 
-See `//executorch/schema/schema.fbs` for the Program flatbuffer schema.
+See `//executorch/schema/program.fbs` for the Program flatbuffer schema.
 
 The flatbuffer-encoded program data follows the headers. By embedding the size
 of this region in the extended header, clients can read only the program data

exir/scripts/TARGETS

@@ -29,7 +29,7 @@ python_library(
         "__init__.py",
     ],
     resources = {
-        "//executorch/schema:schema.fbs": "schema.fbs",
+        "//executorch/schema:program.fbs": "program.fbs",
     },
     deps = [
         "//libfb/py:fbpkg",

exir/serialize/TARGETS

@@ -34,8 +34,8 @@ runtime.python_library(
         "_program.py",
     ],
     resources = {
+        "//executorch/schema:program.fbs": "program.fbs",
         "//executorch/schema:scalar_type.fbs": "scalar_type.fbs",
-        "//executorch/schema:schema.fbs": "schema.fbs",
         "fbsource//third-party/flatbuffers:flatc-host": "flatbuffers-flatc",
     },
     # Currently serialization API should only be used in some dedicated targets,

exir/serialize/_flatbuffer.py

@@ -135,7 +135,7 @@ def _prepare_schema(
     into out_dir. May patch the schema contents depending on the parameters to
     this function.
     """
-    program_schema = "schema.fbs"
+    program_schema = "program.fbs"
     # Included by the root program schema; must also be present.
     deps = ["scalar_type.fbs"]
 
@@ -247,7 +247,7 @@ def _program_json_to_flatbuffer(
 
     Args:
         program_json: The JSON to convert. Must be compatible with the root
-            table type of //executorch/schema/schema.fbs.
+            table type of //executorch/schema/program.fbs.
         constant_tensor_alignment: If provided, the alignment to use for tensor
             data embedded in the output flatbuffer data. If not provided, uses
             the alignment in the schema.
@@ -280,7 +280,7 @@ def _program_json_to_flatbuffer(
 def _program_flatbuffer_to_json(program_flatbuffer: bytes) -> bytes:
     """Converts binary flatbuffer data into Program-compatible JSON.
 
-    The binary is parsed using the schema in //executorch/schema/schema.fbs.
+    The binary is parsed using the schema in //executorch/schema/program.fbs.
     """
     with tempfile.TemporaryDirectory() as temp_dir:
         # No need to patch the alignment when reading. "force_align" is only

exir/serialize/test/test_flatbuffer.py

@@ -68,7 +68,7 @@ def test_load_patch_and_write(self) -> None:
 
 # Fake resource files to use when testing alignment-patching.
 SCHEMA_FILES: Dict[str, bytes] = {
-    "schema.fbs": b"\n".join(
+    "program.fbs": b"\n".join(
         [
             b"table Program {",
             # Space after the colon.
@@ -122,7 +122,7 @@ def call_prepare_schema(
     def test_unmodified(self) -> None:
         with tempfile.TemporaryDirectory() as out_dir:
             info: _SchemaInfo = self.call_prepare_schema(SCHEMA_FILES, out_dir)
-            self.assertEqual(info.root_path, os.path.join(out_dir, "schema.fbs"))
+            self.assertEqual(info.root_path, os.path.join(out_dir, "program.fbs"))
             # Files should not have been modified.
             for fname in SCHEMA_FILES.keys():
                 self.assertEqual(read_file(out_dir, fname), SCHEMA_FILES[fname])
@@ -134,10 +134,10 @@ def test_update_tensor_alignment(self) -> None:
             info: _SchemaInfo = self.call_prepare_schema(
                 SCHEMA_FILES, out_dir, constant_tensor_alignment=128
             )
-            self.assertEqual(info.root_path, os.path.join(out_dir, "schema.fbs"))
+            self.assertEqual(info.root_path, os.path.join(out_dir, "program.fbs"))
             # Only the tensor alignment lines should have been modified.
             self.assertEqual(
-                read_file(out_dir, "schema.fbs"),
+                read_file(out_dir, "program.fbs"),
                 b"\n".join(
                     [
                         b"table Program {",
@@ -170,10 +170,10 @@ def test_update_delegate_alignment(self) -> None:
             info: _SchemaInfo = self.call_prepare_schema(
                 SCHEMA_FILES, out_dir, delegate_alignment=256
             )
-            self.assertEqual(info.root_path, os.path.join(out_dir, "schema.fbs"))
+            self.assertEqual(info.root_path, os.path.join(out_dir, "program.fbs"))
             # Only the delegate alignment lines should have been modified.
             self.assertEqual(
-                read_file(out_dir, "schema.fbs"),
+                read_file(out_dir, "program.fbs"),
                 b"\n".join(
                     [
                         b"table Program {",
@@ -209,10 +209,10 @@ def test_update_tensor_and_delegate_alignment(self) -> None:
                 constant_tensor_alignment=1,
                 delegate_alignment=2,
             )
-            self.assertEqual(info.root_path, os.path.join(out_dir, "schema.fbs"))
+            self.assertEqual(info.root_path, os.path.join(out_dir, "program.fbs"))
             # Only the delegate alignment lines should have been modified.
             self.assertEqual(
-                read_file(out_dir, "schema.fbs"),
+                read_file(out_dir, "program.fbs"),
                 b"\n".join(
                     [
                         b"table Program {",

extension/pybindings/TARGETS

@@ -34,7 +34,7 @@ executorch_pybindings(
         "//executorch/runtime/executor:executor_aten",
         "//executorch/runtime/core/exec_aten:lib",
         "//executorch/schema:bundled_program_schema",
-        "//executorch/schema:schema",
+        "//executorch/schema:program",
         "//executorch/extension/data_loader:buffer_data_loader",
         "//executorch/extension/data_loader:mmap_data_loader",
         "//executorch/util:read_file",

extension/pybindings/module.cpp

@@ -23,7 +23,7 @@
 #include <executorch/runtime/platform/profiler.h>
 #include <executorch/runtime/platform/runtime.h>
 #include <executorch/schema/bundled_program_schema_generated.h>
-#include <executorch/schema/schema_generated.h>
+#include <executorch/schema/program_generated.h>
 #include <executorch/util/TestMemoryConfig.h>
 #include <executorch/util/bundled_program_verification.h>
 #include <executorch/util/read_file.h>

extension/pybindings/pybindings.cpp

@@ -10,7 +10,7 @@
 #include <pybind11/stl.h>
 
 #include <executorch/runtime/platform/assert.h>
-#include <executorch/schema/schema_generated.h>
+#include <executorch/schema/program_generated.h>
 #include <executorch/util/read_file.h>
 
 namespace py = pybind11;