docs(guides): add MLflow experiment tracking guide - #93
Conversation
Document current MLflow behavior from eval-hub, eval-hub-sdk, and eval-hub-contrib, and cross-link related pages that previously only mentioned tracking in passing. Assisted-by: Cursor Signed-off-by: Julian Payne <julpayne@redhat.com> Co-authored-by: Cursor <cursoragent@cursor.com>
|
Warning Review limit reached
Next review available in: 5 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughAdds a new MLflow guide and updates EvalHub documentation for tracking configuration, experiment submission, adapter callbacks, CLEAR trace ingestion, troubleshooting, navigation, and related references. ChangesMLflow documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/content/docs/adapters/clear/index.md`:
- Line 65: Update the CLEAR adapter documentation to state that experiment.name
is the default experiment for logging results, while
parameters.mlflow_experiment_name overrides it when provided. Also revise the
workflow wording near the earlier experiment description to use this same
default-and-override behavior, while preserving the separate input-trace
setting.
In `@src/content/docs/getting-started/quickstart.mdx`:
- Around line 313-324: Update the Python quickstart example’s imports to include
JobSubmissionRequest, ModelConfig, and BenchmarkConfig alongside the existing
ExperimentConfig and ExperimentTag imports, so every model constructed in the
submission example is defined.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: e40905f7-a6a4-4c41-be0b-a25ec6462c6f
📒 Files selected for processing (11)
astro.config.mjssrc/content/docs/adapters/clear/index.mdsrc/content/docs/architecture/system-overview.mdsrc/content/docs/getting-started/quickstart.mdxsrc/content/docs/guides/cli.mdxsrc/content/docs/guides/local-mode-tutorial.mdxsrc/content/docs/guides/local-mode.mdxsrc/content/docs/guides/mlflow.mdxsrc/content/docs/home.mdxsrc/content/docs/mcp/tools.mdsrc/content/docs/reference/server-api.md
Signed-off-by: Julian Payne <julpayne@redhat.com>
…ocumentation Signed-off-by: Julian Payne <julpayne@redhat.com>
…verview documentation Signed-off-by: Julian Payne <julpayne@redhat.com>
Summary
odh/upstream), CLEAR trace fetch vs result upload, and troubleshooting — verified against eval-hub, eval-hub-sdk, and eval-hub-contribmlflow.*config keys and CLEARmlflow_traces_*parametersTest plan
npm run build)/guides/mlflow/{key,value}) vs MCP (map) behaviorMade with Cursor
Summary by CodeRabbit
New Features
Documentation