tensorflow / tensorflow/tensorboard

Update `--reload_multifile_inactive_secs` default to 86400 in readme

Open
#5,936 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Consider Stack Overflow for getting support using TensorBoard—they have
a larger community with better searchability:

https://stackoverflow.com/questions/tagged/tensorboard

Do not use this template for for setup, installation, or configuration
issues. Instead, use the “installation problem” issue template:

https://github.com/tensorflow/tensorboard/issues/new?template=installation_problem.md

To report a problem with TensorBoard itself, please fill out the
remainder of this template.

Environment information (required)

Please run diagnose_tensorboard.py (link below) in the same
environment from which you normally run TensorFlow/TensorBoard, and
paste the output here:

https://raw.githubusercontent.com/tensorflow/tensorboard/master/tensorboard/tools/diagnose_tensorboard.py

For browser-related issues, please additionally specify:

  • Browser type and version (e.g., Chrome 64.0.3282.140):
  • Screenshot, if it’s a visual issue:

Issue description

Please describe the bug as clearly as possible. How can we reproduce the
problem without additional resources (including external data files and
proprietary Python modules)?

While the --reload_multifile_inactive_secs is already updated to 86400 (24 hours), multiple references in the root README.md still says 4000 seconds.
https://github.com/tensorflow/tensorboard/blob/12a30c324aed62dd4a5af13b4c5e27cbc03b10b0/tensorboard/plugins/core/core_plugin.py#L611

On a side note, the functionality was developed two years ago. Is it still 'experimental'?

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 README.md at the section on multiple or distributed summary writers and compare its --reload_multifile_inactive_secs references with the default shown in tensorboard/plugins/core/core_plugin.py. Update the outdated 4000-second references to 86400 seconds, then verify that all references in that README section are consistent; the experimental-status question is separate and needs a maintainer decision.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.