Skip to content

Add Modal as a supported deployment target with full documentation - #20032

Merged
B-Step62 merged 15 commits into
mlflow:masterfrom
debu-sinha:feature/add-modal-plugin-docs
Feb 13, 2026
Merged

B-Step62 merged 15 commits into
mlflow:masterfrom
debu-sinha:feature/add-modal-plugin-docs

Conversation

@debu-sinha

@debu-sinha debu-sinha commented Jan 15, 2026 •

Copy link
Copy Markdown
Contributor

Related Issues/PRs

modal-labs/modal-client#3893

What changes are proposed in this pull request?

Add Modal as a supported deployment target with comprehensive documentation, elevating it from the community plugins table to a first-class deployment option alongside SageMaker, Azure ML, Kubernetes, etc.

Changes:

  • Add Modal to community deployment plugins table
  • Add Modal deployment documentation page at /docs/classic-ml/deployment/deploy-model-to-modal/
  • Update deployment overview to include Modal in the supported targets CardGroup
  • Add Modal logo to static images

Documentation includes:

  • How it works (step-by-step deployment flow)
  • Prerequisites and authentication setup
  • Local testing workflow (recommended before production)
  • Deployment via Python API and CLI
  • Making predictions (standard and streaming)
  • Configuration options table (GPU types, memory, auto-scaling, batching)
  • Advanced usage (GPU selection, high-throughput batching, workspace targeting)
  • Managing deployments
  • Troubleshooting section
  • Useful links to Modal docs and plugin repository

Plugin repository: https://github.com/debu-sinha/mlflow-modal-deploy
PyPI: https://pypi.org/project/mlflow-modal-deploy/

How is this PR tested?

  • Manual tests

Documentation-only change. Verified:

  • MDX files render correctly with proper imports
  • CardGroup and LogoCard components work as expected
  • Tabs component correctly displays Python API and CLI examples
  • Configuration table renders properly
  • All internal links are valid

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.

Add comprehensive documentation for deploying MLflow models to Modal's serverless GPU infrastructure. The mlflow-modal-deploy plugin enables one-command deployment with auto-scaling, GPU support (T4 to H200), streaming predictions, and dynamic batching.

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

Components

  • 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 (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)

@github-actions

Copy link
Copy Markdown
Contributor
🛠 DevTools 🛠

Install mlflow from this PR

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

@github-actions

Copy link
Copy Markdown
Contributor

@debu-sinha Thank you for the contribution! Could you fix the following issue(s)?

⚠ Invalid PR template

This PR does not appear to have been filed using the MLflow PR template. Please copy the PR template from here and fill it out.

@github-actions github-actions Bot added area/docs Documentation issues rn/none List under Small Changes in Changelogs. labels Jan 15, 2026
@debu-sinha

Copy link
Copy Markdown
Contributor Author

Hi @B-Step62 and team,

This is a documentation-only PR adding mlflow-modal-deploy to the community deployment plugins table.

Quick Testing Instructions

If anyone wants to verify the plugin works:

# Install
pip install mlflow-modal-deploy modal

# Configure Modal (one-time setup)
modal token new

# Deploy any MLflow model
mlflow deployments create -t modal -m runs:/<run_id>/model --name test-deployment

# List deployments
mlflow deployments list -t modal

# Get predictions
mlflow deployments predict -t modal --name test-deployment --input-path input.json

# Clean up
mlflow deployments delete -t modal --name test-deployment

Or via Python:

from mlflow.deployments import get_deploy_client

client = get_deploy_client("modal")
client.create_deployment(
    name="my-model",
    model_uri="models:/MyModel/1",
    config={"gpu": "T4", "min_containers": 1}
)

Key Features

  • One-command deployment to Modal's serverless GPU infrastructure
  • Supports T4, L4, A10, A100, H100, H200 GPUs
  • Streaming predictions compatible with MLflow's Databricks client
  • Auto-scaling with configurable min/max containers

The plugin is published on PyPI and the repo has comprehensive tests.

If you're satisfied with the implementation and the docs change looks good, would appreciate a review and merge. Thanks!

@debu-sinha
debu-sinha force-pushed the feature/add-modal-plugin-docs branch from eae729d to 33c70f2 Compare January 25, 2026 17:21
@debu-sinha debu-sinha changed the title Add mlflow-modal-deploy to community deployment plugins Add Modal as a supported deployment target with full documentation Jan 25, 2026
@github-actions github-actions Bot added rn/documentation Mention under Documentation Changes in Changelogs. and removed rn/none List under Small Changes in Changelogs. labels Jan 25, 2026
@debu-sinha
debu-sinha force-pushed the feature/add-modal-plugin-docs branch from 33c70f2 to ae53e15 Compare January 25, 2026 17:24
@github-actions

github-actions Bot commented Jan 27, 2026 •

Copy link
Copy Markdown
Contributor

Documentation preview for ef89604 is available at:

Changed Pages (3)

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.

@B-Step62 B-Step62 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The content looks good overall. Just added a few comments of minor suggestions and sidebar fix.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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


### GPU Selection

Modal supports a wide range of GPU types for different workloads:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Is this syntax based on some official Modal APIs? If so, let's add a link to the reference so users can check primary source.

deploys the model using `modal serve` for local testing:

```python
from mlflow_modal import run_local

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is great feature!:)

Comment on lines +38 to +41
#### Install Tools

Ensure the installation of the following tools:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
#### Install Tools
Ensure the installation of the following tools:
#### Install Libraries
Ensure the installation of the following libraries:

@debu-sinha

debu-sinha commented Jan 30, 2026 •

Copy link
Copy Markdown
Contributor Author

All review comments addressed:

  1. Added Modal page to sidebar config (sidebarsClassicML.ts)
  2. Changed "Install Tools" -> "Install Libraries"
  3. Added link to Modal's GPU documentation for GPU selection reference

Ready for final review/merge.

@debu-sinha

Copy link
Copy Markdown
Contributor Author

Added documentation links for all configuration options below the Configuration Options table:

  • GPU configuration
  • CPU and memory
  • Timeouts
  • Scaling (containers, scaledown)
  • Concurrency

This provides users with quick access to Modal's official documentation for each configuration category.

@debu-sinha
debu-sinha requested a review from B-Step62 January 30, 2026 16:43
@debu-sinha

Copy link
Copy Markdown
Contributor Author

@B-Step62 Just following up on this - all your review comments have been addressed and you've already approved. Since this is a docs-only change adding Modal to the community plugins table, would you be able to merge when you get a chance?

This completes the deployment story alongside the recently merged scorer integrations (Phoenix #19473, TruLens #19492, Guardrails #20038). Thanks!

Signed-off-by: debu-sinha <debusinha2009@gmail.com>
Add comprehensive documentation for deploying MLflow models to Modal's
serverless GPU infrastructure:

- Add Modal as a supported deployment target in the deployment overview
- Create full documentation page following SageMaker/Kubernetes pattern
- Include step-by-step deployment guide, configuration options, advanced
  usage (GPU selection, batching, workspaces), and troubleshooting
- Add Modal logo for the deployment target card

The mlflow-modal-deploy plugin enables one-command deployment with
auto-scaling, GPU support (T4 to H200), and streaming predictions.

Signed-off-by: debu-sinha <debusinha2009@gmail.com>
Signed-off-by: debu-sinha <debusinha2009@gmail.com>
Signed-off-by: debu-sinha <debusinha2009@gmail.com>
Replace placeholder image with official Modal wordmark logo from modal.com

Signed-off-by: debu-sinha <debusinha2009@gmail.com>
The wordmark had light text that was invisible on white backgrounds.
Using just the green M blocks symbol which is visible on any background.

Signed-off-by: debu-sinha <debusinha2009@gmail.com>
Black background makes the light green Modal text visible.

Signed-off-by: debu-sinha <debusinha2009@gmail.com>
Signed-off-by: debu-sinha <debusinha2009@gmail.com>
- Add Modal deployment page to sidebar config (sidebarsClassicML.ts)
- Change "Install Tools" to "Install Libraries" per B-Step62's suggestion

Signed-off-by: debu-sinha <debusinha2009@gmail.com>
Signed-off-by: debu-sinha <debusinha2009@gmail.com>
Signed-off-by: debu-sinha <debusinha2009@gmail.com>
@debu-sinha
debu-sinha force-pushed the feature/add-modal-plugin-docs branch from d6c588d to 8077650 Compare February 10, 2026 18:16
@debu-sinha

debu-sinha commented Feb 10, 2026 •

Copy link
Copy Markdown
Contributor Author

@B-Step62 Just rebased to resolve any conflicts with latest main. This is ready to go whenever you get a chance.

@B-Step62
B-Step62 added this pull request to the merge queue Feb 13, 2026
Merged via the queue into mlflow:master with commit 57b2739 Feb 13, 2026
12 checks passed
daniellok-db pushed a commit to daniellok-db/mlflow that referenced this pull request Feb 20, 2026
daniellok-db pushed a commit that referenced this pull request Feb 20, 2026
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. v3.10.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants