diff options
| author |  Mark Daoust <markdaoust@google.com> | 2018-08-09 07:03:39 -0700 |
|---|---|---|
| committer |  TensorFlower Gardener <gardener@tensorflow.org> | 2018-08-09 07:08:30 -0700 |
| commit | f40a875355557483aeae60ffcf757fc9626c752b (patch) | |
| tree | 7f642a6fd12495c1c7d9b2f3a37e376d8ee6d2c9 /tensorflow/python/debug | |
| parent | fd9fc4b4b69f7fce60497bbaf5cbd958f12ead8d (diff) | |
Remove usage of magic-api-link syntax from source files.
Back-ticks are now converted to links in the api_docs generator. With the new docs repo we're moving to simplify the docs pipeline, and make everything more readable.
By doing this we no longer get test failures for symbols that don't exist (`tf.does_not_exist` will not get a link).
There is also no way, not to set custom link text. That's okay.
This is the result of the following regex replacement (+ a couple of manual edits.):
re: @\{([^$].*?)(\$.+?)?}
sub: `\1`
Which does the following replacements:
"@{tf.symbol}" --> "`tf.symbol`"
"@{tf.symbol$link_text}" --> "`tf.symbol`"
PiperOrigin-RevId: 208042358
Diffstat (limited to 'tensorflow/python/debug')
| -rw-r--r-- | tensorflow/python/debug/lib/debug_gradients.py | 6 | ||||
| -rw-r--r-- | tensorflow/python/debug/wrappers/dumping_wrapper.py | 2 |
2 files changed, 4 insertions, 4 deletions
diff --git a/tensorflow/python/debug/lib/debug_gradients.py b/tensorflow/python/debug/lib/debug_gradients.py index 589a13db7f..5e95bcba47 100644 --- a/tensorflow/python/debug/lib/debug_gradients.py +++ b/tensorflow/python/debug/lib/debug_gradients.py @@ -69,7 +69,7 @@ class GradientsDebugger(object): """Gradients Debugger. Allows retrieval of gradient tensors created by TensorFlow's automatic - differentiation algorithm, i.e., @{tf.gradients} and optimizer classes that + differentiation algorithm, i.e., `tf.gradients` and optimizer classes that use it. """ # TODO(cais): Add examples code in the doc string? @@ -142,8 +142,8 @@ class GradientsDebugger(object): Args: input_tensor: the input `tf.Tensor` object whose related gradient tensors are to be reigstered with this `GradientsDebugger` instance when they - are created, e.g., during @{tf.gradients} calls or the construction - of optimization (training) op that uses @{tf.gradients}. + are created, e.g., during `tf.gradients` calls or the construction + of optimization (training) op that uses `tf.gradients`. Returns: A forwarded identity of `input_tensor`, as a `tf.Tensor`. diff --git a/tensorflow/python/debug/wrappers/dumping_wrapper.py b/tensorflow/python/debug/wrappers/dumping_wrapper.py index 3fac2e5971..c02d5f66ec 100644 --- a/tensorflow/python/debug/wrappers/dumping_wrapper.py +++ b/tensorflow/python/debug/wrappers/dumping_wrapper.py @@ -45,7 +45,7 @@ class DumpingDebugWrapperSession(framework.NonInteractiveDebugWrapperSession): session_root: (`str`) Path to the session root directory. Must be a directory that does not exist or an empty directory. If the directory does not exist, it will be created by the debugger core during debug - @{tf.Session.run} + `tf.Session.run` calls. As the `run()` calls occur, subdirectories will be added to `session_root`. The subdirectories' names has the following pattern: |