Skip to content

Clean up the MLflow 3 docs content#18871

Merged
BenWilson2 merged 4 commits intomlflow:masterfrom
BenWilson2:cleanup-mlflow3-docs
Nov 19, 2025
Merged

Clean up the MLflow 3 docs content#18871
BenWilson2 merged 4 commits intomlflow:masterfrom
BenWilson2:cleanup-mlflow3-docs

Conversation

@BenWilson2
Copy link
Member

@BenWilson2 BenWilson2 commented Nov 17, 2025

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/18871/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/18871/merge#subdirectory=libs/skinny

For Databricks, use the following command:

%sh curl -LsSf https://raw.githubusercontent.com/mlflow/mlflow/HEAD/dev/install-skinny.sh | sh -s pull/18871/merge

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Changes the MLflow 3 docs announcement content to more of a migration guide / FAQ.

How is this PR tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/tracking: Tracking Service, tracking client APIs, autologging
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/evaluation: MLflow model evaluation features, evaluation metrics, and evaluation workflows
  • area/gateway: MLflow AI Gateway client APIs, server, and third-party integrations
  • area/prompts: MLflow prompt engineering features, prompt templates, and prompt management
  • area/tracing: MLflow Tracing features, tracing APIs, and LLM tracing functionality
  • area/projects: MLproject format, project running backends
  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages

How should the PR be classified in the release notes? Choose one:

  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

What is a minor/patch release?
  • Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
    Bug fixes, doc updates and new features usually go into minor releases.
  • Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
    Bug fixes and doc updates usually go into patch releases.
  • Yes (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)

Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@github-actions github-actions bot added v3.6.1 area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. labels Nov 17, 2025
@BenWilson2 BenWilson2 added team-review Trigger a team review request and removed area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. v3.6.1 labels Nov 17, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 17, 2025

Documentation preview for 626545a is available at:

Changed Pages (8)
More info
  • Ignore this comment if this PR does not change the documentation.
  • The preview is updated when a new commit is pushed to this PR.
  • This comment was created by this workflow run.
  • The documentation was built by this workflow run.

@BenWilson2 BenWilson2 added area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. v3.6.1 labels Nov 18, 2025
{
type: 'category',
label: 'MLflow 3.0',
type: 'doc',
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we move this to the bottom of the side bar? I don't think this should be the main page new ppl should see.

```
pip install mlflow openai -U
```
- **Model Flavors**: The following flavors are no longer supported:
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: Can we put a few more flavors we deprecated recently? It's not removed on 3.0, but probably it is helpful to have a comprehensive list.

Comment on lines +141 to +142
result_1 = mlflow.evaluate(model_1, data)
result_2 = mlflow.evaluate(model_2, data)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
result_1 = mlflow.evaluate(model_1, data)
result_2 = mlflow.evaluate(model_2, data)
result_1 = mlflow.model.evaluate(model_1, data)
result_2 = mlflow.model.evaluate(model_2, data)

mlflow.model.evaluate should be used for classical ML. Also can we mention GenAI evaluation here and link to the dedicated migration guide here? https://mlflow.org/docs/latest/genai/eval-monitor/legacy-llm-evaluation/

Probably worth highlighting in the key changes section.


## What's New in MLflow 3?
## Key Changes from MLflow 2.x

Copy link
Collaborator

Choose a reason for hiding this comment

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

One common confusion I heard is that the "artifacts" tab in run page no longer shows model artifact, instead it is moved to logged model page. Can we add it to key changes.


For detailed guidance on migrating specific code, please consult:

- [MLflow Documentation](https://mlflow.org/docs/latest)
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: Let's list Slack?

Copy link
Collaborator

@B-Step62 B-Step62 left a comment

Choose a reason for hiding this comment

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

Overall looks good, let's move the sidebar position to prioritize getting started and main features first.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@BenWilson2 Curious to hear your thoughts, but I realize most of this page is talking about classical ML side. Perhaps this should be surfaced within classical ML side and we don't really need it in GenAI side? Please don't take this as a strong suggestion, just popped up while reading through the contents:)

Copy link
Member Author

Choose a reason for hiding this comment

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

I think that's how we originally had this presented anyway. I agree that the content here is irrelevant for GenAI. Redirect + removal from the GenAI sidebar SGTM

BenWilson2 and others added 2 commits November 18, 2025 10:16
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@BenWilson2 BenWilson2 added this pull request to the merge queue Nov 19, 2025
Merged via the queue into mlflow:master with commit 2ca9e92 Nov 19, 2025
45 checks passed
@BenWilson2 BenWilson2 deleted the cleanup-mlflow3-docs branch November 19, 2025 15:09
Tian-Sky-Lan pushed a commit to Tian-Sky-Lan/mlflow that referenced this pull request Nov 24, 2025
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
Signed-off-by: Tian Lan <sky.blue266000@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. team-review Trigger a team review request v3.6.1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants