Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecating the Beholder plugin #3843

Closed
nfelt opened this issue Jul 15, 2020 · 2 comments · Fixed by #3881
Closed

Deprecating the Beholder plugin #3843

nfelt opened this issue Jul 15, 2020 · 2 comments · Fixed by #3881
Assignees

Comments

@nfelt
Copy link
Contributor

nfelt commented Jul 15, 2020

The TensorBoard team plans to deprecate the Beholder plugin contributed a few years ago by Chris Anderson (cc @chrisranderson).

What this means concretely is that we will mark the plugin as deprecated in our next release, and remove it in the following release. We don't consider this a breaking change that requires a major version bump since Beholder has been indicated as only in beta since it was contributed.

We recognize that Beholder has value for users, but we haven't had the bandwidth to maintain the plugin and make necessary changes to update it to work with TF 2.0 or eager mode (#1237), or to continue keeping the frontend web components up-to-date as the TensorBoard frontend evolves.

If you are still using Beholder and would like to continue using it in newer versions of TensorBoard, we recommend pursuing converting it to a dynamic plugin as outlined in the plugin guide, which would mean hosting it in a separate git repository and publishing it to PyPI as a tensorboard_plugin_beholder package, which users can then install if they wish to still use Beholder.

@chrisranderson
Copy link
Contributor

<3 Happy people got to use it, thank you for your help. I had a great experience with the project.

nfelt added a commit to nfelt/tensorboard that referenced this issue Jul 16, 2020
Sample message:

```
tensorboard/plugins/beholder/beholder_demo.py:215: UserWarning:
======================================================================
Beholder is deprecated and will be removed in a future TensorBoard
release. See tensorflow#3843
======================================================================
  beholder = beholder_lib.Beholder(logdir=LOG_DIRECTORY)
```
nfelt added a commit to nfelt/tensorboard that referenced this issue Jul 16, 2020
nfelt added a commit that referenced this issue Jul 16, 2020
* Add deprecation message to README.md

* Emit deprecation warning when using Beholder python API

Sample message:

```
tensorboard/plugins/beholder/beholder_demo.py:215: UserWarning:
======================================================================
Beholder is deprecated and will be removed in a future TensorBoard
release. See #3843
======================================================================
  beholder = beholder_lib.Beholder(logdir=LOG_DIRECTORY)
```

* Add deprecation message to Beholder dashboard page

* typo: fix banner link text to #3843
@nfelt nfelt self-assigned this Jul 16, 2020
@nfelt
Copy link
Contributor Author

nfelt commented Jul 24, 2020

Thank you Chris again for your contribution! We've marked Beholder as deprecated in the 2.3.0 release of TensorBoard, and plan now to remove it at HEAD / nightly, so 2.4.0 will no longer contain Beholder. As mentioned if folks are interested in picking up the code as a dynamic plugin, just comment on the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants