Tidy up the tensorboard.main API #620
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change will make it easier to write plugins with custom builds of TensorBoard. The plugin author will no longer be required to explicitly list all the first-party plugins, as they can now be inherited via the `tensorboard.default` module. The `tensorboard.program` module has also been introduced. This module gives a permanent home to all the APIs that crept into `tensorboard.main` over the years. After this change, the `tensorboard.main` module is nothing more than glue between the `program` and `default` modules. The special-case code in main.py that the debugger plugin was using, has now been relocated into the debugger plugin's directory. This change is backwards-compatible. Delegates have been added for relocated functions that will log a deprecation warning if used.
chihuahua
approved these changes
Oct 5, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change will make it easier to write plugins with custom builds of
TensorBoard. The plugin author will no longer be required to explicitly list
all the first-party plugins, as they can now be inherited via the
tensorboard.defaultmodule.The
tensorboard.programmodule has also been introduced. This module gives apermanent home to all the APIs that crept into
tensorboard.mainover theyears. After this change, the
tensorboard.mainmodule is nothing more thanglue between the
programanddefaultmodules.The special-case code in main.py that the debugger plugin was using, has now
been relocated into the debugger plugin's directory.
This change is backwards-compatible. Delegates have been added for relocated
functions that will log a deprecation warning if used.
Proof that this is good
This change, along with #611 which was recently submitted, have allowed me to write tensorflow/tensorboard-plugin-example#18 which removed about a hundred lines of boilerplate the custom tensorboard building process.