aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/contrib/kfac
diff options
context:
space:
mode:
authorGravatar Vikram Tankasali <tvikram@google.com>2018-06-04 05:40:33 -0700
committerGravatar TensorFlower Gardener <gardener@tensorflow.org>2018-06-04 05:43:19 -0700
commit92415c09b8d00f200429e994b08e302f4ca85e67 (patch)
tree0da0d4c97b2b1785fc47afe390a70b830818c1c7 /tensorflow/contrib/kfac
parent5b498d5d759aa0545990e20778884b465eeb1ad3 (diff)
Update README.md for tf.contrib.kfac and add deprecation warning.
PiperOrigin-RevId: 199119904
Diffstat (limited to 'tensorflow/contrib/kfac')
-rw-r--r--tensorflow/contrib/kfac/README.md5
-rw-r--r--tensorflow/contrib/kfac/python/ops/optimizer.py6
2 files changed, 11 insertions, 0 deletions
diff --git a/tensorflow/contrib/kfac/README.md b/tensorflow/contrib/kfac/README.md
index 762a2f0b57..102626925d 100644
--- a/tensorflow/contrib/kfac/README.md
+++ b/tensorflow/contrib/kfac/README.md
@@ -1,5 +1,10 @@
# K-FAC: Kronecker-Factored Approximate Curvature
+# <font color="red", size=10><u>WARNING: </u></font>
+# ==third_party/tensorflow/contrib/kfac is deprecated. This will be==
+# ==removed on 15-07-2018. <!-- STY:begin_strip_and_replace -->Please import third_party/tensorflow_kfac.==
+# ==<!-- STY:end_strip_and_replace Please check https://github.com/tensorflow/kfac. -->==
+
**K-FAC in TensorFlow** is an implementation of [K-FAC][kfac-paper], an
approximate second-order optimization method, in TensorFlow. When applied to
feedforward and convolutional neural networks, K-FAC can converge `>3.5x`
diff --git a/tensorflow/contrib/kfac/python/ops/optimizer.py b/tensorflow/contrib/kfac/python/ops/optimizer.py
index b7f63d8d94..03b9da7933 100644
--- a/tensorflow/contrib/kfac/python/ops/optimizer.py
+++ b/tensorflow/contrib/kfac/python/ops/optimizer.py
@@ -18,6 +18,8 @@ from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
+import warnings
+
# pylint disable=long-line
from tensorflow.contrib.kfac.python.ops import curvature_matrix_vector_products as cmvp
from tensorflow.contrib.kfac.python.ops import estimator as est
@@ -107,6 +109,10 @@ class KfacOptimizer(gradient_descent.GradientDescentOptimizer):
ValueError: If momentum is non-zero and momentum_type is not 'regular'
or 'adam'.
"""
+ warnings.warn(
+ "third_party.tensorflow.contrib.kfac is deprecated."
+ "This will be removed on 15-07-2018. Check README for further details.",
+ DeprecationWarning)
# Parameters to be passed to the Fisher estimator:
self._variables = var_list or tf_variables.trainable_variables
self._cov_ema_decay = cov_ema_decay