Skip to content

notebook API renames + install pin bump for tracebloc_package 0.7.0#7

Draft
aptracebloc wants to merge 2 commits intomainfrom
docs/notebook-update-for-0.7.0
Draft

notebook API renames + install pin bump for tracebloc_package 0.7.0#7
aptracebloc wants to merge 2 commits intomainfrom
docs/notebook-update-for-0.7.0

Conversation

@aptracebloc
Copy link
Copy Markdown

⚠️ Draft — do not merge until tracebloc_package 0.7.0 ships to real PyPI

The notebook's install cell pins >=0.7.0. If this PR merges before 0.7.0 is published, every user running the guide will hit "Could not find a version that satisfies the requirement."

Summary

Combines two notebook updates into a single 0.7.0-targeted PR:

  1. Install extras (originally @LukasWodka's #4) — the install line uses optional dependency groups ([pytorch], [tensorflow], [all]) shipping in tracebloc_package 0.6.33+. Pin bumped to >=0.7.0 since 0.6.33 is being collapsed into 0.7.0 (SDK.2/3 breaking-change work landed on tracebloc_package@develop and the next public release is 0.7.0).
  2. API renames for the SDK.2 method-rename sweep: 5 deprecated camelCase methods called in code cells, plus 4 in the cell 16 reference table.

Changes

notebooks/traceblocTrainingGuide.ipynb

Cell Type Before After
3 code tracebloc_package[pytorch]>=0.6.33 tracebloc_package[pytorch]>=0.7.0
11 code user.uploadModel(MODEL_PATH) user.upload_model(MODEL_PATH)
12 markdown user.uploadModel(MODEL_PATH, weights=True) (docs) user.upload_model(...)
14 code user.linkModelDataset(DATASET_ID) user.link_model_dataset(DATASET_ID)
16 markdown experimentName, learningRate, getTrainingPlan, resetTrainingPlan (table) snake_case throughout
17 code trainingObject.experimentName(...) + trainingObject.getTrainingPlan() experiment_name(...) + get_training_plan()

README.md

Three install lines bumped from >=0.6.33 to >=0.7.0.

Why all method calls survive (no TypeError risks)

  • DATASET_ID and MODEL_PATH are passed positionally — none of the SDK.2 kwarg renames (datasetIddataset_id, etc.) apply
  • Every method renamed in this PR has a deprecated_method_alias on the Python side, so the camelCase variants still work and just emit DeprecationWarning. This PR is about cleaning up the user-facing surface, not unblocking any breakage

Why this supersedes #4

@LukasWodka's #4 was scoped to 0.6.33 install-extras only. The 0.6.33 release path is being collapsed into 0.7.0 now that the SDK.2/3 breaking-change work has landed on tracebloc_package@develop. Cleaner to ship both changes in one PR than coordinate two sequential start-training releases.

#4's commit (eeae340) is preserved as the parent of this branch — Lukas's authorship on that commit is intact.

Merge coordination

Same as #4 — needs same-day with:

  • tracebloc/tracebloc-py-package@v0.7.0 going live on real PyPI
  • tracebloc/docs PR for the Mintlify setup guide
  • tracebloc/tracebloc-website-main PR for the homepage quick-start snippet

Test plan

Static edits only — notebook was not executed. Pre-merge checklist for whoever runs the guide end-to-end:

  • After 0.7.0 ships to PyPI, run the Colab notebook end-to-end: install → login → upload → link → start
  • Run the local quickstart from README (step-by-step)
  • Confirm no DeprecationWarnings surface (the renames here are the only deprecated symbols touched in the guide)

🤖 Generated with Claude Code

LukasWodka and others added 2 commits April 17, 2026 17:09
Aligns with the optional-dependency-groups change shipping in
tracebloc-py-package 0.6.33. Default install no longer bundles every
ML framework — users pick the extra that matches their setup.

- README.md: 3-line extras table in the local-setup section.
- notebooks/traceblocTrainingGuide.ipynb cell 3: switch install cmd to
  [pytorch] as the most common setup; comment points at [tensorflow]
  and [all].

DO NOT MERGE until tracebloc_package 0.6.33 is live on real PyPI.
Currently 0.6.33 is only on TestPyPI.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Builds on top of the install-extras change (eeae340) and broadens scope
for the upcoming tracebloc_package 0.7.0 release.

Notebook changes (notebooks/traceblocTrainingGuide.ipynb):
- Cell 3 install pin: >=0.6.33 -> >=0.7.0
- Cell 11: user.uploadModel(MODEL_PATH) -> user.upload_model(MODEL_PATH)
- Cell 12 (markdown docs example): same uploadModel rename
- Cell 14: user.linkModelDataset(DATASET_ID) -> user.link_model_dataset(DATASET_ID)
- Cell 16 (reference table): experimentName, learningRate, getTrainingPlan,
  resetTrainingPlan -> experiment_name, learning_rate, get_training_plan,
  reset_training_plan
- Cell 17: experimentName + getTrainingPlan call sites updated

README.md: pip install lines bumped from >=0.6.33 to >=0.7.0 across all
three extras (pytorch, tensorflow, all).

Static rewrite only; the notebook was not executed (requires real
workspace credentials). All deprecated symbols touched here have
deprecation aliases on the Python side, so callers using the old names
would still work but emit DeprecationWarning.

Supersedes #4 (which was scoped only to the 0.6.33 install-extras
migration). The 0.6.33 release path is being collapsed into 0.7.0 now
that SDK.2/3 work has landed on develop, so this PR ships both changes
together.

Cannot merge until tracebloc_package 0.7.0 is published to real PyPI —
same merge-coordination block as #4.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@aptracebloc aptracebloc changed the title docs: notebook API renames + install pin bump for tracebloc_package 0.7.0 notebook API renames + install pin bump for tracebloc_package 0.7.0 Apr 27, 2026
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.

2 participants