Skip to content

docs: add use case pipeline reference page#25

Closed
divyasinghds wants to merge 1 commit intomainfrom
docs/use-case-pipeline-reference
Closed

docs: add use case pipeline reference page#25
divyasinghds wants to merge 1 commit intomainfrom
docs/use-case-pipeline-reference

Conversation

@divyasinghds
Copy link
Copy Markdown
Contributor

@divyasinghds divyasinghds commented May 7, 2026

Summary

  • Adds tools-help/pipeline-reference.mdx — a transparency page that documents 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.

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 change; primary risk is incorrect or outdated pipeline details potentially confusing users.

Overview
Adds a new tools-help/pipeline-reference.mdx transparency page that documents the tracebloc client’s end-to-end training/inference lifecycle and per-use-case preprocessing, loss/optimizer defaults, and cycle-level metrics across supported tasks.

Wires the page into the Tools & Help section of docs.json so it appears in the docs navigation, and includes a short checklist for reproducing runs locally and comparing metrics.

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

Documents the training/inference pipeline for all nine supported use
cases so users can reproduce runs 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
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 7, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tracebloc 🟢 Ready View Preview May 7, 2026, 9:58 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@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
Copy link
Copy Markdown
Contributor Author

Superseded by #26 — renamed to "How training works" and rebased onto develop.

@divyasinghds divyasinghds deleted the docs/use-case-pipeline-reference branch May 7, 2026 10:04
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