Skip to content

Commit 797bee2

Browse files
authored
Add StableHLO v1.0 Compatibility Updates (#2342)
Update compatibility.md to include the latest compatibility window for StableHLO v1.0. Also include link on readme to StableHLO's on-device use which utilizes these longer compatibility guarantees.
1 parent 8235e9e commit 797bee2

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ between frameworks and compilers, even as StableHLO continues to evolve.
1919

2020
This repository includes the [StableHLO specification](docs/spec.md)
2121
along with an MLIR-based implementation in C++ and Python, which you can use to
22-
define StableHLO programs for consumption by compilers such as XLA and IREE.
22+
define StableHLO programs for consumption by compilers such as XLA and IREE, as
23+
well as on-device use via [Google AI Edge](https://github.com/google-ai-edge/).
2324

2425
## Build instructions
2526

docs/compatibility.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,25 @@ that StableHLO provides, based on the process established in
1010
The current version of StableHLO can be found in
1111
[Version.h](https://github.com/openxla/stablehlo/blob/main/stablehlo/dialect/Version.h#:~:text=getCurrentVersion).
1212

13-
In the 0.x.x series, the minor version is bumped every time changes to
14-
the StableHLO opset or
13+
The minor version is bumped every time changes to the StableHLO opset or
1514
[the StableHLO serialization format](bytecode.md) are made, and the patch
1615
version is bumped every time we integrate StableHLO downstream, i.e. into the
1716
openxla/xla repository.
1817

1918
## Guarantees
2019

21-
**6 months of backward compatibility:** Portable artifacts serialized by an old
20+
Per the [StableHLO v1.0 Compatibility RFC](https://github.com/openxla/stablehlo/blob/main/rfcs/20230623-compatibility.md),
21+
the compatibility window includes the following:
22+
23+
**5 years of backward compatibility:** Portable artifacts serialized by an old
2224
version of libStablehlo have the same semantics* when deserialized by a new
2325
version of libStablehlo if these versions are built from openxla/stablehlo
24-
commits which are less than 6 months apart.
26+
commits which are less than 5 years apart.
2527

26-
**1 month of forward compatibility:** Portable artifacts serialized by a new
28+
**2 years of forward compatibility:** Portable artifacts serialized by a new
2729
version of libStablehlo have the same semantics* when deserialized by an old
2830
version of libStablehlo if these versions are built from openxla/stablehlo
29-
commits which are less than 1 month apart, unless the program is using new
31+
commits which are less than 2 years apart, unless the program is using new
3032
features introduced since the old version.
3133

3234
\* StableHLO programs are converted to/from portable artifacts via

0 commit comments

Comments
 (0)