tensorflow / tensorflow/tensorboard

Trim down/split up setup section of notebooks tutorial

Open
#2,937 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type:docs
Dominant language
TypeScript
Stars
7.2k
Forks
1.7k
Avg merge
4d 22h
Merged PRs (30d)
1

Description

The “TensorBoard in notebooks” tutorial 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:

```python
import datetime, os
```

```python
fashion_mnist = ...
```

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked “TensorBoard in notebooks” tutorial and inspect its Setup section and first code block. Move the cross-virtualenv Jupyter and Docker guidance into an Advanced setup section after the common %load_ext tensorboard instruction, with notes linking to it; done when the common setup is immediately visible and the edge cases remain documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, jupyter-notebook, tensorflow
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.