Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor Deployment page and add local / SageMaker / Azure / Databricks guides #10675

Merged
merged 12 commits into from Dec 20, 2023
Merged

Refactor Deployment page and add local / SageMaker / Azure / Databricks guides #10675

merged 12 commits into from Dec 20, 2023

Conversation

B-Step62
Copy link
Collaborator

@B-Step62 B-Step62 commented Dec 12, 2023 •
edited

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

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

Checkout with GitHub CLI

gh pr checkout 10675

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

This is a first PR for deployment doc overhaul. More changes will be coming to deployment-doc-revamp branch.

Changes in this PR

  • Refactor top page deployment/index.html
  • Add two subpages for deployment targets (1) local deployment (2) AWS SageMaker
  • Direct links to AzureML and Databricks as they already have solid documentation.

TODOs for future PRs

  • Add guide for Ray Serve deployment
  • Refine Kubernetes deployment guide
  • Fill FAQ and troubleshooting section based on historical queries and issues.

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/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:

  • 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

@B-Step62
Refactor deployment top page and add subpages for local and SageMaker…
96652ba 
… deployments

Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
@B-Step62
Convert some icons to SVG
aefb165 
Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 12, 2023 •
edited

Documentation preview for 3776534 will be available here when this CircleCI job completes successfully.

More info

@github-actions github-actions bot added the area/docs Documentation issues label Dec 12, 2023
@B-Step62 B-Step62 changed the title [DO NOT MERGE YET] Deployment doc overhaul =Deployment doc overhaul - first PR Dec 12, 2023
@B-Step62 B-Step62 changed the title =Deployment doc overhaul - first PR Deployment doc overhaul - first PR Dec 12, 2023
@B-Step62 B-Step62 changed the title Deployment doc overhaul - first PR Deployment doc overhaul - Refactor Entry page and add local / SageMaker deployment guides Dec 12, 2023
@B-Step62 B-Step62 changed the title Deployment doc overhaul - Refactor Entry page and add local / SageMaker deployment guides [Deployment doc overhaul] Refactor Entry page and add local / SageMaker deployment guides Dec 12, 2023
@B-Step62 B-Step62 changed the title [Deployment doc overhaul] Refactor Entry page and add local / SageMaker deployment guides [Deployment Doc] Refactor Entry page and add local / SageMaker deployment guides Dec 12, 2023
@B-Step62 B-Step62 changed the title [Deployment Doc] Refactor Entry page and add local / SageMaker deployment guides Refactor Entry page and add local / SageMaker deployment guides Dec 12, 2023
@B-Step62 B-Step62 changed the title Refactor Entry page and add local / SageMaker deployment guides Refactor Deployment page and add local / SageMaker guides Dec 12, 2023
@github-actions github-actions bot added the rn/none List under Small Changes in Changelogs. label Dec 12, 2023
@B-Step62
More adjustment
9367695 
Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>

	deleted:    docs/source/_static/images/logos/amazon-sagemaker-logo.svg
	new file:   docs/source/_static/images/logos/azure-ml-logo.png
@B-Step62
Fix typo and links
aa4f87f 
Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
@B-Step62
adjust image size
1b06472 
Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
michael-berk
michael-berk reviewed Dec 13, 2023
View reviewed changes
docs/source/deployment/index.rst
- **Packaging Models and Code**: With MLflow, not just the model, but any supplementary code and configurations are packaged along with the deployment container. This ensures that the model can be executed seamlessly without any missing components.
- **Avoid Vendor Lock-in**: MLflow provides a standard format for packaging models and unified APIs for deployment. You can easily switch between deployment targets without having to rewrite your code.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm working with a customer migrating from AWS to the Databricks stack. Would it be useful to have a demo for migrating between deployment methods?
cc @BenWilson2

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sounds like a good follow-up! Tho I'm not very sure about the migration process as a whole. Any thoughts @BenWilson2?

Copy link
Member

Choose a reason for hiding this comment

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

It's definitely a bit simpler :D I think for Databricks-specific instructions, we're going to have to leave those in the Databricks docs, though. We could provide links :)

B-Step62 and others added 4 commits December 13, 2023 14:15
@B-Step62 @BenWilson2
Update docs/source/deployment/deploy-model-locally.rst
4863f73 
Co-authored-by: Ben Wilson <39283302+BenWilson2@users.noreply.github.com>
Signed-off-by: Yuki Watanabe <31463517+B-Step62@users.noreply.github.com>
@B-Step62
Add AzureML deployment guide
8fedde7 
Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
@B-Step62
Replace Databricks deployment guide with official document
9cfffaa 
Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
@B-Step62
Replace AzureML guide with their documentation
4d7f30a 
Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
@B-Step62
Copy link
Collaborator Author

Realized that AzureML and Databricks already have solid guidelines for MLflow model deployment in their documentation. Replaced the placeholder pages with direct links.

@B-Step62 B-Step62 changed the title Refactor Deployment page and add local / SageMaker guides Refactor Deployment page and add local / SageMaker / Azure / Databricks guides Dec 13, 2023
serena-ruan
serena-ruan reviewed Dec 13, 2023
View reviewed changes
Copy link
Collaborator

@serena-ruan serena-ruan left a comment

Choose a reason for hiding this comment

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

@B-Step62 It looks great!! I think you're doing a great work at balancing between explanation and text amount. Just left few comments :D LMK if you need another review after adding more content.

docs/source/deployment/deploy-model-locally.rst Outdated Show resolved Hide resolved
docs/source/deployment/deploy-model-locally.rst Outdated Show resolved Hide resolved
docs/source/deployment/deploy-model-locally.rst
Once you have the model ready, deploying to a local server is straightforward. Use the `mlflow models serve <../cli.html#mlflow-models-serve>`_ command for a one-step deployment.
This command starts a local server that listens on the specified port and serves your model.

.. tabs::
Copy link
Collaborator

Choose a reason for hiding this comment

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

Love the usage of tabs here! We could apply tabs to all similar situations for different languages or different operating systems.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Absolutely! Only concern is if it works in the new framework... but no reason not to do that after migration:)

docs/source/deployment/deploy-model-locally.rst Outdated Show resolved Hide resolved
docs/source/deployment/deploy-model-locally.rst Outdated Show resolved Hide resolved
docs/source/deployment/deploy-model-locally.rst Outdated Show resolved Hide resolved
docs/source/deployment/deploy-model-to-sagemaker.rst Outdated Show resolved Hide resolved
docs/source/deployment/deploy-model-to-sagemaker.rst Outdated Show resolved Hide resolved
docs/source/deployment/deploy-model-to-sagemaker.rst Outdated Show resolved Hide resolved
@B-Step62 @serena-ruan
Apply suggestions from code review
c9a8219 
Co-authored-by: Serena Ruan <82044803+serena-ruan@users.noreply.github.com>
Signed-off-by: Yuki Watanabe <31463517+B-Step62@users.noreply.github.com>
@B-Step62
comment
85599a7 
Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
BenWilson2
BenWilson2 reviewed Dec 20, 2023
View reviewed changes
docs/theme/mlflow/static/css/simple-cards.css
@@ -48,6 +48,19 @@
overflow: hidden;
}

.simple-card .header-with-image {
Copy link
Member

Choose a reason for hiding this comment

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

We might want to slap these logos on some existing cards too :) Let's do a follow-up to tackle that next sprint

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sounds good, created a follow-up JIRA:)

@B-Step62 @BenWilson2
Apply suggestions from code review
3776534 
Co-authored-by: Ben Wilson <39283302+BenWilson2@users.noreply.github.com>
Signed-off-by: Yuki Watanabe <31463517+B-Step62@users.noreply.github.com>
@B-Step62
Copy link
Collaborator Author

Merging assuming all good (if there is any remaining feedbacks, can address in the follow-up PR for k8s)

@B-Step62 B-Step62 merged commit d327a5a into mlflow:deployment-doc-revamp Dec 20, 2023
36 checks passed
@B-Step62 B-Step62 deleted the deployment-doc-revamp-1 branch December 20, 2023 04:24
@B-Step62 B-Step62 mentioned this pull request Dec 20, 2023
Merged
37 tasks
B-Step62 added a commit to B-Step62/mlflow that referenced this pull request Dec 21, 2023
@B-Step62 @BenWilson2 @serena-ruan
Refactor Deployment page and add local / SageMaker / Azure / Databric…
8ab30d6 
…ks guides (mlflow#10675)

Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
Signed-off-by: Yuki Watanabe <31463517+B-Step62@users.noreply.github.com>
Co-authored-by: Ben Wilson <39283302+BenWilson2@users.noreply.github.com>
Co-authored-by: Serena Ruan <82044803+serena-ruan@users.noreply.github.com>
@B-Step62 B-Step62 mentioned this pull request Jan 12, 2024
Merged
37 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michael-berk michael-berk michael-berk left review comments

@serena-ruan serena-ruan serena-ruan left review comments

@BenWilson2 BenWilson2 Awaiting requested review from BenWilson2

Assignees
No one assigned
Labels
area/docs Documentation issues rn/none List under Small Changes in Changelogs.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@B-Step62 @michael-berk @BenWilson2 @serena-ruan