docs: overhaul README — multi-device positioning, device-selection quickstart, runtime stack table#463
Open
iamagenius00 wants to merge 2 commits into
Open
Conversation
…ickstart, runtime stack table
gufengc
reviewed
Jun 1, 2026
| - Run one model across multiple worker nodes with pipeline-parallel layer sharding. | ||
| - Serve an OpenAI-compatible `/v1/chat/completions` endpoint from your own machines. | ||
| - Mix Apple Silicon Macs, Windows PCs, and Linux GPU hosts in the same cluster. | ||
| - Use GPU backends and the Mac MLX/oMLX path behind one API. |
gufengc
reviewed
Jun 1, 2026
| curl http://localhost:3001/v1/chat/completions \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{ | ||
| "model": "parallax", |
Collaborator
There was a problem hiding this comment.
leave model name as placeholder
gufengc
reviewed
Jun 1, 2026
| }' | ||
| ``` | ||
|
|
||
| For Qwen3 and gpt-oss style reasoning models, thinking is enabled by default. To disable it, add: |
iamagenius00
force-pushed
the
docs/readme-overhaul
branch
from
c4b3185 to
c424714
Compare
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
3 participants
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
A README overhaul that repositions Parallax around its full device story (Macs, Windows PCs, and GPU machines) and restructures the top of the doc for first-time users.
Why
The previous README led with a source
git cloneand surfaced Windows support only deep inside the Install section. New users land without an obvious "which path do I take for my machine" answer, and the model list — the main reason people evaluate Parallax — sat far down the page.What's included
Verification
All version numbers in the new Runtime Stack table and Recent Updates were checked against the current
main:sglang[all]==0.5.12,vllm==0.14.0,mlx-lm==0.31.3,mlx==0.31.2,lattica==1.0.21,transformers>=4.57.1,requires-python = ">=3.11,<3.14"— all matchpyproject.toml.v0.22.0— matchesVLLM_REFdefault ininstall.sh.kernels<0.15(GPU extra) andUV_PRERELEASE=allow— both present in source.This PR touches
README.mdonly.