From 6834af5c459171d7551f6e8b812adeff5a833b5e Mon Sep 17 00:00:00 2001 From: "A. Unique TensorFlower" Date: Sun, 31 Jul 2016 22:33:27 -0800 Subject: [PATCH] Update generated Python Op docs. Change: 128959704 --- .../g3doc/api_docs/python/control_flow_ops.md | 24 ++++++++++++++++ .../functions_and_classes/shard0/tf.mod.md | 3 ++ .../functions_and_classes/shard0/tf.mul.md | 3 ++ .../shard0/tf.not_equal.md | 3 ++ .../shard1/tf.greater_equal.md | 3 ++ .../shard2/tf.minimum.md | 5 +++- .../shard4/tf.greater.md | 3 ++ .../functions_and_classes/shard4/tf.sub.md | 3 ++ .../functions_and_classes/shard5/tf.add.md | 3 +- .../functions_and_classes/shard5/tf.div.md | 3 ++ .../shard5/tf.logical_and.md | 3 ++ .../shard6/tf.maximum.md | 5 +++- .../functions_and_classes/shard7/tf.less.md | 3 ++ .../shard7/tf.logical_or.md | 3 ++ .../functions_and_classes/shard8/tf.equal.md | 3 ++ .../shard8/tf.less_equal.md | 3 ++ .../shard9/tf.nn.rnn_cell.RNNCell.md | 5 ++++ .../shard9/tf.squared_difference.md | 3 ++ tensorflow/g3doc/api_docs/python/math_ops.md | 28 +++++++++++++++++-- tensorflow/g3doc/api_docs/python/rnn_cell.md | 5 ++++ tensorflow/g3doc/api_docs/python/train.md | 2 +- 21 files changed, 109 insertions(+), 7 deletions(-) diff --git a/tensorflow/g3doc/api_docs/python/control_flow_ops.md b/tensorflow/g3doc/api_docs/python/control_flow_ops.md index 579633aa3b8..9a92c60b850 100644 --- a/tensorflow/g3doc/api_docs/python/control_flow_ops.md +++ b/tensorflow/g3doc/api_docs/python/control_flow_ops.md @@ -361,6 +361,9 @@ to your graph. Returns the truth value of x AND y element-wise. +*NOTE*: `LogicalAnd` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: @@ -396,6 +399,9 @@ Returns the truth value of NOT x element-wise. Returns the truth value of x OR y element-wise. +*NOTE*: `LogicalOr` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: @@ -427,6 +433,9 @@ operators to your graph. Returns the truth value of (x == y) element-wise. +*NOTE*: `Equal` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: @@ -445,6 +454,9 @@ Returns the truth value of (x == y) element-wise. Returns the truth value of (x != y) element-wise. +*NOTE*: `NotEqual` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: @@ -463,6 +475,9 @@ Returns the truth value of (x != y) element-wise. Returns the truth value of (x < y) element-wise. +*NOTE*: `Less` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: @@ -481,6 +496,9 @@ Returns the truth value of (x < y) element-wise. Returns the truth value of (x <= y) element-wise. +*NOTE*: `LessEqual` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: @@ -499,6 +517,9 @@ Returns the truth value of (x <= y) element-wise. Returns the truth value of (x > y) element-wise. +*NOTE*: `Greater` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: @@ -517,6 +538,9 @@ Returns the truth value of (x > y) element-wise. Returns the truth value of (x >= y) element-wise. +*NOTE*: `GreaterEqual` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.mod.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.mod.md index 5bfe1058a77..86978890b5a 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.mod.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.mod.md @@ -2,6 +2,9 @@ Returns element-wise remainder of division. +*NOTE*: `Mod` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.mul.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.mul.md index 3d6fa568645..2efd16e8915 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.mul.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.mul.md @@ -2,6 +2,9 @@ Returns x * y element-wise. +*NOTE*: `Mul` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.not_equal.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.not_equal.md index 9c187922232..5ed8df49d5c 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.not_equal.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.not_equal.md @@ -2,6 +2,9 @@ Returns the truth value of (x != y) element-wise. +*NOTE*: `NotEqual` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.greater_equal.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.greater_equal.md index 9d68429c36c..d6ce057c133 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.greater_equal.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.greater_equal.md @@ -2,6 +2,9 @@ Returns the truth value of (x >= y) element-wise. +*NOTE*: `GreaterEqual` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.minimum.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.minimum.md index bff13483f4d..9bcd03f6e78 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.minimum.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.minimum.md @@ -1,6 +1,9 @@ ### `tf.minimum(x, y, name=None)` {#minimum} -Returns the min of x and y (i.e. x < y ? x : y) element-wise, broadcasts. +Returns the min of x and y (i.e. x < y ? x : y) element-wise. + +*NOTE*: `Minimum` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.greater.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.greater.md index c629a0286f3..99b34aaca47 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.greater.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.greater.md @@ -2,6 +2,9 @@ Returns the truth value of (x > y) element-wise. +*NOTE*: `Greater` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.sub.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.sub.md index 2d1da0f0b98..83dbd7a93c8 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.sub.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.sub.md @@ -2,6 +2,9 @@ Returns x - y element-wise. +*NOTE*: `Sub` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.add.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.add.md index 738f0337d30..da82da60762 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.add.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.add.md @@ -2,7 +2,8 @@ Returns x + y element-wise. -*NOTE*: Add supports broadcasting. AddN does not. +*NOTE*: `Add` supports broadcasting. `AddN` does not. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.div.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.div.md index 92eba7927a0..61616c0e6b2 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.div.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.div.md @@ -2,6 +2,9 @@ Returns x / y element-wise. +*NOTE*: `Div` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.logical_and.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.logical_and.md index dd5b563c8ba..2b5f011ccdc 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.logical_and.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.logical_and.md @@ -2,6 +2,9 @@ Returns the truth value of x AND y element-wise. +*NOTE*: `LogicalAnd` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.maximum.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.maximum.md index 309946f4352..aec816dcbad 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.maximum.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.maximum.md @@ -1,6 +1,9 @@ ### `tf.maximum(x, y, name=None)` {#maximum} -Returns the max of x and y (i.e. x > y ? x : y) element-wise, broadcasts. +Returns the max of x and y (i.e. x > y ? x : y) element-wise. + +*NOTE*: `Maximum` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.less.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.less.md index 8791d0366aa..3a00afa8db5 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.less.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.less.md @@ -2,6 +2,9 @@ Returns the truth value of (x < y) element-wise. +*NOTE*: `Less` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.logical_or.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.logical_or.md index be18e65e92e..e04b6a15d2c 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.logical_or.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.logical_or.md @@ -2,6 +2,9 @@ Returns the truth value of x OR y element-wise. +*NOTE*: `LogicalOr` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.equal.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.equal.md index 998db9189ff..332a12f7255 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.equal.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.equal.md @@ -2,6 +2,9 @@ Returns the truth value of (x == y) element-wise. +*NOTE*: `Equal` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.less_equal.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.less_equal.md index 65d7eb50842..c8ce84b6691 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.less_equal.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.less_equal.md @@ -2,6 +2,9 @@ Returns the truth value of (x <= y) element-wise. +*NOTE*: `LessEqual` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.nn.rnn_cell.RNNCell.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.nn.rnn_cell.RNNCell.md index 5ecf4e515fe..ab13073fd5d 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.nn.rnn_cell.RNNCell.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.nn.rnn_cell.RNNCell.md @@ -1,5 +1,10 @@ Abstract object representing an RNN cell. +The definition of cell in this package differs from the definition used in the +literature. In the literature, cell refers to an object with a single scalar +output. The definition in this package refers to a horizontal array of such +units. + An RNN cell, in the most abstract setting, is anything that has a state and performs some operation that takes a matrix of inputs. This operation results in an output matrix with `self.output_size` columns. diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.squared_difference.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.squared_difference.md index d6bb175669c..19f25f473da 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.squared_difference.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.squared_difference.md @@ -2,6 +2,9 @@ Returns (x - y)(x - y) element-wise. +*NOTE*: `SquaredDifference` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/math_ops.md b/tensorflow/g3doc/api_docs/python/math_ops.md index 4a9ead85023..05379613268 100644 --- a/tensorflow/g3doc/api_docs/python/math_ops.md +++ b/tensorflow/g3doc/api_docs/python/math_ops.md @@ -21,7 +21,8 @@ operators to your graph. Returns x + y element-wise. -*NOTE*: Add supports broadcasting. AddN does not. +*NOTE*: `Add` supports broadcasting. `AddN` does not. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) ##### Args: @@ -41,6 +42,9 @@ Returns x + y element-wise. Returns x - y element-wise. +*NOTE*: `Sub` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: @@ -59,6 +63,9 @@ Returns x - y element-wise. Returns x * y element-wise. +*NOTE*: `Mul` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: @@ -77,6 +84,9 @@ Returns x * y element-wise. Returns x / y element-wise. +*NOTE*: `Div` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: @@ -164,6 +174,9 @@ as well. Returns element-wise remainder of division. +*NOTE*: `Mod` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: @@ -504,7 +517,10 @@ Returns element-wise largest integer not greater than x. ### `tf.maximum(x, y, name=None)` {#maximum} -Returns the max of x and y (i.e. x > y ? x : y) element-wise, broadcasts. +Returns the max of x and y (i.e. x > y ? x : y) element-wise. + +*NOTE*: `Maximum` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) ##### Args: @@ -522,7 +538,10 @@ Returns the max of x and y (i.e. x > y ? x : y) element-wise, broadcasts. ### `tf.minimum(x, y, name=None)` {#minimum} -Returns the min of x and y (i.e. x < y ? x : y) element-wise, broadcasts. +Returns the min of x and y (i.e. x < y ? x : y) element-wise. + +*NOTE*: `Minimum` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) ##### Args: @@ -749,6 +768,9 @@ Computes the complementary error function of `x` element-wise. Returns (x - y)(x - y) element-wise. +*NOTE*: `SquaredDifference` supports broadcasting. More about broadcasting +[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) + ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/rnn_cell.md b/tensorflow/g3doc/api_docs/python/rnn_cell.md index 94b48f5d416..5fcbd27966a 100644 --- a/tensorflow/g3doc/api_docs/python/rnn_cell.md +++ b/tensorflow/g3doc/api_docs/python/rnn_cell.md @@ -13,6 +13,11 @@ Module for constructing RNN Cells. Abstract object representing an RNN cell. +The definition of cell in this package differs from the definition used in the +literature. In the literature, cell refers to an object with a single scalar +output. The definition in this package refers to a horizontal array of such +units. + An RNN cell, in the most abstract setting, is anything that has a state and performs some operation that takes a matrix of inputs. This operation results in an output matrix with `self.output_size` columns. diff --git a/tensorflow/g3doc/api_docs/python/train.md b/tensorflow/g3doc/api_docs/python/train.md index 792fb2bcb78..1a98ead371f 100644 --- a/tensorflow/g3doc/api_docs/python/train.md +++ b/tensorflow/g3doc/api_docs/python/train.md @@ -851,7 +851,7 @@ learning_rate = tf.train.exponential_decay(starter_learning_rate, global_step, 100000, 0.96, staircase=True) # Passing global_step to minimize() will increment it at each step. learning_step = ( - tf.GradientDescentOptimizer(learning_rate) + tf.train.GradientDescentOptimizer(learning_rate) .minimize(...my loss..., global_step=global_step) ) ```