Add docstring pointing to tf.contrib.quantize.
authorSuharsh Sivakumar <suharshs@google.com>
Tue, 20 Mar 2018 00:56:02 +0000 (17:56 -0700)
committerTensorFlower Gardener <gardener@tensorflow.org>
Tue, 20 Mar 2018 01:00:04 +0000 (18:00 -0700)
PiperOrigin-RevId: 189672549

tensorflow/python/training/quantize_training.i

index 17ffcd6..fb5e47e 100644 (file)
@@ -56,6 +56,11 @@ PyObject* DoQuantizeTrainingOnGraphDefHelper(
 
 %insert("python") %{
 def do_quantize_training_on_graphdef(input_graph, num_bits):
+  """A general quantization scheme is being developed in @{tf.contrib.quantize}.
+
+  Consider using that instead, though since it is in the tf.contrib namespace,
+  it is not subject to backward compatibility guarantees.
+  """
   from tensorflow.core.framework.graph_pb2 import GraphDef
   from tensorflow.python.framework import errors
   with errors.raise_exception_on_not_ok_status() as status: