tfdbg: add auto-generated Python API doc to gen_docs_combined.py · codeplaysoftware/tensorflow@b04d568 · GitHub

1. codeplaysoftware
2. tensorflow

Repository navigation

• Code
• Issues
• Pull requests
• Actions
• Projects
• Security and quality
• Insights

Commit b04d568

Browse filesBrowse the repository at this point in the historyBrowse files

caisq

authored and

tensorflower-gardener

committed

tfdbg: add auto-generated Python API doc to gen_docs_combined.py

Also make some touch-ups on the relevant doc strings. Change: 143128831

1 parent b61c142 commit b04d568
Copy full SHA for b04d568

6 files changed

+301-190Lines changed: 301 additions & 190 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• tensorflow/python
  • debug
    • __init__.py
    • debug_data.py
    • debug_utils.py
    • wrappers
      • framework.py
      • local_cli_wrapper.py
  • framework
    • gen_docs_combined.py

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎tensorflow/python/debug/__init__.py‎

Copy file name to clipboardExpand all lines: tensorflow/python/debug/__init__.py

+47-1Lines changed: 47 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -12,7 +12,53 @@
12	12	# See the License for the specific language governing permissions and
13	13	# limitations under the License.
14	14	# ==============================================================================
15		- """Public Python API of TensorFlow Debugger (tfdbg)."""
	15	+ """Public Python API of TensorFlow Debugger (tfdbg).
	16	+
	17	+ ## Functions for adding debug watches
	18	+
	19	+ These functions help you modify `RunOptions` to specify which `Tensor`s are to
	20	+ be watched when the TensorFlow graph is executed at runtime.
	21	+
	22	+ @@add_debug_tensor_watch
	23	+ @@watch_graph
	24	+ @@watch_graph_with_blacklists
	25	+
	26	+
	27	+ ## Classes for debug-dump data and directories
	28	+
	29	+ These classes allow you to load and inspect tensor values dumped from
	30	+ TensorFlow graphs during runtime.
	31	+
	32	+ @@DebugTensorDatum
	33	+ @@DebugDumpDir
	34	+
	35	+
	36	+ ## Functions for loading debug-dump data
	37	+
	38	+ @@load_tensor_from_event_file
	39	+
	40	+
	41	+ ## Tensor-value predicates
	42	+
	43	+ Built-in tensor-filter predicates to support conditional breakpoint between
	44	+ runs. See `DebugDumpDir.find()` for more details.
	45	+
	46	+ @@has_inf_or_nan
	47	+
	48	+
	49	+ ## Session wrapper class and `SessionRunHook` implementations
	50	+
	51	+ These classes allow you to
	52	+
	53	+ * wrap aroundTensorFlow `Session` objects to debug plain TensorFlow models
	54	+ (see `LocalCLIDebugWrapperSession`), or
	55	+ * generate `SessionRunHook` objects to debug `tf.contrib.learn` models (see
	56	+ `LocalCLIDebugHook`).
	57	+
	58	+ @@LocalCLIDebugHook
	59	+ @@LocalCLIDebugWrapperSession
	60	+
	61	+ """
16	62
17	63	from __future__ import absolute_import
18	64	from __future__ import division

0 commit comments

Comments

0 (0)