tensorflow / tensorboard

TensorFlow's Visualization Toolkit
Apache License 2.0
6.71k stars 1.66k forks source link

Trim down/split up setup section of notebooks tutorial #2937

Open wchargin opened 4 years ago

wchargin commented 4 years ago

The [“TensorBoard in notebooks” tutorial][1] starts with setup instructions, which makes sense. But while the setup instructions for 90% of users are just %load_ext tensorboard, the first four paragraphs of the section, including the first code block, are for niche edge cases like cross-virtualenv Jupyter installs and Docker users. This makes it hard to find what most users should actually run.

We should consider relegating the edge-case setup instructions to the end of the notebook, and put a note referring to them after the common setup:

# Setup

Start by installing TF 2.0 and loading the TensorBoard notebook extension:

```python
%load_ext tensorboard

For Jupyter users: If you use a non-standard virtualenv setup and are running into problems, see “Advanced setup” below.

For Docker users: See “Advanced setup” below.

TensorBoard in notebooks

Download the [FashionMNIST] dataset and scale it:

import datetime, os
fashion_mnist = ...


[1]: https://www.tensorflow.org/tensorboard/tensorboard_in_notebooks
captain-pool commented 4 years ago

Hey, @wchargin I'm one of the mentors of Google Code-In. Can I take this issue and add it as one of the tasks?

wchargin commented 4 years ago

Hi @captain-pool! Yes, please feel free. Let me know if you need anything.

Hizees commented 4 years ago

My name is Shu wenjian. I like yellow shirt and blue pants. my hobby is tennis. I like sports very much. I want to be good friends with Wang Jia. thank you. Can you join us?

C-Anirudh commented 4 years ago

Hi @wchargin , this issue hasn't been worked upon yet, can I take this up? I would like to contribute to TensorBoard :)