diff options
author | 2016-11-28 11:23:21 -0800 | |
---|---|---|
committer | 2016-11-28 11:45:08 -0800 | |
commit | 351df86e95bcd595866e8c5d8fd809b23c7fbac8 (patch) | |
tree | e4d848e6fb342e64829fd65f0e26a4fc7e224a13 | |
parent | 74b312d4df0a2c8283bdf05559803f49bc38dbe0 (diff) |
Update generated Python Op docs.
Change: 140380313
8 files changed, 44 insertions, 24 deletions
diff --git a/tensorflow/g3doc/api_docs/python/contrib.distributions.md b/tensorflow/g3doc/api_docs/python/contrib.distributions.md index bd1a9db7bb..b4768011a4 100644 --- a/tensorflow/g3doc/api_docs/python/contrib.distributions.md +++ b/tensorflow/g3doc/api_docs/python/contrib.distributions.md @@ -20891,7 +20891,7 @@ log_normal = ds.TransformedDistribution( forward_fn=tf.exp, inverse_fn=tf.log, inverse_log_det_jacobian_fn=( - lambda y: -tf.reduce_sum(tf.log(x), reduction_indices=-1)), + lambda y: -tf.reduce_sum(tf.log(y), reduction_indices=-1)), name="LogNormalTransformedDistribution") ``` @@ -20913,7 +20913,7 @@ Construct a Transformed Distribution. ##### Args: -* <b>`distribution`</b>: The base distribution class to transform. Typically an +* <b>`distribution`</b>: The base distribution instance to transform. Typically an instance of `Distribution`. * <b>`bijector`</b>: The object responsible for calculating the transformation. Typically an instance of `Bijector`. diff --git a/tensorflow/g3doc/api_docs/python/contrib.framework.md b/tensorflow/g3doc/api_docs/python/contrib.framework.md index 0b8690cf2d..d819f9f505 100644 --- a/tensorflow/g3doc/api_docs/python/contrib.framework.md +++ b/tensorflow/g3doc/api_docs/python/contrib.framework.md @@ -309,7 +309,7 @@ to the rest of the docstring. - - - -### `tf.contrib.framework.deprecated_args(date, instructions, *deprecated_arg_names)` {#deprecated_args} +### `tf.contrib.framework.deprecated_args(date, instructions, *deprecated_arg_names_or_tuples)` {#deprecated_args} Decorator for marking specific function arguments as deprecated. @@ -333,7 +333,10 @@ prepended to the rest of the docstring. ISO 8601 (YYYY-MM-DD). * <b>`instructions`</b>: String. Instructions on how to update code using the deprecated function. -* <b>`*deprecated_arg_names`</b>: String. The deprecated arguments. +* <b>`*deprecated_arg_names_or_tuples`</b>: String. or 2-Tuple(String, + [ok_vals]). The string is the deprecated argument name. + Optionally, an ok-value may be provided. If the user provided + argument equals this value, the warning is suppressed. ##### Returns: @@ -342,8 +345,10 @@ prepended to the rest of the docstring. ##### Raises: -* <b>`ValueError`</b>: If date is not in ISO 8601 format, instructions are empty, or - the deprecated arguments are not present in the function signature. +* <b>`ValueError`</b>: If date is not in ISO 8601 format, instructions are + empty, the deprecated arguments are not present in the function + signature, or the second element of a deprecated_tuple is not a + list. - - - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.contrib.framework.deprecated_args.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.contrib.framework.deprecated_args.md index 4dd9bbc0f8..3f81ac9fc1 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.contrib.framework.deprecated_args.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.contrib.framework.deprecated_args.md @@ -1,4 +1,4 @@ -### `tf.contrib.framework.deprecated_args(date, instructions, *deprecated_arg_names)` {#deprecated_args} +### `tf.contrib.framework.deprecated_args(date, instructions, *deprecated_arg_names_or_tuples)` {#deprecated_args} Decorator for marking specific function arguments as deprecated. @@ -22,7 +22,10 @@ prepended to the rest of the docstring. ISO 8601 (YYYY-MM-DD). * <b>`instructions`</b>: String. Instructions on how to update code using the deprecated function. -* <b>`*deprecated_arg_names`</b>: String. The deprecated arguments. +* <b>`*deprecated_arg_names_or_tuples`</b>: String. or 2-Tuple(String, + [ok_vals]). The string is the deprecated argument name. + Optionally, an ok-value may be provided. If the user provided + argument equals this value, the warning is suppressed. ##### Returns: @@ -31,6 +34,8 @@ prepended to the rest of the docstring. ##### Raises: -* <b>`ValueError`</b>: If date is not in ISO 8601 format, instructions are empty, or - the deprecated arguments are not present in the function signature. +* <b>`ValueError`</b>: If date is not in ISO 8601 format, instructions are + empty, the deprecated arguments are not present in the function + signature, or the second element of a deprecated_tuple is not a + list. diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.contrib.distributions.TransformedDistribution.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.contrib.distributions.TransformedDistribution.md index 4b4f4413b5..bc87f7bd0d 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.contrib.distributions.TransformedDistribution.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.contrib.distributions.TransformedDistribution.md @@ -87,7 +87,7 @@ log_normal = ds.TransformedDistribution( forward_fn=tf.exp, inverse_fn=tf.log, inverse_log_det_jacobian_fn=( - lambda y: -tf.reduce_sum(tf.log(x), reduction_indices=-1)), + lambda y: -tf.reduce_sum(tf.log(y), reduction_indices=-1)), name="LogNormalTransformedDistribution") ``` @@ -109,7 +109,7 @@ Construct a Transformed Distribution. ##### Args: -* <b>`distribution`</b>: The base distribution class to transform. Typically an +* <b>`distribution`</b>: The base distribution instance to transform. Typically an instance of `Distribution`. * <b>`bijector`</b>: The object responsible for calculating the transformation. Typically an instance of `Bijector`. diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.string_split.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.string_split.md index 25607d1619..08ccc5f104 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.string_split.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.string_split.md @@ -8,7 +8,8 @@ containing the splitted tokens. Empty tokens are ignored. If `delimiter` is an empty string, each element of the `source` is split into individual strings, each containing one byte. (This includes splitting -multibyte sequences of UTF-8.) +multibyte sequences of UTF-8.) If delimiter contains multiple bytes, it is +treated as a set of delimiters with each considered a potential split point. For example: N = 2, source[0] is 'hello world' and source[1] is 'a b c', then the output @@ -29,14 +30,14 @@ st.values = ['hello', 'world', 'a', 'b', 'c'] * <b>`delimiter`</b>: `0-D` string `Tensor`, the delimiter character, the string should be length 0 or 1. +##### Raises: + + +* <b>`ValueError`</b>: If delimiter is not a string. + ##### Returns: A `SparseTensor` of rank `2`, the strings split according to the delimiter. The first column of the indices corresponds to the row in `source` and the second column corresponds to the index of the split component in this row. -##### Raises: - - -* <b>`ValueError`</b>: If delimiter is not a single-byte character. - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.Variable.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.Variable.md index 648606c3db..ba2405c929 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.Variable.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.Variable.md @@ -154,6 +154,10 @@ Returns the value of the initialized variable. You should use this instead of the variable itself to initialize another variable with a value that depends on the value of this variable. +Beware of using initialized_value except during initialization: +initialized_value causes the Variable's initializer op to be run, so running +this op resets the variable to the initial value. + ```python # Initialize 'v' with a random tensor. v = tf.Variable(tf.truncated_normal([10, 40])) diff --git a/tensorflow/g3doc/api_docs/python/state_ops.md b/tensorflow/g3doc/api_docs/python/state_ops.md index 7e440b887d..9edaea84bd 100644 --- a/tensorflow/g3doc/api_docs/python/state_ops.md +++ b/tensorflow/g3doc/api_docs/python/state_ops.md @@ -169,6 +169,10 @@ Returns the value of the initialized variable. You should use this instead of the variable itself to initialize another variable with a value that depends on the value of this variable. +Beware of using initialized_value except during initialization: +initialized_value causes the Variable's initializer op to be run, so running +this op resets the variable to the initial value. + ```python # Initialize 'v' with a random tensor. v = tf.Variable(tf.truncated_normal([10, 40])) diff --git a/tensorflow/g3doc/api_docs/python/string_ops.md b/tensorflow/g3doc/api_docs/python/string_ops.md index 86878ca664..7e75148891 100644 --- a/tensorflow/g3doc/api_docs/python/string_ops.md +++ b/tensorflow/g3doc/api_docs/python/string_ops.md @@ -194,7 +194,8 @@ containing the splitted tokens. Empty tokens are ignored. If `delimiter` is an empty string, each element of the `source` is split into individual strings, each containing one byte. (This includes splitting -multibyte sequences of UTF-8.) +multibyte sequences of UTF-8.) If delimiter contains multiple bytes, it is +treated as a set of delimiters with each considered a potential split point. For example: N = 2, source[0] is 'hello world' and source[1] is 'a b c', then the output @@ -215,17 +216,17 @@ st.values = ['hello', 'world', 'a', 'b', 'c'] * <b>`delimiter`</b>: `0-D` string `Tensor`, the delimiter character, the string should be length 0 or 1. +##### Raises: + + +* <b>`ValueError`</b>: If delimiter is not a string. + ##### Returns: A `SparseTensor` of rank `2`, the strings split according to the delimiter. The first column of the indices corresponds to the row in `source` and the second column corresponds to the index of the split component in this row. -##### Raises: - - -* <b>`ValueError`</b>: If delimiter is not a single-byte character. - - - - |