Module: tf.contrib.deprecated

Module tf.contrib.deprecated

Non-core alias for the deprecated tf.X_summary ops.

For TensorFlow 1.0, we have re-organized the TensorFlow summary ops into a submodule, and made some semantic tweaks. The first thing to note is that we moved the APIs around as follows:

tf.scalar_summary -> tf.summary.scalar tf.histogram_summary -> tf.summary.histogram tf.audio_summary -> tf.image_summary -> tf.summary.image tf.merge_summary -> tf.summary.merge tf.merge_all_summaries -> tf.summary.merge_all

We think this is a cleaner API and will improve long-term discoverability and clarity of the TensorFlow API. However, we also took the opportunity to make an important change to how summary "tags" work. The "tag" of a summary is the string that is associated with the output data, i.e. the key for organizing the generated protobufs.

Previously, the tag was allowed to be any unique string, and had no relation to the summary op generating it, and no relation to the TensorFlow name system. This made it very difficult to write re-usable code that would add summary ops to the graph. If you had a function that would add summary ops, you would need to manually pass in a name scope to that function to create de-duplicated tags, otherwise your program would fail with a runtime error due to tag collision.

The new summary APIs under tf.summary throw away the "tag" as an independent concept; instead, the first argument is the node name. This means that summary tags now automatically inherit the surrounding TF name scope, and automatically are deduplicated if there is a conflict. However, now the only allowed characters are alphanumerics, underscores, and forward slashes. To make migration easier, the new APIs automatically convert illegal characters to underscores.

Just as an example, consider the following "before" and "after" code snippets:


def add_activation_summaries(v, scope): tf.scalar_summary("%s/fraction_of_zero" % scope, tf.nn.fraction_of_zero(v)) tf.histogram_summary("%s/activations" % scope, v)


def add_activation_summaries(v): tf.summary.scalar("fraction_of_zero", tf.nn.fraction_of_zero(v)) tf.summary.histogram("activations", v)

Now, so long as the add_activation_summaries function is called from within the right name scope, the behavior is the same.

Because this change does modify the behavior and could break tests, we can't automatically migrate usage to the new APIs. That is why we are making the old APIs temporarily available here at tf.contrib.deprecated.

In addition to the name change described above, there are two further changes to the new summary ops:

  • the "max_images" argument for tf.image_summary was renamed to "max_outputs for tf.summary.image
  • tf.scalar_summary accepted arbitrary tensors of tags and values. However, tf.summary.scalar requires a single scalar name and scalar value. In most cases, you can create tf.summary.scalars in a loop to get the same behavior

As before, TensorBoard will group charts by the top-level name scope. This may be inconvenient, since in the new summary ops the summary will inherit that name scope without user control. We plan to add more grouping mechanisms to TensorBoard, so it will be possible to specify the TensorBoard group for each summary via the summary API.


audio_summary(...): Outputs a Summary protocol buffer with audio. (deprecated)

histogram_summary(...): Outputs a Summary protocol buffer with a histogram. (deprecated)

image_summary(...): Outputs a Summary protocol buffer with images. (deprecated)

merge_all_summaries(...): Merges all summaries collected in the default graph. (deprecated)

merge_summary(...): Merges summaries. (deprecated)

scalar_summary(...): Outputs a Summary protocol buffer with scalar values. (deprecated)

Defined in tensorflow/contrib/deprecated/