Repository navigation
Conversation
The docstring called tensorboard_name the sub-directory inside tensorboard_save_dir, but the TensorBoard logger uses experiment_name and nothing reads tensorboard_name; the observability guide already says so. Fixes #595
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #595
Problem
The
ObservabilityConfigdocstring describedtensorboard_nameas the "Sub-directory / experiment label insidetensorboard_save_dir". Nothing reads the field: the TensorBoard logger usesname=config.experiment_name, so TensorBoard files go to<tensorboard_save_dir>/<experiment_name>/<YYYYMMDD_HHMMSS>_<run_id>/.docs/core_concepts/observability.mdalready calls it a reserved field.Change
Docstring only,
deeptab/core/observability.py:tensorboard_nameis described as reserved and currently unused, with the actual TensorBoard location. The location uses the<YYYYMMDD_HHMMSS>_<run_id>run-folder name that the same docstring's directory tree uses.Checks
just test: 3236 passed, 46 skipped, 28 xfailed; coverage 91.29%just docs: build succeeded (warnings treated as errors)just check: all hooks passed (ruff, prettier, pyright)