1- # tf._ internal API namespace
1+ # tf.\_\ _ internal\_\_ API namespace
22
33| Status | Accepted |
44:-------------- |:---------------------------------------------------- |
1010
1111## Objective
1212
13- Adding a new "_ internal" API namespace in TF to host APIs for framework building
13+ Adding a new "\_\ _ internal\_\_ " API namespace in TF to host APIs for framework building
1414/testing, etc. The API namespace will serve as a whitelist for client libraries
1515to gradually migrate off the usage tf private API symbol.
1616
@@ -38,7 +38,7 @@ framework-builders, but not typical TensorFlow users.
3838
3939## Design Proposal
4040
41- Add a new namespace "tensorflow._ internal" to host the framework building/
41+ Add a new namespace "tensorflow.\_\ _ internal\_\_ " to host the framework building/
4242testing related APIs that are currently used by other high level API in TF
4343(Keras, and estimator, etc.). This name space will be treated as a protected
4444API, which shouldn't be used by the end users. It will have no API contract
@@ -53,7 +53,7 @@ caused on the client side, TF must be aware who is using this API, so that any
5353changes to those API will be verified against the client code.
5454
5555### Acceptance Criteria
56- The candidate of the "_ internal" API should:
56+ The candidate of the "\_\ _ internal\_\_ " API should:
5757
58581 . Does NOT fit for core TF API, otherwise it should be exposed as core TF API.
59591 . Are currently used by other high level API to build/test/deploy a framework
@@ -96,12 +96,12 @@ and will discuss with the API owner on a case to case basis.
9696
9797| Symbol location | API Name |
9898:-------------- |:---------------------------------------------------- |
99- | python.framework.func_graph.FuncGraph | tf.internal .FuncGraph |
100- | python.framework.combinations.* | tf.internal .test.combinations.* |
101- | python.distribute.strategy_combinations.* | tf.internal .test.combinations.* |
102- | python.util.object_identity.* | tf.internal .object_identity.* |
103- | python.util.tf_decorator.TFDecorator| tf.internal .decorator.TFDecorator |
104- | python.util.tf_decorator.unwrap| tf.internal .inspect.unwrap |
99+ | python.framework.func_graph.FuncGraph | tf.\_\_ internal \_\_ .FuncGraph |
100+ | python.framework.combinations.* | tf.\_\_ internal \_\_ .test.combinations.* |
101+ | python.distribute.strategy_combinations.* | tf.\_\_ internal \_\_ .test.combinations.* |
102+ | python.util.object_identity.* | tf.\_\_ internal \_\_ .object_identity.* |
103+ | python.util.tf_decorator.TFDecorator| tf.\_\_ internal \_\_ .decorator.TFDecorator |
104+ | python.util.tf_decorator.unwrap| tf.\_\_ internal \_\_ .inspect.unwrap |
105105
106106### Alternative Names
1071071 . <b >"tf.internal"</b >: It gives the user the impression that this is not a
@@ -110,5 +110,5 @@ and will discuss with the API owner on a case to case basis.
1101101 . <b >"tf.infra"</b >: infrastructure is aligned with "building blocks" and low
111111 level functionalities, like file system/network etc. So far, the APIs we want
112112 to add are still high level APIs and utility functions.
113- 1 . By Martin <b >"tf.\_ internal"</b >: the extra "_ " emphasis in the pythonic way
113+ 1 . By Martin <b >"tf.\_\ _ internal\_\_ "</b >: the extra "_ " emphasis in the pythonic way
114114 that this is for private usage.
0 commit comments