Skip to content

docs: add "How training works" page#26

Open
divyasinghds wants to merge 4 commits intodevelopfrom
docs/how-training-works
Open

docs: add "How training works" page#26
divyasinghds wants to merge 4 commits intodevelopfrom
docs/how-training-works

Conversation

@divyasinghds
Copy link
Copy Markdown
Contributor

@divyasinghds divyasinghds commented May 7, 2026

Summary

  • Adds 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.
  • Each accordion covers: input format, preprocessing (incl. split strategy), training/validation step, default loss/optimizer, cycle-level metrics with the underlying library calls (sklearn, torchmetrics, lifelines), and inference output.
  • Closes with a 6-step "reproduce locally" checklist so an evaluating user can run the same pipeline on the same data and compare metrics number-for-number.
  • Wired into the Tools & Help group in docs.json.

Replaces #25 (renamed from "pipeline reference" → "How training works"; rebased onto develop).

Test plan

  • mint dev renders the page and the new nav entry appears under Tools & Help
  • All nine accordions expand correctly
  • mint broken-links passes
  • Spot-check by an owner of core/metrics/ and core/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.mdx page that documents the tracebloc client’s shared training lifecycle and per-use-case preprocessing/training/metrics so users can reproduce runs locally.

Updates docs.json navigation to include the new page under Join a Use Case. Also hardens Mintlify build inputs by explicitly ignoring .github/ in .mintignore and fixes a stray leading character in evals.json.

Reviewed by Cursor Bugbot for commit e1acae2. Bugbot is set up for automated code reviews on this repo. Configure here.

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>
@divyasinghds divyasinghds self-assigned this May 7, 2026
@LukasWodka
Copy link
Copy Markdown
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.)

divyasinghds and others added 3 commits May 7, 2026 15:39
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>
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