docs: add use case pipeline reference page#25
Closed
divyasinghds wants to merge 1 commit intomainfrom
Closed
Conversation
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>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.) |
4 tasks
Contributor
Author
|
Superseded by #26 — renamed to "How training works" and rebased onto develop. |
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/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.sklearn,torchmetrics,lifelines), and inference output.docs.json.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 change; primary risk is incorrect or outdated pipeline details potentially confusing users.
Overview
Adds a new
tools-help/pipeline-reference.mdxtransparency 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.jsonso 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.