Repository navigation
Conversation
The tutorial passed default_root_dir to place the plain fit() checkpoint, but without an ObservabilityConfig the checkpoint goes to model_checkpoints/<timestamp>_<run_id>/ under the working directory, so the documented tree never appeared. Explain the location and use checkpoint_path instead, in the tutorial page and its notebook. Fixes #579
Section 7b hands a logger straight to fit() without an ObservabilityConfig, so its checkpoint also went to model_checkpoints/ under the working directory. Refs #579
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 #579
Problem
The observability tutorial placed the checkpoint of a plain
fit()withdefault_root_dir. Without anObservabilityConfig, DeepTab givesModelCheckpointan explicitdirpathundercheckpoint_path(defaultmodel_checkpoints/, relative to the working directory), sodefault_root_dirhas no effect. The tutorial wrote into the reader's working directory, the documented01_no_observability/checkpoints/best_model.ckpttree never appeared, and the notebook's own output said "(nothing was created here)".Change
Docs only:
docs/tutorials/observability.md: section 1 explains where the checkpoint goes and whydefault_root_dirdoesn't move it, and callstrain(checkpoint_path=str(WORKDIR / "01_no_observability" / "checkpoints")). The direct-logger fit in section 7b and the custom-sink fit in section 7c usecheckpoint_pathtoo; section 7b's text and tree now mention the checkpoint next to the logger's files. The trees in sections 1, 7b and 8 are now what the code produces.docs/tutorials/notebooks/observability.ipynb: the same changes in the matching markdown and code cells. The recorded outputs of theshow_treecells in sections 1 and 7b are updated to the trees the corrected calls print. I checked those outputs by running the two fits; I didn't re-execute the whole notebook.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)