Skip to content
This repository was archived by the owner on Jul 10, 2025. It is now read-only.

Commit cd8f9ca

Browse files
alextpmartinwicke
authored andcommitted
reference experimental section from other places
1 parent eb15bc4 commit cd8f9ca

File tree

1 file changed

+3
-12
lines changed

1 file changed

+3
-12
lines changed

governance/api-reviews.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ We avoid backwards-incompatible API changes. We also avoid
2424
backwards-incompatible behavior changes, such as restricting the set of valid
2525
inputs to a function or extending the set of valid outputs of a function. Adding
2626
support for previously not supported behavior is okay, as are changes to
27-
explicitly experimental APIs (within reason). When needing to provide a new or
28-
different behavior, we strongly prefer a new version of the API over breaking
27+
explicitly experimental APIs (see section below). When needing to provide a new
28+
or different behavior, we strongly prefer a new version of the API over breaking
2929
backwards compatibility. Note that we are free to deprecate APIs; we just cannot
3030
break code which relies on their documented behavior. We need to worry about
3131
backward compatibility both of our python APIs and of the serialized GraphDefs,
@@ -37,15 +37,6 @@ produced by currently correct python code without a three weeks notice. This
3737
comes up most frequently when adding new ops, but also applies to non-obvious
3838
things such as the graph emitted by gradients or pfor.
3939

40-
Including the name “experimental” in an API endpoint allows you to break
41-
backwards compatibility in the future, as noted above. However, we still prefer
42-
to mark the experimental API as deprecated for one release before removing it in
43-
the subsequent release. Please do not use the experimental namespace as an
44-
escape hatch for bad code or functionality you
45-
don’t-really-want-but-need-for-now; experimental APIs should be APIs that we
46-
intend to make standard in the near future, but have some lingering questions to
47-
resolve first.
48-
4940

5041
### Docstrings
5142

@@ -89,7 +80,7 @@ the next. We would like new experimental symbols to be things which will
8980
eventually end up in core TF as opposed to things we expect will be phased out
9081
with no clear replacement. The best expectation to have for an experimental
9182
endpoint is that the “experimental” will simply be removed. If you don’t believe
92-
that’ll work, it should probably not be added in its current form.
83+
that’ll work, it should probably not be added in its current form.
9384

9485
### Style
9586

0 commit comments

Comments
 (0)