提交 e30936c0 编写于 作者: A A. Unique TensorFlower 提交者: TensorFlower Gardener

Update generated Python Op docs.

Change: 125834391
上级 40f70446
......@@ -307,6 +307,45 @@ Assert tensors are the same shape, from the same graph.
## Deprecation
- - -
### `tf.contrib.framework.deprecated(date, instructions)` {#deprecated}
Decorator for marking functions or methods deprecated.
This decorator adds a deprecation warning to a function's docstring. It has
the following format:
<function> (from <module>) is deprecated and will be removed after <date>.
Instructions for updating:
<instructions>
whenever the decorated function is called. <function> will include the class
name if it is a method.
It also edits the docstring of the function: ' (deprecated)' is appended
to the first line of the docstring and a deprecation notice is prepended
to the rest of the docstring.
##### Args:
* <b>`date`</b>: String. The date the function is scheduled to be removed. Must be
ISO 8601 (YYYY-MM-DD).
* <b>`instructions`</b>: String. Instructions on how to update code using the
deprecated function.
##### Returns:
Decorated function or method.
##### Raises:
* <b>`ValueError`</b>: If date is not in ISO 8601 format, or instructions are empty.
## Arg_Scope
- - -
......
### `tf.contrib.framework.deprecated(date, instructions)` {#deprecated}
Decorator for marking functions or methods deprecated.
This decorator adds a deprecation warning to a function's docstring. It has
the following format:
<function> (from <module>) is deprecated and will be removed after <date>.
Instructions for updating:
<instructions>
whenever the decorated function is called. <function> will include the class
name if it is a method.
It also edits the docstring of the function: ' (deprecated)' is appended
to the first line of the docstring and a deprecation notice is prepended
to the rest of the docstring.
##### Args:
* <b>`date`</b>: String. The date the function is scheduled to be removed. Must be
ISO 8601 (YYYY-MM-DD).
* <b>`instructions`</b>: String. Instructions on how to update code using the
deprecated function.
##### Returns:
Decorated function or method.
##### Raises:
* <b>`ValueError`</b>: If date is not in ISO 8601 format, or instructions are empty.
......@@ -611,6 +611,7 @@
* [`assert_scalar_int`](../../api_docs/python/contrib.framework.md#assert_scalar_int)
* [`convert_to_tensor_or_sparse_tensor`](../../api_docs/python/contrib.framework.md#convert_to_tensor_or_sparse_tensor)
* [`create_global_step`](../../api_docs/python/contrib.framework.md#create_global_step)
* [`deprecated`](../../api_docs/python/contrib.framework.md#deprecated)
* [`get_global_step`](../../api_docs/python/contrib.framework.md#get_global_step)
* [`get_graph_from_inputs`](../../api_docs/python/contrib.framework.md#get_graph_from_inputs)
* [`get_local_variables`](../../api_docs/python/contrib.framework.md#get_local_variables)
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册