Skip to content

docs: keep the observability tutorial's checkpoint in its scratch folder - #580

Open
ChrisW09 wants to merge 2 commits into
mainfrom
docs/observability-checkpoint-path
Open

ChrisW09 wants to merge 2 commits into
mainfrom
docs/observability-checkpoint-path

Conversation

@ChrisW09

@ChrisW09 ChrisW09 commented Oct 21, 2026 •

Copy link
Copy Markdown
Collaborator

Fixes #579

Problem

The observability tutorial placed the checkpoint of a plain fit() with default_root_dir. Without an ObservabilityConfig, DeepTab gives ModelCheckpoint an explicit dirpath under checkpoint_path (default model_checkpoints/, relative to the working directory), so default_root_dir has no effect. The tutorial wrote into the reader's working directory, the documented 01_no_observability/checkpoints/best_model.ckpt tree 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 why default_root_dir doesn't move it, and calls train(checkpoint_path=str(WORKDIR / "01_no_observability" / "checkpoints")). The direct-logger fit in section 7b and the custom-sink fit in section 7c use checkpoint_path too; 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 the show_tree cells 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)

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

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] Observability tutorial uses default_root_dir, which does not move the checkpoint of a plain fit()

1 participant