docs: add "How training works" page#26
Open
divyasinghds wants to merge 4 commits intodevelopfrom
Open
Conversation
Documents the training and inference pipeline for all nine supported use cases so a user evaluating tracebloc can reproduce a run locally and compare metrics against what the platform reports. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
4 tasks
Contributor
|
👋 Heads-up — Code review queue is at 12 / 8 Above the WIP limit. The team convention is to review existing PRs before opening new work. Open PRs currently in Code review (oldest first):
Pull from review before opening new work. (This is a nudge from the kanban WIP check, not a block.) |
The file started with U+200B (UTF-8 e2 80 8b) before the opening bracket, which broke JSON parsing and caused mint dev to fail with a YAML parser error. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Lives between hyperparameters and model optimization, where users are already configuring a run and want to understand what the platform does with their model and data. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
mint dev was parsing .github/pull_request_template.md as MDX and failing on the HTML comments. The file claims .github is auto-ignored but some CLI versions still scan it; listing it explicitly is harmless and unblocks local preview. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced May 7, 2026
Merged
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
tools-help/how-training-works.mdx— a transparency page that walks through what the tracebloc client does to your data and model in each of the nine supported use cases.sklearn,torchmetrics,lifelines), and inference output.docs.json.Replaces #25 (renamed from "pipeline reference" → "How training works"; rebased onto develop).
Test plan
mint devrenders the page and the new nav entry appears under Tools & Helpmint broken-linkspassescore/metrics/andcore/domains/in tracebloc-client that the per-use-case metric lists and loss formulas are accurate (notably segmentation boundary metrics and the Cox loss description)🤖 Generated with Claude Code
Note
Low Risk
Low risk: documentation-only additions plus minor config/JSON formatting tweaks; main risk is broken links/nav rendering if the new page path is wrong.
Overview
Adds a new
join-use-case/how-training-works.mdxpage that documents the tracebloc client’s shared training lifecycle and per-use-case preprocessing/training/metrics so users can reproduce runs locally.Updates
docs.jsonnavigation to include the new page under Join a Use Case. Also hardens Mintlify build inputs by explicitly ignoring.github/in.mintignoreand fixes a stray leading character inevals.json.Reviewed by Cursor Bugbot for commit e1acae2. Bugbot is set up for automated code reviews on this repo. Configure here.