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

notebook: relocate to %load_ext tensorboard #2119

Merged
merged 1 commit into from
Apr 17, 2019

Conversation

wchargin
Copy link
Contributor

Summary:
“Drop the .notebook. It’s cleaner.” (Fixes #1857.)

Using %load_ext tensorboard.notebook now gives users a helpful error.

This is a breaking change, which we think is okay because (a) notebook
support was always explicitly marked as “alpha” in release notes and
“experimental” in the code, and (b) notebooks are meant to be run
interactively, so the fix will be easy and immediate.

Test Plan:
Built the Pip package and installed it into a new virtualenv, then
verified that %load_ext tensorboard.notebook properly emits an error
message, which directs users to the working %load_ext tensorboard:

Screenshot

Tested the above with tf-nightly and tf-nightly-2.0-preview. Also
verified that the getting_started.ipynb notebook still works, from
start to finish, within the new virtualenv.

Verified that there are no lingering references to the old endpoint:

$ git grep '%load_ext tensorboard.notebook'
tensorboard/notebook.py:      "Use '%load_ext tensorboard' instead of '%load_ext tensorboard.notebook'."

wchargin-branch: notebook-extension-at-root

Summary:
“Drop the `.notebook`. It’s cleaner.” (Fixes #1857.)

Using `%load_ext tensorboard.notebook` now gives users a helpful error.

This is a breaking change, which we think is okay because (a) notebook
support was always explicitly marked as “alpha” in release notes and
“experimental” in the code, and (b) notebooks are meant to be run
interactively, so the fix will be easy and immediate.

Test Plan:
Built the Pip package and installed it into a new virtualenv, then
verified that `%load_ext tensorboard.notebook` properly emits an error
message, which directs users to the working `%load_ext tensorboard`:

![Screenshot](https://user-images.githubusercontent.com/4317806/56316051-32217280-610e-11e9-83b9-522b2bad5493.png)

Tested the above with `tf-nightly` and `tf-nightly-2.0-preview`. Also
verified that the `getting_started.ipynb` notebook still works, from
start to finish, within the new virtualenv.

Verified that there are no lingering references to the old endpoint:

```
$ git grep '%load_ext tensorboard.notebook'
tensorboard/notebook.py:      "Use '%load_ext tensorboard' instead of '%load_ext tensorboard.notebook'."
```

wchargin-branch: notebook-extension-at-root
@wchargin wchargin requested a review from nfelt April 17, 2019 19:53
@review-notebook-app
Copy link

Check out this pull request on ReviewNB: https://app.reviewnb.com/tensorflow/tensorboard/pull/2119

Visit www.reviewnb.com to know how we simplify your Jupyter Notebook workflows.

Copy link
Contributor

@nfelt nfelt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A million dollars isn't cool. You know what's cool?

%load_ext tensorboard

@wchargin wchargin merged commit d909214 into master Apr 17, 2019
@wchargin wchargin deleted the wchargin-notebook-extension-at-root branch April 17, 2019 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move Jupyter/Colab extension to base tensorboard
2 participants