aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/g3doc
diff options
context:
space:
mode:
authorGravatar A. Unique TensorFlower <gardener@tensorflow.org>2016-10-13 15:08:11 -0800
committerGravatar TensorFlower Gardener <gardener@tensorflow.org>2016-10-13 16:19:53 -0700
commit8bc3020c0c0113d3349cb5cdbfc6146ae8c28ce9 (patch)
tree0a5a9ebec683502da60ab935ce9f38164f1f2537 /tensorflow/g3doc
parent168c47171f40a652349debbabc0388cd1fae87d3 (diff)
Update generated Python Op docs.
Change: 136099185
Diffstat (limited to 'tensorflow/g3doc')
-rw-r--r--tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.summary.tensor_summary.md15
-rw-r--r--tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.summary.scalar.md10
-rw-r--r--tensorflow/g3doc/api_docs/python/summary.md25
3 files changed, 16 insertions, 34 deletions
diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.summary.tensor_summary.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.summary.tensor_summary.md
index 61f16181b5..3fb19c2601 100644
--- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.summary.tensor_summary.md
+++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.summary.tensor_summary.md
@@ -1,4 +1,4 @@
-### `tf.summary.tensor_summary(display_name, tensor, description='', labels=None, collections=None, name=None)` {#tensor_summary}
+### `tf.summary.tensor_summary(name, tensor, summary_description=None, collections=None)` {#tensor_summary}
Outputs a `Summary` protocol buffer with a serialized tensor.proto.
@@ -9,19 +9,12 @@ has one summary value containing the input tensor.
##### Args:
-* <b>`display_name`</b>: A name to associate with the data series. Will be used to
- organize output data and as a name in visualizers.
+* <b>`name`</b>: A name for the generated node. Will also serve as the series name in
+ TensorBoard.
* <b>`tensor`</b>: A tensor of any type and shape to serialize.
-* <b>`description`</b>: An optional long description of the data being output.
-* <b>`labels`</b>: a list of strings used to specify how the data can be interpreted,
- for example:
- * `'encoding:image/jpg'` for a string tensor containing jpg images
- * `'encoding:proto/X/Y/foo.proto'` for a string tensor containing Foos
- * `'group:$groupName/$roleInGroup'` for a tensor that is related to
- other tensors that are all in a group. (e.g. bounding boxes and images)
+* <b>`summary_description`</b>: Optional summary_pb2.SummaryDescription()
* <b>`collections`</b>: Optional list of graph collections keys. The new summary op is
added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
-* <b>`name`</b>: An optional name for the generated node (optional).
##### Returns:
diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.summary.scalar.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.summary.scalar.md
index 020c9c060d..979cc1840c 100644
--- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.summary.scalar.md
+++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.summary.scalar.md
@@ -1,4 +1,4 @@
-### `tf.summary.scalar(display_name, tensor, description='', labels=None, collections=None, name=None)` {#scalar}
+### `tf.summary.scalar(name, tensor, summary_description=None, collections=None)` {#scalar}
Outputs a `Summary` protocol buffer containing a single scalar value.
@@ -7,14 +7,12 @@ The generated Summary has a Tensor.proto containing the input Tensor.
##### Args:
-* <b>`display_name`</b>: A name to associate with the data series. Will be used to
- organize output data and as a name in visualizers.
+* <b>`name`</b>: A name for the generated node. Will also serve as the series name in
+ TensorBoard.
* <b>`tensor`</b>: A tensor containing a single floating point or integer value.
-* <b>`description`</b>: An optional long description of the data being output.
-* <b>`labels`</b>: a list of strings used to attach metadata.
+* <b>`summary_description`</b>: Optional summary_description_pb2.SummaryDescription
* <b>`collections`</b>: Optional list of graph collections keys. The new summary op is
added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
-* <b>`name`</b>: An optional name for the generated node (optional).
##### Returns:
diff --git a/tensorflow/g3doc/api_docs/python/summary.md b/tensorflow/g3doc/api_docs/python/summary.md
index 14dac8117f..4fbc65c0cf 100644
--- a/tensorflow/g3doc/api_docs/python/summary.md
+++ b/tensorflow/g3doc/api_docs/python/summary.md
@@ -8,7 +8,7 @@ This module contains ops for generating summaries.
## Summary Ops
- - -
-### `tf.summary.tensor_summary(display_name, tensor, description='', labels=None, collections=None, name=None)` {#tensor_summary}
+### `tf.summary.tensor_summary(name, tensor, summary_description=None, collections=None)` {#tensor_summary}
Outputs a `Summary` protocol buffer with a serialized tensor.proto.
@@ -19,19 +19,12 @@ has one summary value containing the input tensor.
##### Args:
-* <b>`display_name`</b>: A name to associate with the data series. Will be used to
- organize output data and as a name in visualizers.
+* <b>`name`</b>: A name for the generated node. Will also serve as the series name in
+ TensorBoard.
* <b>`tensor`</b>: A tensor of any type and shape to serialize.
-* <b>`description`</b>: An optional long description of the data being output.
-* <b>`labels`</b>: a list of strings used to specify how the data can be interpreted,
- for example:
- * `'encoding:image/jpg'` for a string tensor containing jpg images
- * `'encoding:proto/X/Y/foo.proto'` for a string tensor containing Foos
- * `'group:$groupName/$roleInGroup'` for a tensor that is related to
- other tensors that are all in a group. (e.g. bounding boxes and images)
+* <b>`summary_description`</b>: Optional summary_pb2.SummaryDescription()
* <b>`collections`</b>: Optional list of graph collections keys. The new summary op is
added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
-* <b>`name`</b>: An optional name for the generated node (optional).
##### Returns:
@@ -41,7 +34,7 @@ has one summary value containing the input tensor.
- - -
-### `tf.summary.scalar(display_name, tensor, description='', labels=None, collections=None, name=None)` {#scalar}
+### `tf.summary.scalar(name, tensor, summary_description=None, collections=None)` {#scalar}
Outputs a `Summary` protocol buffer containing a single scalar value.
@@ -50,14 +43,12 @@ The generated Summary has a Tensor.proto containing the input Tensor.
##### Args:
-* <b>`display_name`</b>: A name to associate with the data series. Will be used to
- organize output data and as a name in visualizers.
+* <b>`name`</b>: A name for the generated node. Will also serve as the series name in
+ TensorBoard.
* <b>`tensor`</b>: A tensor containing a single floating point or integer value.
-* <b>`description`</b>: An optional long description of the data being output.
-* <b>`labels`</b>: a list of strings used to attach metadata.
+* <b>`summary_description`</b>: Optional summary_description_pb2.SummaryDescription
* <b>`collections`</b>: Optional list of graph collections keys. The new summary op is
added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
-* <b>`name`</b>: An optional name for the generated node (optional).
##### Returns: