tensorflow / tensorflow/tensorboard

Show version string in TensorBoard UI

Open
#157 2 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

In https://github.com/tensorflow/tensorboard/issues/150, user had an issue that was made more confusing by the fact that they were actually hitting a stale cache and getting an older version of TensorBoard.

We can make this clearer by presenting the version string in the TensorBoard UI. We could have the core plugin serve a route for this. If we want to avoid the caching issue, we should find a way to inject it into index.html; if we just make a new route served by the core plugin, then possibly the user would get a stale index, but the new route. (Alternatively, we could serve the version string from a route, but ensure it has the same caching policy as index.html? Not quite as robust, but quite possibly easier for us to maintain.)

Actually - I wonder if we could use a BUILD time dependency to get the version string into the UI? @jart @wchargin thoughts?

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

Start by inspecting the core plugin, index.html, and BUILD configuration mentioned in the issue. Compare the proposed route and build-time approaches, including their caching behavior. Done means the TensorBoard UI visibly presents its version string without recreating the stale-cache confusion described here.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
build-system, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.