Skip to content

docs: switch install to extras syntax for tracebloc_package 0.6.33#4

Draft
LukasWodka wants to merge 1 commit intomainfrom
docs/install-extras-for-0.6.33
Draft

docs: switch install to extras syntax for tracebloc_package 0.6.33#4
LukasWodka wants to merge 1 commit intomainfrom
docs/install-extras-for-0.6.33

Conversation

@LukasWodka
Copy link
Copy Markdown
Contributor

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

Currently 0.6.33 is only on TestPyPI. If this PR merges before the prod release, pip install "tracebloc_package[pytorch]>=0.6.33" will fail with "Could not find a version that satisfies the requirement".

Summary

Updates the start-training install instructions to use the new optional dependency groups shipping in tracebloc_package 0.6.33. Default install no longer bundles every ML framework — users pick the extra that matches their setup.

Changes

File Change
README.md Replace single pip install tracebloc_package>=0.6.32 with 3-line extras table (pytorch / tensorflow / all)
notebooks/traceblocTrainingGuide.ipynb (cell 3) !pip install tracebloc_package>=0.6.32 -q!pip install "tracebloc_package[pytorch]>=0.6.33" -q with comment pointing at TensorFlow and [all]

Why pytorch as default

  • ~80%+ of tracebloc use cases today use PyTorch
  • PyTorch is already pre-installed in Google Colab T4 runtime, so pip install "tracebloc_package[pytorch]" on Colab adds only the SDK itself + a few small deps
  • TensorFlow and [all] are documented as one-character substitutions in the comment

Merge coordination

Same-day merge required with:

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

Note about the diff

The NotebookEdit tool re-serialized the .ipynb, which expanded unicode escapes (\u2705) throughout. Those lines are visual no-ops — only cell 3 has functional changes.

Test plan

  • After 0.6.33 ships to PyPI, run the Colab notebook end-to-end: install cell → login → upload → link → start
  • Run the local quickstart from README (step-by-step)
  • Confirm install time drops from 10-15 min to ~2 min on Colab T4

🤖 Generated with Claude Code

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>
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.

1 participant