Support loading transformers models containing custom code

[serena-ruan]

🛠 DevTools 🛠

Install mlflow from this PR

pip install git+https://github.com/mlflow/mlflow.git@refs/pull/10896/merge

Checkout with GitHub CLI

gh pr checkout 10896

Related Issues/PRs

Resolve #10887

What changes are proposed in this pull request?

If the model instance class is defined within the file saved inside code_paths, we iterate over files and try to import from modules.

How is this PR tested?

• [ ] Existing unit/integration tests
• [x] New unit/integration tests
• [x] 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/artifacts: Artifact stores and artifact logging
• [ ] area/build: Build and test infrastructure for MLflow
• [ ] area/deployments: MLflow Deployments client APIs, server, and third-party Deployments integrations
• [ ] area/docs: MLflow documentation pages
• [ ] area/examples: Example code
• [ ] area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
• [ ] area/models: MLmodel format, model serialization/deserialization, flavors
• [ ] area/recipes: Recipes, Recipe APIs, Recipe configs, Recipe Templates
• [ ] area/projects: MLproject format, project running backends
• [ ] area/scoring: MLflow Model server, model deployment tools, Spark UDFs
• [ ] area/server-infra: MLflow Tracking server backend
• [ ] area/tracking: Tracking Service, tracking client APIs, autologging

Interface

• [ ] area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
• [ ] area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
• [ ] area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
• [ ] area/windows: Windows support

Language

• [ ] language/r: R APIs and clients
• [ ] language/java: Java APIs and clients
• [ ] language/new: Proposals for new client languages

Integrations

• [ ] integrations/azure: Azure and Azure ML integrations
• [ ] integrations/sagemaker: SageMaker integrations
• [ ] integrations/databricks: Databricks integrations

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

• [x] 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

[github-actions[bot]]

Documentation preview for 70ecab928575b270db0fbb6468af1d280581bc3d will be available when this CircleCI job completes successfully.

• Top page
• Changed pages

More info

• Ignore this comment if this PR does not change the documentation.
• It takes a few minutes for the preview to be available.
• The preview is updated when a new commit is pushed to this PR.
• This comment was created by https://github.com/mlflow/mlflow/actions/runs/8699225793.

[hugocool]

can i pull this fix to test whether it fixis my issue? if so. should i change anything about how i register models to mlfow?

[serena-ruan]

can i pull this fix to test whether it fixis my issue? if so. should i change anything about how i register models to mlfow?

I think you could use this branch to test, you don't need to change the code (still use code_paths), but we might not merge this PR now as we will redesign the code_paths implementation in Q1. You could include this PR's change in your own patch if you really need to use it now :)