Skip to content

Commit 1b26bb5

Browse files
authored
Merge pull request tensorflow#6463 from gunan/cp
Cherrypick doc updates to r0.12 branch.
2 parents c62a66b + 50bef44 commit 1b26bb5

File tree

4 files changed

+25
-18
lines changed

4 files changed

+25
-18
lines changed

tensorflow/contrib/learn/python/learn/monitors.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ def step_end(self, step, outputs):
6868
x, y, steps=2, batch_size=1, monitors=[example_monitor])
6969
```
7070
71+
## Ops
72+
7173
@@get_default_monitors
7274
@@BaseMonitor
7375
@@CaptureVariable

tensorflow/contrib/slim/python/slim/data/tfexample_decoder.py

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -273,9 +273,10 @@ def __init__(self, image_key=None, format_key=None, shape=None,
273273
is stored.
274274
format_key: the name of the TF-Example feature in which the image format
275275
is stored.
276-
shape: the output shape of the image. If provided, the image is reshaped
277-
accordingly. If left as None, no reshaping is done. A shape should be
278-
supplied only if all the stored images have the same shape.
276+
shape: the output shape of the image as 1-D `Tensor`
277+
[height, width, channels]. If provided, the image is reshaped
278+
accordingly. If left as None, no reshaping is done. A shape should
279+
be supplied only if all the stored images have the same shape.
279280
channels: the number of channels in the image.
280281
"""
281282
if not image_key:
@@ -300,11 +301,12 @@ def _decode(self, image_buffer, image_format):
300301
"""Decodes the image buffer.
301302
302303
Args:
303-
image_buffer: T tensor representing the encoded image tensor.
304+
image_buffer: The tensor representing the encoded image tensor.
304305
image_format: The image format for the image in `image_buffer`.
305306
306307
Returns:
307-
A decoder image.
308+
A tensor that represents decoded image of self._shape, or
309+
(?, ?, self._channels) if self._shape is not specified.
308310
"""
309311
def decode_png():
310312
return image_ops.decode_png(image_buffer, self._channels)
@@ -329,7 +331,8 @@ def decode_jpg():
329331
}
330332
default_decoder = decode_jpg
331333

332-
image = control_flow_ops.case(pred_fn_pairs, default=default_decoder, exclusive=True)
334+
image = control_flow_ops.case(
335+
pred_fn_pairs, default=default_decoder, exclusive=True)
333336

334337
image.set_shape([None, None, self._channels])
335338
if self._shape is not None:

tensorflow/g3doc/api_docs/python/contrib.learn.monitors.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ Example:
5858
x, y, steps=2, batch_size=1, monitors=[example_monitor])
5959
```
6060

61+
## Ops
62+
6163
- - -
6264

6365
### `tf.contrib.learn.monitors.get_default_monitors(loss_op=None, summary_op=None, save_summary_steps=100, output_dir=None, summary_writer=None)` {#get_default_monitors}

tensorflow/g3doc/get_started/os_setup.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ github source.
88
The TensorFlow Python API supports Python 2.7 and Python 3.3+.
99

1010
The GPU version works best with Cuda Toolkit 8.0 and
11-
cuDNN v5. Other versions are supported (Cuda toolkit >= 7.0 and
11+
cuDNN v5.1. Other versions are supported (Cuda toolkit >= 7.0 and
1212
cuDNN >= v3) only when installing from sources.
1313
Please see [Cuda installation](#optional-install-cuda-gpus-on-linux) for
14-
details. For Mac OS X, please see [Setup GPU for
15-
Mac](#optional-setup-gpu-for-mac).
14+
details. For Mac OS X, please see
15+
[Setup GPU for Mac](#optional-setup-gpu-for-mac).
1616

1717
## Overview
1818

@@ -43,8 +43,8 @@ If you encounter installation errors, see
4343
[Pip](https://en.wikipedia.org/wiki/Pip_(package_manager)) is a package
4444
management system used to install and manage software packages written in
4545
Python. We provide pip packages for TensorFlow on Linux, Mac OS X, and
46-
Windows. For Windows instructions, please see [Pip installation on
47-
Windows](#pip-installation-on-windows).
46+
Windows. For Windows instructions, please see
47+
[Pip installation on Windows](#pip-installation-on-windows).
4848

4949
The packages that will be installed or upgraded during the pip install are
5050
listed in the [REQUIRED_PACKAGES section of
@@ -507,7 +507,7 @@ the Docker container.
507507
### (Optional, Linux) Enable GPU Support
508508

509509
If you installed the GPU version of TensorFlow, you must also install the Cuda
510-
Toolkit 8.0 and cuDNN v5. Please see [Cuda
510+
Toolkit 8.0 and cuDNN v5.1. Please see [Cuda
511511
installation](#optional-install-cuda-gpus-on-linux).
512512

513513
You also need to set the `LD_LIBRARY_PATH` and `CUDA_HOME` environment
@@ -661,7 +661,7 @@ Install the toolkit into e.g. `/usr/local/cuda`.
661661

662662
[https://developer.nvidia.com/cudnn](https://developer.nvidia.com/cudnn)
663663

664-
Download cuDNN v5.
664+
Download cuDNN v5.1.
665665

666666
Uncompress and copy the cuDNN files into the toolkit directory. Assuming the
667667
toolkit is installed in `/usr/local/cuda`, run the following commands (edited
@@ -937,20 +937,20 @@ package:
937937

938938
```bash
939939
# Ubuntu/Linux 64-bit:
940-
$ pip install --upgrade https://storage.googleapis.com/tensorflow/linux/cpu/protobuf-3.0.0-cp27-none-linux_x86_64.whl
940+
$ pip install --upgrade https://storage.googleapis.com/tensorflow/linux/cpu/protobuf-3.1.0-cp27-none-linux_x86_64.whl
941941

942942
# Mac OS X:
943-
$ pip install --upgrade https://storage.googleapis.com/tensorflow/mac/cpu/protobuf-3.0.0-cp27-cp27m-macosx_10_11_x86_64.whl
943+
$ pip install --upgrade https://storage.googleapis.com/tensorflow/mac/cpu/protobuf-3.1.0-cp27-none-macosx_10_11_x86_64.whl
944944
```
945945

946946
And for Python 3.5:
947947

948948
```bash
949949
# Ubuntu/Linux 64-bit:
950-
$ pip3 install --upgrade https://storage.googleapis.com/tensorflow/linux/cpu/protobuf-3.0.0-cp35-cp35m-linux_x86_64.whl
950+
$ pip3 install --upgrade https://storage.googleapis.com/tensorflow/linux/cpu/protobuf-3.1.0-cp35-none-linux_x86_64.whl
951951

952952
# Mac OS X:
953-
$ pip3 install --upgrade https://storage.googleapis.com/tensorflow/mac/cpu/protobuf-3.0.0-cp35-cp35m-macosx_10_11_x86_64.whl
953+
$ pip3 install --upgrade https://storage.googleapis.com/tensorflow/mac/cpu/protobuf-3.1.0-cp35-none-macosx_10_11_x86_64.whl
954954
```
955955

956956
If your system/configuration is not listed above, you can use the following
@@ -1126,7 +1126,7 @@ Traceback (most recent call last):
11261126
TypeError: __init__() got an unexpected keyword argument 'syntax'
11271127
```
11281128

1129-
This is due to a conflict between protobuf versions (we require protobuf 3.0.0).
1129+
This is due to a conflict between protobuf versions (we require protobuf 3.1.0).
11301130
The best current solution is to make sure older versions of protobuf are not
11311131
installed, such as:
11321132

0 commit comments

Comments
 (0)