Skip to content

docs: add MLflow integration documentation to fine-tuning examples#84

Open
briangallagher wants to merge 1 commit into
red-hat-data-services:mainfrom
briangallagher:add-mlflow-integration
Open

docs: add MLflow integration documentation to fine-tuning examples#84
briangallagher wants to merge 1 commit into
red-hat-data-services:mainfrom
briangallagher:add-mlflow-integration

Conversation

@briangallagher
Copy link
Copy Markdown
Contributor

Summary

  • Adds an MLflow Integration section to the READMEs for lora, osft, and sft fine-tuning examples
  • Documents how to enable MLflow on the cluster, what the notebook cells do, and how to navigate to the Experiments page in the RHOAI dashboard
  • Includes screenshots showing the Launch MLflow link and the left-nav path (Develop & train > Experiments)
  • Clarifies that MLflow tracking is available for interactive (single-node) notebooks only — distributed training does not currently support it

The interactive notebooks already contain the MLFLOW_EXPERIMENT_NAME environment variable cells; this PR adds the missing README documentation so users know how to take advantage of the feature.

Test plan

  • Verified MLflow operator can be enabled on RHOAI 3.4 cluster (DataScienceCluster patched to Managed)
  • Verified MLflow instance deploys successfully (v3.12.0, Available=True)
  • Confirmed the Experiments page renders in the RHOAI dashboard with Launch MLflow link
  • Screenshots captured from live cluster
  • Run through an interactive notebook to confirm metrics appear in MLflow (manual test)

Made with Cursor

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 20, 2026

Review Change Stack

Warning

Rate limit exceeded

@briangallagher has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 39 minutes and 29 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: ba744834-90de-4ce8-8ec5-037eceb33277

📥 Commits

Reviewing files that changed from the base of the PR and between 34bae7c and 704462c.

⛔ Files ignored due to path filters (2)
  • examples/fine-tuning/images/mlflow-experiments.png is excluded by !**/*.png
  • examples/fine-tuning/images/mlflow-run-metrics.png is excluded by !**/*.png
📒 Files selected for processing (3)
  • examples/fine-tuning/lora/README.md
  • examples/fine-tuning/osft/README.md
  • examples/fine-tuning/sft/README.md
📝 Walkthrough

Walkthrough

Three fine-tuning example READMEs (LoRA, OSFT, SFT) are updated with parallel optional "MLflow Integration" sections explaining how to enable MLflow on the cluster, its interactive-notebook-only scope, and instructions to view experiments and runs through the OpenShift AI dashboard with screenshot references.

Changes

MLflow Integration Documentation

Layer / File(s) Summary
MLflow Integration guidance across fine-tuning examples
examples/fine-tuning/lora/README.md, examples/fine-tuning/osft/README.md, examples/fine-tuning/sft/README.md
Three fine-tuning example READMEs each add a parallel optional "MLflow Integration" section documenting enablement in the OpenShift AI dashboard, noting support is limited to interactive/single-node notebooks, and providing steps and screenshots for viewing experiments and launching the MLflow UI.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding MLflow integration documentation to the fine-tuning example READMEs, which matches the changeset perfectly.
Description check ✅ Passed The description is well-related to the changeset, providing detailed context about what was added, why it matters, and test verification completed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Comment thread examples/fine-tuning/lora/README.md Outdated
**To enable MLflow on your cluster:**

1. In the OpenShift AI dashboard, navigate to **Settings** → **Cluster settings**.
2. Under **Model experiment tracking**, ensure that **MLflow** is enabled.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey @briangallagher
I don't see this option in RHOAI UI.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated with new instructions

Copy link
Copy Markdown

@Fiona-Waters Fiona-Waters left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of comments. For the screenshots, I don't think they should include your email login and the project name could be something more generic like fine-tuning.
Also rather than duplicating the MLflow details in each readme, could we add mlflow.md and link to it in each README?

@briangallagher briangallagher force-pushed the add-mlflow-integration branch from 34bae7c to 8b53222 Compare May 21, 2026 09:19
Add an MLflow Integration section to the READMEs for lora, osft, and
sft fine-tuning examples. Documents how to enable MLflow on the cluster
via the DataScienceCluster CR and MLflow CR, what the notebook cells do,
and how to navigate to the Experiments page in the RHOAI dashboard.

MLflow tracking is available for interactive (single-node) notebooks
only — distributed training does not currently support it.

Co-authored-by: Cursor <cursoragent@cursor.com>
@briangallagher briangallagher force-pushed the add-mlflow-integration branch from 8b53222 to 704462c Compare May 21, 2026 09:31
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.

3 participants