Skip to content

Add skops saving format for lightgbm flavor#20151

Merged
BenWilson2 merged 7 commits intomlflow:masterfrom
WeichenXu123:lightgbm-skops
Jan 22, 2026
Merged

Add skops saving format for lightgbm flavor#20151
BenWilson2 merged 7 commits intomlflow:masterfrom
WeichenXu123:lightgbm-skops

Conversation

@WeichenXu123
Copy link
Collaborator

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Added skops saving format for lightgbm flavor

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?

Added skops saving format for lightgbm flavor

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: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Copilot AI review requested due to automatic review settings January 20, 2026 14:06
@github-actions
Copy link
Contributor

🛠 DevTools 🛠

Install mlflow from this PR

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

@WeichenXu123
Copy link
Collaborator Author

/autoformat

@github-actions github-actions bot added area/tracking Tracking service, tracking client APIs, autologging rn/feature Mention under Features in Changelogs. labels Jan 20, 2026
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 pull request adds support for the skops serialization format to the LightGBM flavor, enabling safer model serialization and deserialization for LightGBM scikit-learn API models. The implementation leverages sklearn's existing save and load functions for non-Booster models, introducing new parameters serialization_format and skops_trusted_types to both save_model and log_model functions.

Changes:

  • Added serialization_format and skops_trusted_types parameters to lightgbm's save_model and log_model functions
  • Refactored _save_model and _load_model to delegate to sklearn's serialization functions for non-Booster models
  • Updated documentation to reflect the new serialization options
  • Relocated security warning from sklearn's public API to internal _save_model function
  • Added test for saving and loading LightGBM models using skops format

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
mlflow/lightgbm/init.py Added skops serialization support by introducing new parameters and refactoring save/load logic to use sklearn's serialization functions for non-Booster models
mlflow/sklearn/init.py Refactored warning message location and updated documentation for serialization format parameter
tests/lightgbm/test_lightgbm_model_export.py Added test case for saving and loading models with skops serialization format

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

@github-actions
Copy link
Contributor

github-actions bot commented Jan 20, 2026

Documentation preview for 4a8aaf9 is available at:

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.

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
@WeichenXu123 WeichenXu123 added the team-review Trigger a team review request label Jan 20, 2026
path=model_path,
serialization_format="skops",
skops_trusted_types=[
"collections.OrderedDict",
Copy link
Member

Choose a reason for hiding this comment

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

Are these pretty common? If so, we might want to add these as examples to the docstring for this argument

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes it is common.

If skops_trusted_types is not set correctly, user will get clear message about which types need to set as skops_trusted_types.

I added this to example code too.

Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
@BenWilson2 BenWilson2 added this pull request to the merge queue Jan 22, 2026
Merged via the queue into mlflow:master with commit 56d58f5 Jan 22, 2026
85 of 89 checks passed
harupy pushed a commit to harupy/mlflow that referenced this pull request Jan 28, 2026
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
harupy pushed a commit to harupy/mlflow that referenced this pull request Jan 28, 2026
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
harupy pushed a commit that referenced this pull request Jan 28, 2026
Signed-off-by: Weichen Xu <weichen.xu@databricks.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tracking Tracking service, tracking client APIs, autologging rn/feature Mention under Features in Changelogs. team-review Trigger a team review request v3.9.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants