Skip to content

Commit a9f6aaa

Browse files
dbortfacebook-github-bot
authored andcommitted
Move program_file_format.md into the new docs tree (#1081)
Summary: Move program_file_format.md into the new docs tree. Also update the one reference to it. Differential Revision: D50609710
1 parent f841cc9 commit a9f6aaa

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ Topics in this section will help you get started with ExecuTorch.
148148
runtime-backend-delegate-implementation-and-linking
149149
runtime-platform-abstraction-layer
150150
portable-cpp-programming
151+
pte-file-format
151152

152153
.. toctree::
153154
:glob:

docs/website/docs/contributors/program_file_format.md renamed to docs/source/pte-file-format.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1-
# Program file format
1+
# `.pte` file format
22

3-
ExecuTorch programs are serialized as modified binary flatbuffer files.
3+
ExecuTorch `.pte` program files are serialized as modified binary flatbuffer
4+
files with optional data segments appended.
45

56
```
67
┌───────────────────────────────────┐
78
│Standard flatbuffer header │
8-
├───────────────────────────────────┤
9-
│Optional ExecuTorch extended header
10-
├───────────────────────────────────┤
9+
┌─ ├───────────────────────────────────┤
10+
Optional ─┤ │ExecuTorch extended header
11+
└─ ├───────────────────────────────────┤
1112
│Flatbuffer-serialized program data │
1213
│ │
1314
│ │

schema/extended_header.h

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ namespace executor {
1717
* An extended, ExecuTorch-specific header that may be embedded in the
1818
* serialized Program data header.
1919
*
20-
* For details see
21-
* //executorch/docs/website/docs/contributors/program_file_format.md
20+
* For details see //executorch/docs/source/pte-file-format.md
2221
*/
2322
struct ExtendedHeader {
2423
/**

0 commit comments

Comments
 (0)