Skip to content

Commit

Permalink
Update generated Python Op docs.
Browse files Browse the repository at this point in the history
Change: 138702302
  • Loading branch information
tensorflower-gardener committed Nov 10, 2016
1 parent 38aec86 commit 463fd91
Show file tree
Hide file tree
Showing 16 changed files with 286 additions and 14 deletions.
8 changes: 4 additions & 4 deletions tensorflow/g3doc/api_docs/python/framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -1460,7 +1460,7 @@ Returns x / y element-wise.

#### `tf.Output.__floordiv__(x, y)` {#Output.__floordiv__}

Divides `x / y` elementwise, rounding down for floating point.
Divides `x / y` elementwise, rounding toward the most negative integer.

The same as `tf.div(x,y)` for integers, but uses `tf.floor(tf.div(x,y))` for
floating point arguments so that the result is always an integer (though
Expand Down Expand Up @@ -1880,7 +1880,7 @@ Returns x / y element-wise.

#### `tf.Output.__rfloordiv__(y, x)` {#Output.__rfloordiv__}

Divides `x / y` elementwise, rounding down for floating point.
Divides `x / y` elementwise, rounding toward the most negative integer.

The same as `tf.div(x,y)` for integers, but uses `tf.floor(tf.div(x,y))` for
floating point arguments so that the result is always an integer (though
Expand Down Expand Up @@ -2460,7 +2460,7 @@ Returns x / y element-wise.

#### `tf.Tensor.__floordiv__(x, y)` {#Tensor.__floordiv__}

Divides `x / y` elementwise, rounding down for floating point.
Divides `x / y` elementwise, rounding toward the most negative integer.

The same as `tf.div(x,y)` for integers, but uses `tf.floor(tf.div(x,y))` for
floating point arguments so that the result is always an integer (though
Expand Down Expand Up @@ -2880,7 +2880,7 @@ Returns x / y element-wise.

#### `tf.Tensor.__rfloordiv__(y, x)` {#Tensor.__rfloordiv__}

Divides `x / y` elementwise, rounding down for floating point.
Divides `x / y` elementwise, rounding toward the most negative integer.

The same as `tf.div(x,y)` for integers, but uses `tf.floor(tf.div(x,y))` for
floating point arguments so that the result is always an integer (though
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
### `tf.floormod(x, y, name=None)` {#floormod}

Returns element-wise remainder of division. When `x < 0` xor `y < 0` is

true, this follows Python semantics in that the result here is consistent
with a flooring divide. E.g. `floor(x / y) * y + mod(x, y) = x`.

*NOTE*: `FloorMod` supports broadcasting. More about broadcasting
[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html)

##### Args:


* <b>`x`</b>: A `Tensor`. Must be one of the following types: `int32`, `int64`, `float32`, `float64`.
* <b>`y`</b>: A `Tensor`. Must have the same type as `x`.
* <b>`name`</b>: A name for the operation (optional).

##### Returns:

A `Tensor`. Has the same type as `x`.

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

- - -

#### `tf.summary.TaggedRunMetadata.__getstate__()` {#TaggedRunMetadata.__getstate__}

Support the pickle protocol.


Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ Returns x / y element-wise.

#### `tf.Tensor.__floordiv__(x, y)` {#Tensor.__floordiv__}

Divides `x / y` elementwise, rounding down for floating point.
Divides `x / y` elementwise, rounding toward the most negative integer.

The same as `tf.div(x,y)` for integers, but uses `tf.floor(tf.div(x,y))` for
floating point arguments so that the result is always an integer (though
Expand Down Expand Up @@ -746,7 +746,7 @@ Returns x / y element-wise.

#### `tf.Tensor.__rfloordiv__(y, x)` {#Tensor.__rfloordiv__}

Divides `x / y` elementwise, rounding down for floating point.
Divides `x / y` elementwise, rounding toward the most negative integer.

The same as `tf.div(x,y)` for integers, but uses `tf.floor(tf.div(x,y))` for
floating point arguments so that the result is always an integer (though
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### `tf.floor_div(x, y, name=None)` {#floor_div}

Returns x // y element-wise.

*NOTE*: `FloorDiv` supports broadcasting. More about broadcasting
[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html)

##### Args:


* <b>`x`</b>: A `Tensor`. Must be one of the following types: `half`, `float32`, `float64`, `uint8`, `int8`, `uint16`, `int16`, `int32`, `int64`, `complex64`, `complex128`.
* <b>`y`</b>: A `Tensor`. Must have the same type as `x`.
* <b>`name`</b>: A name for the operation (optional).

##### Returns:

A `Tensor`. Has the same type as `x`.

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

- - -

#### `tf.summary.SummaryDescription.__getstate__()` {#SummaryDescription.__getstate__}

Support the pickle protocol.


Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
### `tf.truncatediv(x, y, name=None)` {#truncatediv}

Returns x / y element-wise for integer types.

Truncation designates that negative numbers will round fractional quantities
toward zero. I.e. -7 / 5 = 1. This matches C semantics but it is different
than Python semantics. See `FloorDiv` for a division function that matches
Python Semantics.

*NOTE*: `TruncateDiv` supports broadcasting. More about broadcasting
[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html)

##### Args:


* <b>`x`</b>: A `Tensor`. Must be one of the following types: `half`, `float32`, `float64`, `uint8`, `int8`, `uint16`, `int16`, `int32`, `int64`, `complex64`, `complex128`.
* <b>`y`</b>: A `Tensor`. Must have the same type as `x`.
* <b>`name`</b>: A name for the operation (optional).

##### Returns:

A `Tensor`. Has the same type as `x`.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### `tf.floordiv(x, y, name=None)` {#floordiv}

Divides `x / y` elementwise, rounding down for floating point.
Divides `x / y` elementwise, rounding toward the most negative integer.

The same as `tf.div(x,y)` for integers, but uses `tf.floor(tf.div(x,y))` for
floating point arguments so that the result is always an integer (though
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ Returns x / y element-wise.

#### `tf.Output.__floordiv__(x, y)` {#Output.__floordiv__}

Divides `x / y` elementwise, rounding down for floating point.
Divides `x / y` elementwise, rounding toward the most negative integer.

The same as `tf.div(x,y)` for integers, but uses `tf.floor(tf.div(x,y))` for
floating point arguments so that the result is always an integer (though
Expand Down Expand Up @@ -746,7 +746,7 @@ Returns x / y element-wise.

#### `tf.Output.__rfloordiv__(y, x)` {#Output.__rfloordiv__}

Divides `x / y` elementwise, rounding down for floating point.
Divides `x / y` elementwise, rounding toward the most negative integer.

The same as `tf.div(x,y)` for integers, but uses `tf.floor(tf.div(x,y))` for
floating point arguments so that the result is always an integer (though
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@ Returns x / y element-wise.

#### `tf.Variable.__floordiv__(a, *args)` {#Variable.__floordiv__}

Divides `x / y` elementwise, rounding down for floating point.
Divides `x / y` elementwise, rounding toward the most negative integer.

The same as `tf.div(x,y)` for integers, but uses `tf.floor(tf.div(x,y))` for
floating point arguments so that the result is always an integer (though
Expand Down Expand Up @@ -838,7 +838,7 @@ Returns x / y element-wise.

#### `tf.Variable.__rfloordiv__(a, *args)` {#Variable.__rfloordiv__}

Divides `x / y` elementwise, rounding down for floating point.
Divides `x / y` elementwise, rounding toward the most negative integer.

The same as `tf.div(x,y)` for integers, but uses `tf.floor(tf.div(x,y))` for
floating point arguments so that the result is always an integer (though
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
### `tf.truncatemod(x, y, name=None)` {#truncatemod}

Returns element-wise remainder of division. This emulates C semantics where

true, this follows C semantics in that the result here is consistent
with a flooring divide. E.g. `floor(x / y) * y + mod(x, y) = x`.

*NOTE*: `Mod` supports broadcasting. More about broadcasting
[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html)

##### Args:


* <b>`x`</b>: A `Tensor`. Must be one of the following types: `int32`, `int64`, `float32`, `float64`.
* <b>`y`</b>: A `Tensor`. Must have the same type as `x`.
* <b>`name`</b>: A name for the operation (optional).

##### Returns:

A `Tensor`. Has the same type as `x`.

Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
### `tf.realdiv(x, y, name=None)` {#realdiv}

Returns x / y element-wise for real types.

If `x` and `y` are reals, this will return the floating-point division.

*NOTE*: `Div` supports broadcasting. More about broadcasting
[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html)

##### Args:


* <b>`x`</b>: A `Tensor`. Must be one of the following types: `half`, `float32`, `float64`, `uint8`, `int8`, `uint16`, `int16`, `int32`, `int64`, `complex64`, `complex128`.
* <b>`y`</b>: A `Tensor`. Must have the same type as `x`.
* <b>`name`</b>: A name for the operation (optional).

##### Returns:

A `Tensor`. Has the same type as `x`.

7 changes: 7 additions & 0 deletions tensorflow/g3doc/api_docs/python/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,9 @@
* [`fft2d`](../../api_docs/python/math_ops.md#fft2d)
* [`fft3d`](../../api_docs/python/math_ops.md#fft3d)
* [`floor`](../../api_docs/python/math_ops.md#floor)
* [`floor_div`](../../api_docs/python/math_ops.md#floor_div)
* [`floordiv`](../../api_docs/python/math_ops.md#floordiv)
* [`floormod`](../../api_docs/python/math_ops.md#floormod)
* [`ifft`](../../api_docs/python/math_ops.md#ifft)
* [`ifft2d`](../../api_docs/python/math_ops.md#ifft2d)
* [`ifft3d`](../../api_docs/python/math_ops.md#ifft3d)
Expand Down Expand Up @@ -261,6 +263,7 @@
* [`polygamma`](../../api_docs/python/math_ops.md#polygamma)
* [`pow`](../../api_docs/python/math_ops.md#pow)
* [`real`](../../api_docs/python/math_ops.md#real)
* [`realdiv`](../../api_docs/python/math_ops.md#realdiv)
* [`reduce_all`](../../api_docs/python/math_ops.md#reduce_all)
* [`reduce_any`](../../api_docs/python/math_ops.md#reduce_any)
* [`reduce_logsumexp`](../../api_docs/python/math_ops.md#reduce_logsumexp)
Expand Down Expand Up @@ -294,6 +297,8 @@
* [`trace`](../../api_docs/python/math_ops.md#trace)
* [`transpose`](../../api_docs/python/math_ops.md#transpose)
* [`truediv`](../../api_docs/python/math_ops.md#truediv)
* [`truncatediv`](../../api_docs/python/math_ops.md#truncatediv)
* [`truncatemod`](../../api_docs/python/math_ops.md#truncatemod)
* [`unique`](../../api_docs/python/math_ops.md#unique)
* [`unsorted_segment_sum`](../../api_docs/python/math_ops.md#unsorted_segment_sum)
* [`where`](../../api_docs/python/math_ops.md#where)
Expand Down Expand Up @@ -674,6 +679,8 @@
* [`merge`](../../api_docs/python/summary.md#merge)
* [`merge_all`](../../api_docs/python/summary.md#merge_all)
* [`scalar`](../../api_docs/python/summary.md#scalar)
* [`SummaryDescription`](../../api_docs/python/summary.md#SummaryDescription)
* [`TaggedRunMetadata`](../../api_docs/python/summary.md#TaggedRunMetadata)
* [`tensor_summary`](../../api_docs/python/summary.md#tensor_summary)

* **[Testing](../../api_docs/python/test.md)**:
Expand Down
120 changes: 119 additions & 1 deletion tensorflow/g3doc/api_docs/python/math_ops.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ and `int64` (matching the behavior of Numpy).

### `tf.floordiv(x, y, name=None)` {#floordiv}

Divides `x / y` elementwise, rounding down for floating point.
Divides `x / y` elementwise, rounding toward the most negative integer.

The same as `tf.div(x,y)` for integers, but uses `tf.floor(tf.div(x,y))` for
floating point arguments so that the result is always an integer (though
Expand Down Expand Up @@ -222,6 +222,124 @@ as well.
* <b>`TypeError`</b>: If the inputs are complex.


- - -

### `tf.realdiv(x, y, name=None)` {#realdiv}

Returns x / y element-wise for real types.

If `x` and `y` are reals, this will return the floating-point division.

*NOTE*: `Div` supports broadcasting. More about broadcasting
[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html)

##### Args:


* <b>`x`</b>: A `Tensor`. Must be one of the following types: `half`, `float32`, `float64`, `uint8`, `int8`, `uint16`, `int16`, `int32`, `int64`, `complex64`, `complex128`.
* <b>`y`</b>: A `Tensor`. Must have the same type as `x`.
* <b>`name`</b>: A name for the operation (optional).

##### Returns:

A `Tensor`. Has the same type as `x`.


- - -

### `tf.truncatediv(x, y, name=None)` {#truncatediv}

Returns x / y element-wise for integer types.

Truncation designates that negative numbers will round fractional quantities
toward zero. I.e. -7 / 5 = 1. This matches C semantics but it is different
than Python semantics. See `FloorDiv` for a division function that matches
Python Semantics.

*NOTE*: `TruncateDiv` supports broadcasting. More about broadcasting
[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html)

##### Args:


* <b>`x`</b>: A `Tensor`. Must be one of the following types: `half`, `float32`, `float64`, `uint8`, `int8`, `uint16`, `int16`, `int32`, `int64`, `complex64`, `complex128`.
* <b>`y`</b>: A `Tensor`. Must have the same type as `x`.
* <b>`name`</b>: A name for the operation (optional).

##### Returns:

A `Tensor`. Has the same type as `x`.


- - -

### `tf.floor_div(x, y, name=None)` {#floor_div}

Returns x // y element-wise.

*NOTE*: `FloorDiv` supports broadcasting. More about broadcasting
[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html)

##### Args:


* <b>`x`</b>: A `Tensor`. Must be one of the following types: `half`, `float32`, `float64`, `uint8`, `int8`, `uint16`, `int16`, `int32`, `int64`, `complex64`, `complex128`.
* <b>`y`</b>: A `Tensor`. Must have the same type as `x`.
* <b>`name`</b>: A name for the operation (optional).

##### Returns:

A `Tensor`. Has the same type as `x`.


- - -

### `tf.truncatemod(x, y, name=None)` {#truncatemod}

Returns element-wise remainder of division. This emulates C semantics where

true, this follows C semantics in that the result here is consistent
with a flooring divide. E.g. `floor(x / y) * y + mod(x, y) = x`.

*NOTE*: `Mod` supports broadcasting. More about broadcasting
[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html)

##### Args:


* <b>`x`</b>: A `Tensor`. Must be one of the following types: `int32`, `int64`, `float32`, `float64`.
* <b>`y`</b>: A `Tensor`. Must have the same type as `x`.
* <b>`name`</b>: A name for the operation (optional).

##### Returns:

A `Tensor`. Has the same type as `x`.


- - -

### `tf.floormod(x, y, name=None)` {#floormod}

Returns element-wise remainder of division. When `x < 0` xor `y < 0` is

true, this follows Python semantics in that the result here is consistent
with a flooring divide. E.g. `floor(x / y) * y + mod(x, y) = x`.

*NOTE*: `FloorMod` supports broadcasting. More about broadcasting
[here](http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html)

##### Args:


* <b>`x`</b>: A `Tensor`. Must be one of the following types: `int32`, `int64`, `float32`, `float64`.
* <b>`y`</b>: A `Tensor`. Must have the same type as `x`.
* <b>`name`</b>: A name for the operation (optional).

##### Returns:

A `Tensor`. Has the same type as `x`.


- - -

### `tf.mod(x, y, name=None)` {#mod}
Expand Down
Loading

0 comments on commit 463fd91

Please sign in to comment.