commit 2e2765f0237ec05361bb93bb44d37126435f7782
author Fergus Henderson <fergus@google.com> Tue Sep 29 10:09:06 2020 -0700
committer TensorFlower Gardener <gardener@tensorflow.org> Tue Sep 29 10:31:48 2020 -0700
tree 792dcafbaac0f23a308a9d92ccbce2beb6b26459
parent eaa34f34ab8a2ca4899a2a60a43a09c169ef88a1

Add explicit documentation for each of the API functions in
c_api_experimental.h that they are experimental APIs and subject
to change.

PiperOrigin-RevId: 334404623
Change-Id: I6944997f451e83c4735a0dbd0d12420d6b7c45ba

tensorflow/lite/c/c_api_experimental.h

diff --git a/tensorflow/lite/c/c_api_experimental.h b/tensorflow/lite/c/c_api_experimental.h
index 8d635f3..bfbdd9c 100644
--- a/tensorflow/lite/c/c_api_experimental.h
+++ b/tensorflow/lite/c/c_api_experimental.h
@@ -24,6 +24,8 @@
 #endif  // __cplusplus
 
 /// Resets all variable tensors to zero.
+///
+/// WARNING: This is an experimental API and subject to change.
 TFL_CAPI_EXPORT extern TfLiteStatus TfLiteInterpreterResetVariableTensors(
     TfLiteInterpreter* interpreter);
 
@@ -39,6 +41,8 @@
 ///
 /// Code that uses this function should NOT call
 /// `TfLiteInterpreterOptionsSetOpResolver' on the same options object.
+///
+/// WARNING: This is an experimental API and subject to change.
 TFL_CAPI_EXPORT void TfLiteInterpreterOptionsAddBuiltinOp(
     TfLiteInterpreterOptions* options, TfLiteBuiltinOperator op,
     const TfLiteRegistration* registration, int32_t min_version,
@@ -56,6 +60,8 @@
 ///
 /// Code that uses this function should NOT call
 /// `TfLiteInterpreterOptionsSetOpResolver' on the same options object.
+///
+/// WARNING: This is an experimental API and subject to change.
 TFL_CAPI_EXPORT void TfLiteInterpreterOptionsAddCustomOp(
     TfLiteInterpreterOptions* options, const char* name,
     const TfLiteRegistration* registration, int32_t min_version,
@@ -72,6 +78,8 @@
 /// Code that uses this function should NOT call
 /// `TfLiteInterpreterOptionsAddBuiltin' or
 /// `TfLiteInterpreterOptionsAddCustomOp' on the same options object.
+///
+/// WARNING: This is an experimental API and subject to change.
 void TfLiteInterpreterOptionsSetOpResolver(
     TfLiteInterpreterOptions* options,
     const TfLiteRegistration* (*find_builtin_op)(void* user_data,
@@ -99,11 +107,15 @@
 ///
 /// NOTE: The client *must* explicitly allocate tensors before attempting to
 /// access input tensor data or invoke the interpreter.
+///
+/// WARNING: This is an experimental API and subject to change.
 TFL_CAPI_EXPORT extern TfLiteInterpreter*
 TfLiteInterpreterCreateWithSelectedOps(const TfLiteModel* model,
                                        const TfLiteInterpreterOptions* options);
 
 /// Enable or disable the NN API for the interpreter (true to enable).
+///
+/// WARNING: This is an experimental API and subject to change.
 TFL_CAPI_EXPORT extern void TfLiteInterpreterOptionsSetUseNNAPI(
     TfLiteInterpreterOptions* options, bool enable);