Skip to content

Commit

Permalink
Add placeholder runtime/COMPATIBILITY.md (#6316)
Browse files Browse the repository at this point in the history
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
(cherry picked from commit 6a27cd1)

Co-authored-by: Dave Bort <dbort@meta.com>
  • Loading branch information
pytorchbot and dbort authored Oct 17, 2024
1 parent 573ad96 commit ddee09f
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 5 deletions.
15 changes: 10 additions & 5 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@ Welcome to the ExecuTorch Documentation
=======================================

.. important::
This is an alpha release; the ExecuTorch APIs and the ``.pte`` binary format
may change in incompatible ways before stabilizing in a future beta release.
When deploying models, we currently recommend using a version of the runtime
built from the same git revision that was used to generate the ``.pte`` file.
Once the format has stabilized, this will no longer be necessary.
v0.4.0 is a beta release of ExecuTorch. As of this release, the API will
follow the `API Lifecycle and Deprecation Policy <api-life-cycle.html>`__,
and the ``.pte`` binary format will comply with the `Runtime Compatibility
Policy
<https://github.com/pytorch/executorch/tree/main/runtime/COMPATIBILITY.md>`__.
This helps ensure that application developers can update to the latest
version of ExecuTorch without breaking existing integration code, in
accordance with these policies. If any issues arise or compatibility breaks
occur, please `report them in GitHub
<https://github.com/pytorch/executorch/issues/new/choose>`__.

We welcome any feedback, suggestions, and bug reports from the community
to help us improve the technology. Please use the `PyTorch Forums
Expand Down
7 changes: 7 additions & 0 deletions docs/source/pte-file-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ Optional ─┤ ├────────────────────
└─ └───────────────────────────────────┘
```

## Compatibility

See the [Runtime Compatibility Policy](
https://github.com/pytorch/executorch/tree/main/runtime/COMPATIBILITY.md) for
details about the compatibility guarantees between the `.pte` format and the
ExecuTorch runtime.

## Headers

Program files can be recognized by the magic string at byte offset 4, beginning
Expand Down
9 changes: 9 additions & 0 deletions runtime/COMPATIBILITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Runtime Compatibility Policy

This document will describe the compatibility guarantees between the [`.pte` file
format](https://pytorch.org/executorch/stable/pte-file-format.html) and the
ExecuTorch runtime.

> [!IMPORTANT]
> The [canonical version of this document](https://github.com/pytorch/executorch/tree/main/runtime/COMPATIBILITY.md)
> is in the `main` branch of the `pytorch/executorch` GitHub repo.

0 comments on commit ddee09f

Please sign in to comment.