Skip to content

Commit 6a27cd1

Browse files
dbortfacebook-github-bot
authored andcommitted
Add placeholder runtime/COMPATIBILITY.md (#6307)
Summary: This file will contain the details of the PTE-to-runtime compatibility policy. Update the appropriate docs to point to this file. Note that even release branches should point to the `main` branch version of this file, because the latest version is always the official policy. Pull Request resolved: #6307 Test Plan: Checked links: - https://docs-preview.pytorch.org/pytorch/executorch/6307/index.html - https://docs-preview.pytorch.org/pytorch/executorch/6307/pte-file-format.html Reviewed By: mergennachin Differential Revision: D64501085 Pulled By: dbort fbshipit-source-id: ac59529aa12fa76880a3531023a1a308f565ba50
1 parent 2be0105 commit 6a27cd1

File tree

3 files changed

+26
-6
lines changed

3 files changed

+26
-6
lines changed

docs/source/index.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,16 @@ Welcome to the ExecuTorch Documentation
44
=======================================
55

66
.. important::
7-
This is a beta release. As of this ExecuTorch beta release, the API
8-
will follow the `lifecycle and deprecation policy <api-life-cycle.html.html>`__
9-
and ``.pte`` binary format will comply with the *runtime compatibility policy* (TODO: add link).
10-
This ensures that application developers can update to the latest version of ExecuTorch
11-
without breaking existing integration code, in accordance with these policies.
12-
If any issues arise or compatibility breaks occur, please `report them in GitHub <https://github.com/pytorch/executorch/issues/new/choose>`__.
7+
v0.4.0 is a beta release of ExecuTorch. As of this release, the API will
8+
follow the `API Lifecycle and Deprecation Policy <api-life-cycle.html>`__,
9+
and the ``.pte`` binary format will comply with the `Runtime Compatibility
10+
Policy
11+
<https://github.com/pytorch/executorch/tree/main/runtime/COMPATIBILITY.md>`__.
12+
This helps ensure that application developers can update to the latest
13+
version of ExecuTorch without breaking existing integration code, in
14+
accordance with these policies. If any issues arise or compatibility breaks
15+
occur, please `report them in GitHub
16+
<https://github.com/pytorch/executorch/issues/new/choose>`__.
1317

1418
We welcome any feedback, suggestions, and bug reports from the community
1519
to help us improve the technology. Please use the `PyTorch Forums

docs/source/pte-file-format.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,13 @@ Optional ─┤ ├────────────────────
3131
└─ └───────────────────────────────────┘
3232
```
3333

34+
## Compatibility
35+
36+
See the [Runtime Compatibility Policy](
37+
https://github.com/pytorch/executorch/tree/main/runtime/COMPATIBILITY.md) for
38+
details about the compatibility guarantees between the `.pte` format and the
39+
ExecuTorch runtime.
40+
3441
## Headers
3542

3643
Program files can be recognized by the magic string at byte offset 4, beginning

runtime/COMPATIBILITY.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Runtime Compatibility Policy
2+
3+
This document will describe the compatibility guarantees between the [`.pte` file
4+
format](https://pytorch.org/executorch/stable/pte-file-format.html) and the
5+
ExecuTorch runtime.
6+
7+
> [!IMPORTANT]
8+
> The [canonical version of this document](https://github.com/pytorch/executorch/tree/main/runtime/COMPATIBILITY.md)
9+
> is in the `main` branch of the `pytorch/executorch` GitHub repo.

0 commit comments

Comments
 (0)