Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add placeholder runtime/COMPATIBILITY.md #6316

Merged
merged 1 commit into from
Oct 17, 2024
Merged

Add placeholder runtime/COMPATIBILITY.md #6316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions docs/source/index.rst
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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.
Loading