docs: migrate join-use-case API examples to snake_case (0.7.0)#14
Open
divyasinghds wants to merge 1 commit intodevelopfrom
Open
docs: migrate join-use-case API examples to snake_case (0.7.0)#14divyasinghds wants to merge 1 commit intodevelopfrom
divyasinghds wants to merge 1 commit intodevelopfrom
Conversation
…kage 0.7.0) Sync hyperparameters and start-training pages with the legacy tracebloc/documentation repo: - Rename camelCase API methods to snake_case: upload_model, link_model_dataset, experiment_name, get_training_plan, learning_rate, loss_function, layers_freeze, early_stop_callback, reduce_lr_callback, model_checkpoint_callback, terminate_on_nan_callback, training_classes, data_type - Rename trainingObject → training - Update terminate-on-NaN description (any NaN loss) - Use pip optional-extras syntax: tracebloc_package[pytorch|tensorflow|sklearn|all] Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced May 6, 2026
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.
Summary
Sync the join-use-case pages with the snake_case API that landed in
tracebloc_package0.7.0. Split out from #13.upload_model,link_model_dataset,experiment_name,get_training_plan,learning_rate,loss_function,layers_freeze,early_stop_callback,reduce_lr_callback,model_checkpoint_callback,terminate_on_nan_callback,training_classes,data_typetrainingObject→trainingpip installsnippet to optional-extras syntax:tracebloc_package[pytorch|tensorflow|sklearn|all]Test plan
mint devrenders hyperparameters and start-training pages without MDX errorstracebloc-py-package0.7.0 public API🤖 Generated with Claude Code
Note
Low Risk
Low risk documentation-only updates, but incorrect method names or install extras would directly confuse users following the training guide.
Overview
Updates the Join Use Case docs to match the
tracebloc_package0.7.0 snake_case Python API by renamingtrainingObjecttotrainingand converting all example calls (e.g.,upload_model,link_model_dataset,get_training_plan,learning_rate, callbacks, and dataset config setters).Also revises the installation snippet to use framework-specific pip extras (e.g.,
tracebloc_package[pytorch|tensorflow|sklearn|all]) and clarifies the terminate-on-NaN callback wording.Reviewed by Cursor Bugbot for commit 5083264. Bugbot is set up for automated code reviews on this repo. Configure here.