Skip to content

Commit 8235e9e

Browse files
authored
Add featured declated as 'to remove' in spec (#2341)
Was flagged to me that there were a few things explicitly denoted as "to be removed" in the spec. I've closed a few of these issues, and added the ones that are likely beneficial to the community to the list of deprecations.
1 parent 72722be commit 8235e9e

File tree

2 files changed

+15
-12
lines changed

2 files changed

+15
-12
lines changed

docs/spec.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1815,8 +1815,7 @@ the following IEEE-754 operations:
18151815

18161816
For floating-point element types with `compare_type = TOTALORDER`, the op
18171817
uses the combination of `totalOrder` and `compareQuietEqual` operations from
1818-
IEEE-754. This feature appears to be unused, so in the future, we are planning
1819-
to remove it ([#584](https://github.com/openxla/stablehlo/issues/584)).
1818+
IEEE-754.
18201819

18211820
For complex element types, lexicographic comparison of `(real, imag)` pairs is
18221821
performed using the provided `comparison_direction` and `compare_type`.
@@ -3988,8 +3987,6 @@ Applies a map function `computation` to `inputs` along the `dimensions` and
39883987
produces a `result` tensor.
39893988

39903989
More formally, `result[result_index] = computation(inputs...[result_index])`.
3991-
Note that `dimensions` are currently unused and will likely be removed in
3992-
the future ([#487](https://github.com/openxla/stablehlo/issues/487)).
39933990

39943991
#### Inputs
39953992

@@ -6554,6 +6551,7 @@ There are several StableHLO operations that were inherited from
65546551
[MHLO](https://github.com/openxla/xla/blob/d63deb9250b9c212445290bd08c6effb5b6d0a2b/xla/mlir_hlo/mhlo/IR/hlo_ops.td)
65556552
which are deprecated and on the way out of StableHLO. The full details on these
65566553
removals can be found in the [StableHLO v1.0 Cleanup #2283](https://github.com/openxla/stablehlo/pull/2283).
6554+
The tracker issue for these deprecations is [#2340](https://github.com/openxla/stablehlo/issues/2340).
65576555

65586556
These operations fall into a few categories:
65596557

@@ -6564,17 +6562,18 @@ These operations fall into a few categories:
65646562
([#3](https://github.com/openxla/stablehlo/issues/3)).
65656563
* Unused ops - These operations may have been useful at some point, but the ops
65666564
were either underdeveloped, or the pipelines using these ops have been
6567-
refactored to not require them anymore. This includes `map`, `tuple`,
6568-
`get_tuple_element`, and `rng`.
6565+
refactored to not require them anymore. This includes `map`, `tuple` ([#598](https://github.com/openxla/stablehlo/issues/598)),
6566+
`get_tuple_element`, `rng`, `complex` comparisons [#560](https://github.com/openxla/stablehlo/issues/560),
6567+
and convolution `window_reversal` ([#1181](https://github.com/openxla/stablehlo/issues/1181)).
65696568

65706569
Some of these ops can be removed easily given that they can be expressed using
65716570
existing ops (`broadcast`, `create_token`, `cross-replica-sum`, `dot`,
65726571
`unary_einsum`) and will be removed after the existing compatibilty window
65736572
passes (6 months). Others are still being explored for removal (`einsum`,
6574-
`get_tuple_element`, `map`, `rng` `torch_index_select`, `tuple`). Pending
6575-
community feedback, these ops will either be removed, or added to the spec with
6576-
full support. Until these ops futures are known, they are only guaranteed 6
6577-
months of compatibility.
6573+
`get_tuple_element`, `map`, `rng` `torch_index_select`, `tuple`, `complex`
6574+
comparisons, `window_reversal`). Pending community feedback,
6575+
these ops will either be removed, or added to the spec with full support. Until
6576+
these ops futures are known, they are only guaranteed 6 months of compatibility.
65786577

65796578
## Execution
65806579

rfcs/20240503-opset-deprecations.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# RFC: StableHLO v1.0 Opset Deprecations & Cleanups
22

33
Author: gleasonk<br/>
4-
Last Modified: 5/3/24<br/>
5-
Status: In review<br/>
4+
Last Modified: 5/13/24<br/>
5+
Status: Approved<br/>
66

77
## Background
88

@@ -23,6 +23,10 @@ opset updates: `real_dynamic_slice` vs `dynamic_slice`.
2323
and `map`.
2424
- Tuple Ops and type, including `get_tuple_element` and `tuple` op, along with
2525
`tuple` type support in `custom_call` ([#598](https://github.com/openxla/stablehlo/issues/598)).
26+
- Features explicitly denoted as "to be removed" in the spec, such as `tuple`
27+
type ([#598](https://github.com/openxla/stablehlo/issues/598)), comparisons of
28+
complex types ([#560](https://github.com/openxla/stablehlo/issues/560)), and
29+
`convolution` op's `window_reversal`, which are unreliable or unused.
2630

2731
In general (unless the op is unused and can be trivially deleted), the
2832
deprecation steps will be as follows:

0 commit comments

Comments
 (0)