docs: revert getting-started.md tutorial to xgb_train (pytorch_train crashes on Apple Silicon) - #1871
Open
sallycr wants to merge 1 commit into
Open
docs: revert getting-started.md tutorial to xgb_train (pytorch_train crashes on Apple Silicon)#1871sallycr wants to merge 1 commit into
sallycr wants to merge 1 commit into
Conversation
…crashes on Apple Silicon PR #1749 switched the tutorial's flagship worked example from the in-core XGBoost pipeline to michelangelo-examples' pytorch_train (PyTorch Lightning). pytorch_train's documented local-run command crashes on any Apple Silicon Mac with a DDP+MPS incompatibility (see spec 036 / issue #1867) -- not something a doc fix can work around, since the fix has to add a new accelerator field to core michelangelo's LightningTrainerKwargs dataclass first. Reverting the tutorial to the XGBoost example (which has no PyTorch/MPS dependency at all, confirmed clean end-to-end) until that fix ships.
kenns29
approved these changes
Aug 20, 2026
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?
Reverts
docs/user-guides/getting-started/getting-started.md's tutorial to its pre-#1749 state, teaching the in-core XGBoost pipeline (python/examples/pipelines/california_housing_xgb/) again instead ofmichelangelo-examples'pytorch_train(PyTorch Lightning). No other file from #1749 is touched —docs/getting-started/sandbox-setup.md,docs/user-guides/examples/index.md, anddocs/user-guides/ml-pipelines/workflow-patterns.md's repoints tomichelangelo-examplesare unaffected and still correct.Why?
#1749 switched the tutorial's flagship worked example to
pytorch_train. Its documented local-run command (python -m michelangelo_examples.california_housing.pipelines.pytorch_train.pipeline) crashes on any Apple Silicon Mac:Root-caused and tracked as issue #1867, with a design already written up (fix requires adding a new
acceleratorfield to coremichelangelo'sLightningTrainerKwargs— not something fixable from docs or frommichelangelo-examplesalone, since that dataclass has no such field today). Also confirmedRayDeepSpeedStrategydoesn't sidestep this — it's a subclass of Lightning's ownDDPStrategy/ParallelStrategy, so it hits the identical MPS rejection.Until #1867's fix ships,
pytorch_train's local-run path is broken for a likely-large fraction of individual contributors' dev machines (any Apple Silicon Mac). The in-core XGBoost example has no PyTorch/MPS dependency at all and runs clean end-to-end (re-verified locally, no manual workarounds). Reverting the tutorial back to it keepsgetting-started.mdtrustworthy in the meantime; the switch topytorch_traincan be reinstated once #1867 is fixed and released.How did you test it?
getting-started.mdbetween docs: repoint california_housing doc references to michelangelo-examples #1749's merge and this PR's base, so this is a clean, non-lossy revert of just that file.california_housing_xgb) still exists in-core (not yet deleted — chore(examples): remove california_housing_xgb pipeline (migrated to michelangelo-examples) #1751, the PR that removes it, is still open/unmerged) and has no PyTorch/Lightning/MPS/DDP references at all.origin/maincheckout — completes cleanly, no manual workaround.Potential risks
None beyond a temporary doc/tutorial content change. No code changes.
Breaking Changes
Release notes
N/A
Documentation Changes
Yes — reverts the getting-started tutorial's flagship example from
pytorch_trainback to the in-core XGBoost pipeline, until #1867 (pytorch_traincrashes on Apple Silicon) is fixed.