aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/g3doc/api_docs/python/image.md
diff options
context:
space:
mode:
authorGravatar A. Unique TensorFlower <gardener@tensorflow.org>2016-12-08 20:22:11 -0800
committerGravatar TensorFlower Gardener <gardener@tensorflow.org>2016-12-08 20:45:00 -0800
commit4a29f9f6a0fe185591c8d7255d330eb4361e60cf (patch)
tree7395785f7d4e59f6270b3ce56dcd010d34dcab54 /tensorflow/g3doc/api_docs/python/image.md
parent2709e16b98d429b94e0f4598e1f59941a3210642 (diff)
Update generated Python Op docs.
Change: 141516835
Diffstat (limited to 'tensorflow/g3doc/api_docs/python/image.md')
-rw-r--r--tensorflow/g3doc/api_docs/python/image.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/tensorflow/g3doc/api_docs/python/image.md b/tensorflow/g3doc/api_docs/python/image.md
index e000be1151..61df08b48f 100644
--- a/tensorflow/g3doc/api_docs/python/image.md
+++ b/tensorflow/g3doc/api_docs/python/image.md
@@ -216,6 +216,36 @@ the smallest output, but is slower.
+- - -
+
+### `tf.image.decode_image(contents, channels=None, name=None)` {#decode_image}
+
+Convenience function for `decode_gif`, `decode_jpeg`, and `decode_png`.
+Detects whether an image is a GIF, JPEG, or PNG, and performs the appropriate
+operation to convert the input bytes `string` into a `Tensor` of type `uint8`.
+
+Note: `decode_gif` returns a 4-D array `[num_frames, height, width, 3]`, as
+opposed to `decode_jpeg` and `decode_png`, which return 3-D arrays
+`[height, width, num_channels]`. Make sure to take this into account when
+constructing your graph if you are intermixing GIF files with JPEG and/or PNG
+files.
+
+##### Args:
+
+
+* <b>`contents`</b>: 0-D `string`. The encoded image bytes.
+* <b>`channels`</b>: An optional `int`. Defaults to `0`. Number of color channels for
+ the decoded image.
+* <b>`name`</b>: A name for the operation (optional)
+
+##### Returns:
+
+ `Tensor` with type `uint8` with shape `[height, width, num_channels]` for
+ JPEG and PNG images and shape `[num_frames, height, width, 3]` for GIF
+ images.
+
+
+
## Resizing
The resizing Ops accept input images as tensors of several types. They always