experiments/STT-tensorflow
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add guidance to documentation on when to use a callable for record_if.

Browse Source 
PiperOrigin-RevId: 348125528
Change-Id: I8716c0181341b571ec13ddf01bc9977952f1d8ed
This commit is contained in:
Ken Franko 2020-12-17 17:48:40 -08:00 committed by TensorFlower Gardener
parent c04bf06bfc
commit 19916f4328
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
tensorflow/python/ops/summary_ops_v2.py
View File

@ -126,7 +126,13 @@ def record_if(condition):
The provided value can be a python boolean, a scalar boolean Tensor, or
or a callable providing such a value; if a callable is passed it will be
invoked on-demand to determine whether summary writing will occur.
invoked on-demand to determine whether summary writing will occur. Note that
when calling record_if() in an eager mode context, if you intend to provide a
varying condition like `step % 100 == 0`, you must wrap this in a
callable to avoid immediate eager evaluation of the condition. In particular,
using a callable is the only way to have your condition evaluated as part of
the traced body of an @tf.function that is invoked from within the
`record_if()` context.
Args:
condition: can be True, False, a bool Tensor, or a callable providing such.