jjang-ai/vmlx:README 來源編輯指南
根據 README、倉庫資料與授權整理 jjang-ai/vmlx 的安裝與核驗路徑。
專案定位
jjang-ai/vmlx 的 README 將專案描述為「vMLX - JANGTQ Uber Compressed MLX Models - L2 Disk Cache (survives restart) + L1 Paged (super fast ttft) + Hybrid SSM Scheduler + Cont Batching + etc!」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「README」下寫到:Self-hosted inference server for LLMs, VLMs, and image generation on Apple Silicon. OpenAI + Anthropic + Ollama compatible HTTP API. Self-hosted; no third-party API keys required.。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「Guidelines」與相關條目,可以先判斷它是否處理你的實際問題:Run the full test suite before submitting PRs。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:Run the full test suite before submitting PRs。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「Install from PyPI」等段落。可確認的線索包括:Published on PyPI as vmlx -- install and run in one command:。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: # Recommended: uv (fast, no venv hassle) brew install uv uv tool install vmlx vmlx serve mlx-community/Qwen3-8B-4bit # Or: pipx (isolates from system Python) brew install pipx pipx install vmlx vmlx serve mlx-community/Qwen3-8B-4bit # Or: pip in a virtual environment python3 -m venv ~/.vmlx-env && source ~/.vmlx-env/bin/activate pip install vmlx vmlx serve mlx-community/Qwen3-8B-4bit 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「Install from PyPI」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「Install from PyPI」段落提到:> Note: On macOS 14+, bare pip install fails with "externally-managed-environment". Use uv, pipx, or a venv.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:Run the full test suite before submitting PRs。