Skip to content

Clean up SparkML docs#18811

Merged
BenWilson2 merged 2 commits intomlflow:masterfrom
BenWilson2:spark-docs-cleanup
Nov 13, 2025
Merged

Clean up SparkML docs#18811
BenWilson2 merged 2 commits intomlflow:masterfrom
BenWilson2:spark-docs-cleanup

Conversation

@BenWilson2
Copy link
Member

@BenWilson2 BenWilson2 commented Nov 12, 2025 •
edited by github-actions bot
Loading

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/18811/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/18811/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/18811/merge

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Remove loads of junk from the SparkML docs

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)

@BenWilson2
Clean up SparkML docs
8131dff 
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 12, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 12, 2025 •
edited
Loading

Documentation preview for f4c6422 is available at:

Changed Pages (2)
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.

Copilot AI reviewed Nov 12, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR cleans up the Spark MLlib documentation by removing verbose, marketing-style content and simplifying the structure to be more concise and practical.

Key Changes

  • Replaced extensive feature descriptions with a concise FeatureHighlights component showing key capabilities
  • Condensed multiple sections with redundant information into focused subsections
  • Simplified code examples while maintaining technical accuracy

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/docs/classic-ml/traditional-ml/sparkml/index.mdx Streamlined overview page with concise feature highlights, removed verbose marketing content, and simplified navigation links
docs/docs/classic-ml/traditional-ml/sparkml/guide/index.mdx Condensed comprehensive guide by removing redundant examples and explanations, focusing on essential usage patterns for model logging, deployment formats, datasource autologging, and model registry

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

WeichenXu123
WeichenXu123 reviewed Nov 13, 2025
View reviewed changes
docs/docs/classic-ml/traditional-ml/sparkml/guide/index.mdx Outdated
<TabItem value="pyfunc" label="PyFunc Format">

The PyFunc format enables deployment outside of Spark environments:
Enables deployment without Spark infrastructure:
Copy link
Collaborator

@WeichenXu123 WeichenXu123 Nov 13, 2025

Choose a reason for hiding this comment

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

without Spark infrastructure:

this might not be accurate,
it still depends on apache/spark library, and it needs to launch a local mode spark cluster for model inference.

Copy link
Member Author

@BenWilson2 BenWilson2 Nov 13, 2025

Choose a reason for hiding this comment

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

Yeah I think I need to say "it doesn't need to run IN Spark to work" . I'll update :D Good call out

WeichenXu123
WeichenXu123 approved these changes Nov 13, 2025
View reviewed changes
Copy link
Collaborator

@WeichenXu123 WeichenXu123 left a comment

Choose a reason for hiding this comment

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

LGTM except one comment

B-Step62
B-Step62 approved these changes Nov 13, 2025
View reviewed changes
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.

LGTM, can we actually merge 2 pages into one?

@BenWilson2
fix
f4c6422 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@BenWilson2 BenWilson2 enabled auto-merge November 13, 2025 22:35
@BenWilson2 BenWilson2 added this pull request to the merge queue Nov 13, 2025
Merged via the queue into mlflow:master with commit aa67507 Nov 13, 2025
45 checks passed
@BenWilson2 BenWilson2 deleted the spark-docs-cleanup branch November 13, 2025 23:03
mprahl pushed a commit to opendatahub-io/mlflow that referenced this pull request Nov 21, 2025
@BenWilson2 @mprahl
Clean up SparkML docs (mlflow#18811)
0cdba1c 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
Tian-Sky-Lan pushed a commit to Tian-Sky-Lan/mlflow that referenced this pull request Nov 24, 2025
@BenWilson2 @Tian-Sky-Lan
Clean up SparkML docs (mlflow#18811)
bb4ae43 
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

Reviewers

Copilot code review Copilot Copilot left review comments

@WeichenXu123 WeichenXu123 WeichenXu123 approved these changes

@B-Step62 B-Step62 B-Step62 approved these changes

Assignees

No one assigned

Labels

area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. v3.6.1

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@BenWilson2 @WeichenXu123 @B-Step62