docs: add a migration guide for SageMaker and Vertex AI users - #1863
Open
apurvapatkeshwar wants to merge 2 commits into
Open
docs: add a migration guide for SageMaker and Vertex AI users#1863apurvapatkeshwar wants to merge 2 commits into
apurvapatkeshwar wants to merge 2 commits into
Conversation
Adds a Migration Guides section under the user guides, starting with KubeRay. Covers the concept mapping between KubeRay's RayCluster/RayJob and their Michelangelo AI equivalents, before/after manifests for both, the task-based alternative, and the gaps that do not map yet. Refs michelangelo-ai#1705
Third guide in the migration section. Maps Estimator/CustomJob, Pipelines, Model Registry, and Endpoint concepts onto Uniflow tasks, Pipeline/PipelineRun, Model/Revision, and InferenceServer/Deployment, with an explicit gaps section: no batch inference primitive, no feature store, no hyperparameter tuning, no native GCS backend, and rolling as the only rollout strategy. Deliberately does not enumerate serving backends: the proto declares four backend types but only Triton is registered in the Go backend registry, and several existing docs overclaim beyond that. Depends on the migration section scaffolding (_category_.json) from the KubeRay guide PR. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this? (check all applicable)
What changed?
Adds
docs/user-guides/migration/migrate-from-sagemaker-or-vertex.md, the third and final guide in the migration section asked for in #1705. It maps the managed-cloud concepts (Estimator/CustomJob, Pipelines, Model Registry, Endpoints) onto their equivalents here, shows a real Estimator-to-pipeline-task before/after with explicit model registration, and is deliberately blunt about what does not map today: batch inference, feature stores, hyperparameter tuning, native GCS storage, and endpoint traffic splitting.Why?
#1705 asked for migration guides from Kubeflow Trainer, KubeRay, and SageMaker/Vertex. #1783 covers KubeRay and #1853 covers Kubeflow Trainer; this closes out the set. SageMaker and Vertex users are the audience most likely to be surprised by what a self-hosted platform does not bundle, so this guide leads with an honest gap list instead of letting people discover the gaps mid-migration.
How did you test it?
Docs-only change; testing here means accuracy and link integrity:
APIRegistryClientsignature (namespace=constructor kwarg;register_model(name=..., artifact_uri=..., kind=...)); theRayTaskexample uses the actual field names (head_cpu,head_memory,worker_cpu,worker_memory,worker_gpu,worker_instances); the blob storage layer at HEAD ships Azure and MinIO backends only, so the GCS gap is real (tracked in Native GCS backend for the blob storage layer #1693); the roadmap lists GCS, the feature store, and traffic splitting as planned, and mentions neither batch inference nor hyperparameter tuning, which the guide states plainly rather than implying they are scheduled._category_.jsonresolves because of the stack).docs/contributing/documentation-guide.md.Potential risks
None at runtime -- documentation only. The main risk is factual drift as gaps close (for example native GCS support in review at #1837); the gaps section points at the roadmap for anything planned, so it fails safe and stays easy to update.
Breaking Changes
Release notes
Docs only; nothing operational.
Documentation Changes
This PR is the documentation change: one new page under
docs/user-guides/migration/.