docs: fix broken GenerateCheckWeights notebook + repoint stale Colab link#18
Merged
Merged
Conversation
…link Splits the docs portion out of #15. The fix/pr-15-conflicts branch had correctly resolved these against main; this is the clean cut against main without the CI workflows or stale merge history. - notebooks/GenerateCheckWeights.ipynb: rewrite for 0.8.x SDK. The previous version imported `from tracebloc import ModelWeights`, which no longer exists in 0.8.x — running it on main currently raises ImportError. New version uses importlib + torch.save/pickle directly, matching the file layout the SDK expects (.pth for PyTorch, .pkl for TensorFlow). - README.md + notebooks/traceblocTrainingGuide.ipynb: repoint the Colab badge from the Drive-hosted copy (drive/1N00idtpoaq1lk9OJE6g4bMqd8o-Qex2C) to the GitHub-backed URL (colab.research.google.com/github/tracebloc/start-training/...). The Drive copy required manual sync on every notebook update and drifted; the GitHub form loads the canonical notebook from main directly. - notebooks/traceblocTrainingGuide.ipynb: minor UX — training_object → training, "Dataset" wording aligned with the use-case panel label, Drive-save reminder inlined in Prerequisites, .pth/.pkl extension fix flagged by Cursor Bugbot on #14. Closes #13. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
2 participants
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.
Summary
Splits the docs portion out of #15 (which was conflicting and stale). Clean cut against
main, no CI workflows or merge noise.notebooks/GenerateCheckWeights.ipynbcurrently imports `from tracebloc import ModelWeights`, which doesn't exist in 0.8.x — running it raises ImportError. Rewritten using importlib + torch.save/pickle directly, matching the file layout the SDK expects (`.pth` for PyTorch, `.pkl` for TensorFlow).Closes #13. Supersedes the docs portion of #15.
Test plan
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only changes: updates notebook instructions/links and rewrites a helper notebook to avoid a missing SDK import; no runtime production code paths affected.
Overview
Fixes the broken weights helper notebook.
GenerateCheckWeights.ipynbis rewritten to generate and validate weights directly viaimportlib+torch.save(PyTorch.pth) /pickle(TF.pkl), replacing the staletracebloc.ModelWeightsusage.Updates Colab entry points and guide UX. README and
traceblocTrainingGuide.ipynbnow link to the GitHub-backed Colab URL (instead of a Drive copy), and the training guide tweaks wording and variable naming (trainingObject→training) for consistency.Reviewed by Cursor Bugbot for commit 9c640d3. Bugbot is set up for automated code reviews on this repo. Configure here.