docs: request the mlx extra in the documented setup commands - #2245
Open
mlpy0 wants to merge 1 commit into
Open
Conversation
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
1 participant
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.
Since #2087 moved mlx, mlx-lm, mlx-vlm and mflux out of
dependenciesinto themlxextra, the documented setup path never installs them, and[tool.uv]sets no default extras.uv run exostarts the API, then every runner crashes withModuleNotFoundError: No module named 'mlx'(#2156).Adds the extra to the commands documented as the way to set up:
uv sync --extra mlxuv sync --extra mlx-cpu, with the mlx-cuda12 / mlx-cuda13 alternativesjust sync/just sync-clean, whichjust build-appruns before pyinstaller — the spec aborts when the mlx Metal libraries are missingDocs plus two justfile recipes; no dependency or lock changes. Backend choice stays explicit, since mlx-cpu / mlx-cuda12 / mlx-cuda13 / mlx-none are declared as conflicting extras.
#2234 overlaps on the macOS README block only, via a setup script that runs
uv sync --extra mlx; the Linux block, CONTRIBUTING.md and the justfile are not covered there.