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

Commit 0737d6f

Browse files
author
Zhitao Li
committed
Document that we are moving to a v1 versioned API.
1 parent 05edaf9 commit 0737d6f

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

rfcs/20210307-tfx-api-artifact-compat.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,14 @@ The following decisions are provided for easy digestion:
8686
compatible within all 1.x releases, with the exception of:
8787
1. Experimental APIs: either with `experimental` in its symbol/path, or
8888
explicitly called out in PyDoc.
89-
1. We propose only use `__init__.py` for public APIs. PyDoc can be
90-
generated that way.
89+
1. All public Python and proto APIs from tfx will be moved to a
90+
`tfx.v1` module. While accessing old symbols from unversioned
91+
API module is still possible, we recommend all public users to use
92+
the stable public API whenever possible. This also enables TFX
93+
team to release future v2 APIs if we choose do so in the long
94+
future, although there is no concrete plan for that right now.
95+
TFX API docs on TensorFlow doc sites will be updated
96+
accordingly.
9197
2. Internal APIs: Any other API which is not covered by our public API
9298
rules listed above are considered internal to the library, even if
9399
they do not have "internal" or underscore prefix. These APIs should

0 commit comments

Comments
 (0)