diff options
author | 2016-07-21 14:19:32 -0800 | |
---|---|---|
committer | 2016-07-21 15:31:42 -0700 | |
commit | 5eff52bcd77a04f65e3aa6563781ce17161812b4 (patch) | |
tree | 1eaa24ad936dd01a62fb761bd6953c58765c68e2 | |
parent | d6a39b688b12521f1ae2229f603d140f4e68058e (diff) |
Update generated Python Op docs.
Change: 128111782
8 files changed, 136 insertions, 88 deletions
diff --git a/tensorflow/g3doc/api_docs/python/contrib.learn.md b/tensorflow/g3doc/api_docs/python/contrib.learn.md index 5a56007ed0..7ec7b6fb71 100644 --- a/tensorflow/g3doc/api_docs/python/contrib.learn.md +++ b/tensorflow/g3doc/api_docs/python/contrib.learn.md @@ -240,7 +240,7 @@ to converge, and you want to split up training into subparts. - - - -#### `tf.contrib.learn.BaseEstimator.predict(x=None, input_fn=None, batch_size=None, outputs=None)` {#BaseEstimator.predict} +#### `tf.contrib.learn.BaseEstimator.predict(x=None, input_fn=None, batch_size=None, outputs=None, as_iterable=False)` {#BaseEstimator.predict} Returns predictions for given features. @@ -255,10 +255,17 @@ Returns predictions for given features. 'None'. * <b>`outputs`</b>: list of `str`, name of the output to predict. If `None`, returns all. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted classes or regression values. + A numpy array of predicted classes or regression values if the + constructor's `model_fn` returns a `Tensor` for `predictions` or a `dict` + of numpy arrays if `model_fn` returns a `dict`. Returns an iterable of + predictions if as_iterable is True. ##### Raises: @@ -547,7 +554,7 @@ to converge, and you want to split up training into subparts. - - - -#### `tf.contrib.learn.Estimator.predict(x=None, input_fn=None, batch_size=None, outputs=None)` {#Estimator.predict} +#### `tf.contrib.learn.Estimator.predict(x=None, input_fn=None, batch_size=None, outputs=None, as_iterable=False)` {#Estimator.predict} Returns predictions for given features. @@ -562,10 +569,17 @@ Returns predictions for given features. 'None'. * <b>`outputs`</b>: list of `str`, name of the output to predict. If `None`, returns all. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted classes or regression values. + A numpy array of predicted classes or regression values if the + constructor's `model_fn` returns a `Tensor` for `predictions` or a `dict` + of numpy arrays if `model_fn` returns a `dict`. Returns an iterable of + predictions if as_iterable is True. ##### Raises: @@ -1225,9 +1239,9 @@ to converge, and you want to split up training into subparts. - - - -#### `tf.contrib.learn.DNNClassifier.predict(x=None, input_fn=None, batch_size=None)` {#DNNClassifier.predict} +#### `tf.contrib.learn.DNNClassifier.predict(x=None, input_fn=None, batch_size=None, as_iterable=False)` {#DNNClassifier.predict} -Returns predictions for given features. +Returns predicted classes for given features. ##### Args: @@ -1235,15 +1249,20 @@ Returns predictions for given features. * <b>`x`</b>: features. * <b>`input_fn`</b>: Input function. If set, x must be None. * <b>`batch_size`</b>: Override default batch size. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted classes or regression values. + Numpy array of predicted classes (or an iterable of predicted classes if + as_iterable is True). - - - -#### `tf.contrib.learn.DNNClassifier.predict_proba(x=None, input_fn=None, batch_size=None)` {#DNNClassifier.predict_proba} +#### `tf.contrib.learn.DNNClassifier.predict_proba(x=None, input_fn=None, batch_size=None, as_iterable=False)` {#DNNClassifier.predict_proba} Returns prediction probabilities for given features. @@ -1253,10 +1272,15 @@ Returns prediction probabilities for given features. * <b>`x`</b>: features. * <b>`input_fn`</b>: Input function. If set, x and y must be None. * <b>`batch_size`</b>: Override default batch size. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted probabilities. + Numpy array of predicted probabilities (or an iterable of predicted + probabilities if as_iterable is True). - - - @@ -1630,7 +1654,7 @@ to converge, and you want to split up training into subparts. - - - -#### `tf.contrib.learn.DNNRegressor.predict(x=None, input_fn=None, batch_size=None, outputs=None)` {#DNNRegressor.predict} +#### `tf.contrib.learn.DNNRegressor.predict(x=None, input_fn=None, batch_size=None, outputs=None, as_iterable=False)` {#DNNRegressor.predict} Returns predictions for given features. @@ -1645,10 +1669,17 @@ Returns predictions for given features. 'None'. * <b>`outputs`</b>: list of `str`, name of the output to predict. If `None`, returns all. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted classes or regression values. + A numpy array of predicted classes or regression values if the + constructor's `model_fn` returns a `Tensor` for `predictions` or a `dict` + of numpy arrays if `model_fn` returns a `dict`. Returns an iterable of + predictions if as_iterable is True. ##### Raises: @@ -2877,9 +2908,9 @@ to converge, and you want to split up training into subparts. - - - -#### `tf.contrib.learn.LinearClassifier.predict(x=None, input_fn=None, batch_size=None)` {#LinearClassifier.predict} +#### `tf.contrib.learn.LinearClassifier.predict(x=None, input_fn=None, batch_size=None, as_iterable=False)` {#LinearClassifier.predict} -Returns predictions for given features. +Returns predicted classes for given features. ##### Args: @@ -2887,15 +2918,20 @@ Returns predictions for given features. * <b>`x`</b>: features. * <b>`input_fn`</b>: Input function. If set, x must be None. * <b>`batch_size`</b>: Override default batch size. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted classes or regression values. + Numpy array of predicted classes (or an iterable of predicted classes if + as_iterable is True). - - - -#### `tf.contrib.learn.LinearClassifier.predict_proba(x=None, input_fn=None, batch_size=None)` {#LinearClassifier.predict_proba} +#### `tf.contrib.learn.LinearClassifier.predict_proba(x=None, input_fn=None, batch_size=None, as_iterable=False)` {#LinearClassifier.predict_proba} Returns prediction probabilities for given features. @@ -2905,10 +2941,15 @@ Returns prediction probabilities for given features. * <b>`x`</b>: features. * <b>`input_fn`</b>: Input function. If set, x and y must be None. * <b>`batch_size`</b>: Override default batch size. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted probabilities. + Numpy array of predicted probabilities (or an iterable of predicted + probabilities if as_iterable is True). - - - @@ -3265,7 +3306,7 @@ to converge, and you want to split up training into subparts. - - - -#### `tf.contrib.learn.LinearRegressor.predict(x=None, input_fn=None, batch_size=None, outputs=None)` {#LinearRegressor.predict} +#### `tf.contrib.learn.LinearRegressor.predict(x=None, input_fn=None, batch_size=None, outputs=None, as_iterable=False)` {#LinearRegressor.predict} Returns predictions for given features. @@ -3280,10 +3321,17 @@ Returns predictions for given features. 'None'. * <b>`outputs`</b>: list of `str`, name of the output to predict. If `None`, returns all. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted classes or regression values. + A numpy array of predicted classes or regression values if the + constructor's `model_fn` returns a `Tensor` for `predictions` or a `dict` + of numpy arrays if `model_fn` returns a `dict`. Returns an iterable of + predictions if as_iterable is True. ##### Raises: @@ -4926,33 +4974,9 @@ init all variables. - - - -### `tf.contrib.learn.run_feeds(output_dict, feed_dicts, restore_checkpoint_path=None)` {#run_feeds} - -Run `output_dict` tensors with each input in `feed_dicts`. - -If `restore_checkpoint_path` is supplied, restore from checkpoint. Otherwise, -init all variables. +### `tf.contrib.learn.run_feeds(*args, **kwargs)` {#run_feeds} -##### Args: - - -* <b>`output_dict`</b>: A `dict` mapping string names to `Tensor` objects to run. - Tensors must all be from the same graph. -* <b>`feed_dicts`</b>: Iterable of `dict` objects of input values to feed. -* <b>`restore_checkpoint_path`</b>: A string containing the path to a checkpoint to - restore. - -##### Returns: - - A list of dicts of values read from `output_dict` tensors, one item in the - list for each item in `feed_dicts`. Keys are the same as `output_dict`, - values are the results read from the corresponding `Tensor` in - `output_dict`. - -##### Raises: - - -* <b>`ValueError`</b>: if `output_dict` or `feed_dicts` is None or empty. +See run_feeds_iter(). Returns a `list` instead of an iterator. - - - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.contrib.learn.LinearRegressor.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.contrib.learn.LinearRegressor.md index d139a988d7..ab1b208038 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.contrib.learn.LinearRegressor.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.contrib.learn.LinearRegressor.md @@ -314,7 +314,7 @@ to converge, and you want to split up training into subparts. - - - -#### `tf.contrib.learn.LinearRegressor.predict(x=None, input_fn=None, batch_size=None, outputs=None)` {#LinearRegressor.predict} +#### `tf.contrib.learn.LinearRegressor.predict(x=None, input_fn=None, batch_size=None, outputs=None, as_iterable=False)` {#LinearRegressor.predict} Returns predictions for given features. @@ -329,10 +329,17 @@ Returns predictions for given features. 'None'. * <b>`outputs`</b>: list of `str`, name of the output to predict. If `None`, returns all. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted classes or regression values. + A numpy array of predicted classes or regression values if the + constructor's `model_fn` returns a `Tensor` for `predictions` or a `dict` + of numpy arrays if `model_fn` returns a `dict`. Returns an iterable of + predictions if as_iterable is True. ##### Raises: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.contrib.learn.LinearClassifier.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.contrib.learn.LinearClassifier.md index dc8be48530..b16e69054a 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.contrib.learn.LinearClassifier.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.contrib.learn.LinearClassifier.md @@ -332,9 +332,9 @@ to converge, and you want to split up training into subparts. - - - -#### `tf.contrib.learn.LinearClassifier.predict(x=None, input_fn=None, batch_size=None)` {#LinearClassifier.predict} +#### `tf.contrib.learn.LinearClassifier.predict(x=None, input_fn=None, batch_size=None, as_iterable=False)` {#LinearClassifier.predict} -Returns predictions for given features. +Returns predicted classes for given features. ##### Args: @@ -342,15 +342,20 @@ Returns predictions for given features. * <b>`x`</b>: features. * <b>`input_fn`</b>: Input function. If set, x must be None. * <b>`batch_size`</b>: Override default batch size. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted classes or regression values. + Numpy array of predicted classes (or an iterable of predicted classes if + as_iterable is True). - - - -#### `tf.contrib.learn.LinearClassifier.predict_proba(x=None, input_fn=None, batch_size=None)` {#LinearClassifier.predict_proba} +#### `tf.contrib.learn.LinearClassifier.predict_proba(x=None, input_fn=None, batch_size=None, as_iterable=False)` {#LinearClassifier.predict_proba} Returns prediction probabilities for given features. @@ -360,10 +365,15 @@ Returns prediction probabilities for given features. * <b>`x`</b>: features. * <b>`input_fn`</b>: Input function. If set, x and y must be None. * <b>`batch_size`</b>: Override default batch size. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted probabilities. + Numpy array of predicted probabilities (or an iterable of predicted + probabilities if as_iterable is True). - - - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.contrib.learn.BaseEstimator.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.contrib.learn.BaseEstimator.md index 6b9f1bf336..c1dcda2ff6 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.contrib.learn.BaseEstimator.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.contrib.learn.BaseEstimator.md @@ -225,7 +225,7 @@ to converge, and you want to split up training into subparts. - - - -#### `tf.contrib.learn.BaseEstimator.predict(x=None, input_fn=None, batch_size=None, outputs=None)` {#BaseEstimator.predict} +#### `tf.contrib.learn.BaseEstimator.predict(x=None, input_fn=None, batch_size=None, outputs=None, as_iterable=False)` {#BaseEstimator.predict} Returns predictions for given features. @@ -240,10 +240,17 @@ Returns predictions for given features. 'None'. * <b>`outputs`</b>: list of `str`, name of the output to predict. If `None`, returns all. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted classes or regression values. + A numpy array of predicted classes or regression values if the + constructor's `model_fn` returns a `Tensor` for `predictions` or a `dict` + of numpy arrays if `model_fn` returns a `dict`. Returns an iterable of + predictions if as_iterable is True. ##### Raises: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard3/tf.contrib.learn.Estimator.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard3/tf.contrib.learn.Estimator.md index 3256c6039f..07568c5f30 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard3/tf.contrib.learn.Estimator.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard3/tf.contrib.learn.Estimator.md @@ -248,7 +248,7 @@ to converge, and you want to split up training into subparts. - - - -#### `tf.contrib.learn.Estimator.predict(x=None, input_fn=None, batch_size=None, outputs=None)` {#Estimator.predict} +#### `tf.contrib.learn.Estimator.predict(x=None, input_fn=None, batch_size=None, outputs=None, as_iterable=False)` {#Estimator.predict} Returns predictions for given features. @@ -263,10 +263,17 @@ Returns predictions for given features. 'None'. * <b>`outputs`</b>: list of `str`, name of the output to predict. If `None`, returns all. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted classes or regression values. + A numpy array of predicted classes or regression values if the + constructor's `model_fn` returns a `Tensor` for `predictions` or a `dict` + of numpy arrays if `model_fn` returns a `dict`. Returns an iterable of + predictions if as_iterable is True. ##### Raises: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.contrib.learn.DNNClassifier.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.contrib.learn.DNNClassifier.md index b4832c2c64..72f8108536 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.contrib.learn.DNNClassifier.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.contrib.learn.DNNClassifier.md @@ -333,9 +333,9 @@ to converge, and you want to split up training into subparts. - - - -#### `tf.contrib.learn.DNNClassifier.predict(x=None, input_fn=None, batch_size=None)` {#DNNClassifier.predict} +#### `tf.contrib.learn.DNNClassifier.predict(x=None, input_fn=None, batch_size=None, as_iterable=False)` {#DNNClassifier.predict} -Returns predictions for given features. +Returns predicted classes for given features. ##### Args: @@ -343,15 +343,20 @@ Returns predictions for given features. * <b>`x`</b>: features. * <b>`input_fn`</b>: Input function. If set, x must be None. * <b>`batch_size`</b>: Override default batch size. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted classes or regression values. + Numpy array of predicted classes (or an iterable of predicted classes if + as_iterable is True). - - - -#### `tf.contrib.learn.DNNClassifier.predict_proba(x=None, input_fn=None, batch_size=None)` {#DNNClassifier.predict_proba} +#### `tf.contrib.learn.DNNClassifier.predict_proba(x=None, input_fn=None, batch_size=None, as_iterable=False)` {#DNNClassifier.predict_proba} Returns prediction probabilities for given features. @@ -361,10 +366,15 @@ Returns prediction probabilities for given features. * <b>`x`</b>: features. * <b>`input_fn`</b>: Input function. If set, x and y must be None. * <b>`batch_size`</b>: Override default batch size. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted probabilities. + Numpy array of predicted probabilities (or an iterable of predicted + probabilities if as_iterable is True). - - - diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.contrib.learn.run_feeds.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.contrib.learn.run_feeds.md index ec13fc4073..25316e6ffa 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.contrib.learn.run_feeds.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard4/tf.contrib.learn.run_feeds.md @@ -1,28 +1,4 @@ -### `tf.contrib.learn.run_feeds(output_dict, feed_dicts, restore_checkpoint_path=None)` {#run_feeds} +### `tf.contrib.learn.run_feeds(*args, **kwargs)` {#run_feeds} -Run `output_dict` tensors with each input in `feed_dicts`. - -If `restore_checkpoint_path` is supplied, restore from checkpoint. Otherwise, -init all variables. - -##### Args: - - -* <b>`output_dict`</b>: A `dict` mapping string names to `Tensor` objects to run. - Tensors must all be from the same graph. -* <b>`feed_dicts`</b>: Iterable of `dict` objects of input values to feed. -* <b>`restore_checkpoint_path`</b>: A string containing the path to a checkpoint to - restore. - -##### Returns: - - A list of dicts of values read from `output_dict` tensors, one item in the - list for each item in `feed_dicts`. Keys are the same as `output_dict`, - values are the results read from the corresponding `Tensor` in - `output_dict`. - -##### Raises: - - -* <b>`ValueError`</b>: if `output_dict` or `feed_dicts` is None or empty. +See run_feeds_iter(). Returns a `list` instead of an iterator. diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.contrib.learn.DNNRegressor.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.contrib.learn.DNNRegressor.md index e938030d6c..0b1974ae16 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.contrib.learn.DNNRegressor.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.contrib.learn.DNNRegressor.md @@ -331,7 +331,7 @@ to converge, and you want to split up training into subparts. - - - -#### `tf.contrib.learn.DNNRegressor.predict(x=None, input_fn=None, batch_size=None, outputs=None)` {#DNNRegressor.predict} +#### `tf.contrib.learn.DNNRegressor.predict(x=None, input_fn=None, batch_size=None, outputs=None, as_iterable=False)` {#DNNRegressor.predict} Returns predictions for given features. @@ -346,10 +346,17 @@ Returns predictions for given features. 'None'. * <b>`outputs`</b>: list of `str`, name of the output to predict. If `None`, returns all. +* <b>`as_iterable`</b>: If True, return an iterable which keeps yielding predictions + for each example until inputs are exhausted. Note: The inputs must + terminate if you want the iterable to terminate (e.g. be sure to pass + num_epochs=1 if you are using something like read_batch_features). ##### Returns: - Numpy array of predicted classes or regression values. + A numpy array of predicted classes or regression values if the + constructor's `model_fn` returns a `Tensor` for `predictions` or a `dict` + of numpy arrays if `model_fn` returns a `dict`. Returns an iterable of + predictions if as_iterable is True. ##### Raises: |