TensorFold README

The project's README from github.com/ashhart/TensorFold. As one markdown file: README.md.

TensorFold

TensorFold serves text models on Apple Silicon and NVIDIA GPUs through an OpenAI-compatible API. Each model family supplies its own kernels and draft verification.

python -m pip install git+https://github.com/ashhart/TensorFold.git
tensorfold serve Vontra/NVIDIA-Nemotron-3.5-Lightning-30B-A3B-MLX-4bit

Use http://127.0.0.1:8080/v1 as the client base URL and the model ID from /v1/models. Python 3.11 or newer is required, and MLX 0.32.2 or newer on a Mac (pip installs it). See the runbook for installation and a first request.

Models

Model Checkpoint Backend Drafting
Nemotron 3.5 Lightning Vontra/NVIDIA-Nemotron-3.5-Lightning-30B-A3B-MLX-4bit MLX, CUDA Included MTP head; context copies on MLX
Qwen3.8-27B Vontra/Qwen3.8-27B-MLX-4bit MLX, CUDA z-lab/Qwen3.8-27B-DFlash2 and context copies; DFlash2 is optional on MLX
Qwen3.8 Flash Next Vontra/Qwen3.8-Flash-Next-MLX-4bit-MTP MLX, CUDA Included MTP head and context copies
GLM-5.3-Flash Vontra/GLM-5.3-Flash-MLX-4bit-MTP MLX on a 256 GB Mac, CUDA with two ranks MTP; optional DFlash2 on CUDA
Gemma 4 26B-A4B mlx-community/gemma-4-26b-a4b-it-4bit MLX Context copies; z-lab/gemma-4-26B-A4B-it-DFlash is optional
Qwen3.8-27B (EXL3, experimental) turboderp/Qwen3.8-27B-exl3 (branches 3.00bpw, 4.00bpw; any codebook, 1 to 8 bits per weight) CUDA z-lab/Qwen3.8-27B-DFlash2 and context copies
Qwen3.8 Flash Next (EXL3, experimental) turboderp/Qwen3.8-Flash-Next-exl3 (branch 3.05bpw_h5_ng5; any codebook, a width per tensor) CUDA Included MTP head and context copies

tensorfold models lists families and checkpoints. tensorfold info MODEL checks configuration without fetching weights. serve downloads a missing checkpoint; pull downloads it ahead of time.

tensorfold pull Vontra/Qwen3.8-27B-MLX-4bit z-lab/Qwen3.8-27B-DFlash2
tensorfold serve Vontra/Qwen3.8-27B-MLX-4bit

Qwen3.8-27B reads MLX affine 2-, 3-, 4-, 5-, 6- and 8-bit checkpoints, including mixed layer formats. This branch adds packed row readers for groups of 32, 64 and 128 on Apple Silicon and CUDA, with hardware qualification still pending for the new paths. M5 keeps its native tensor-unit kernels for compatible formats, and other formats use the row decoder. See quantized checkpoints for the exact scope. On CUDA, pull DFlash2 before serving; without it, explicitly choose --no-drafts for the serial reference.

Nemotron uses TensorFold projections and routed-expert kernels. Its load-time row check controls drafting; keep the installed MLX version within the package requirements. The named checkpoint includes mtp-4bit.safetensors, which pull and serve check for.

Flash Next requires 4-bit/group-32 weights. Without an MTP head it can run without MTP drafting on MLX; on CUDA, explicitly pass --no-drafts. Nemotron CUDA requires 4-bit/group-64 weights and an MTP head unless --no-drafts is set. GLM on MLX reads 4-bit/group-64 weights and mlx-lm's mixed-bit conversions, whose 5-, 6- and 8-bit tensors take their own row kernels; it needs MLX 0.32.2 or later. GLM CUDA reads MLX 4-bit/group-64 weights and the experimental Mia-AiLab/GLM-5.3-Flash-EXL3-TR3-4bpw conversion. GLM's optional incoai/GLM-5.3-Flash-DFlash2 checkpoint has non-commercial license terms, described in third-party notices.

Gemma 4 has no draft head. It drafts copies of its context, and chains from z-lab's DFlash model when served with --drafter z-lab/gemma-4-26B-A4B-it-DFlash (pulled once). Its kernels read 4-bit weights in groups of 32 or 64 with an 8-bit router, as the mlx-community conversion stores them; serve refuses other Gemma 4 layouts before downloading.

See the recipes for supported formats and backend limits.

Exact decoding

A draft is accepted only when it equals the token the same engine would produce serially. Sampling depends on the prompt or explicit seed, absolute position and token ID. Verify kernels keep each row's arithmetic independent of the other rows in the call. Compare a request with the same request using "draft": false to check drafted versus serial output.

The MLX engine can share a round across requests. Each stream keeps its own state and sampling key, with concurrent output required to match its solo output. Load-time checks restrict window width and shared forwards where a family cannot reproduce its serial arithmetic. On CUDA, --parallel N with N greater than one enables shared rounds for Qwen3.8-27B on one or two ranks and Flash Next on one rank. Flash Next rejects concurrent two-rank execution. GLM and Nemotron CUDA serve one request at a time; CUDA --parallel auto also means one request at a time.

Exactness is against the same engine, weights, runtime and settings. It does not imply identical output between MLX and CUDA, different quantizations, or different tensor-parallel rank counts.

Serve options

Option Meaning Backend
--host, --port Listen address, default 127.0.0.1:8080 Both
--name Model ID advertised to clients Both
--alias Additional model IDs MLX
--context N Prompt plus reply capacity Both
--max-tokens N Default reply limit, 4096 Both
--temperature, --top-p, --top-k Sampling defaults; temperature zero is greedy Both
--thinking, --no-thinking Template thinking toggle Both
--reasoning-effort Template effort, default medium MLX
--thinking-budget N Token-count limit inside reasoning MLX
--backend auto, mlx, cuda Select backend; auto uses MLX on macOS Both
--parallel N MLX auto admits up to 8 within budget; CUDA auto is 1, explicit N enables supported shared rounds Both
--no-drafts Decode serially Both
--drafter auto, none, or model ID Select an optional draft model where the family supports it Both
--mtp-drafts N Family-specific cap on MTP drafts Both
--kv-dtype bf16, int8, int4 Flash Next: int8 or int4 stores keys and values with one fp16 scale per 32 values. Other families and the MLX path refuse it CUDA
--mtp-confidence P Flash Next: stop a draft chain before a later draft under this probability, 0 to 1 (default 0.30) CUDA
--tp 2 --rank R --master HOST Two-rank CUDA execution CUDA
--prompt-cache-gib N Retained conversation-prefix budget; zero disables retention MLX
--checkpoint-slots N Retained conversation prefixes (default 3 per lane, at least 8); long conversations hit this before the byte budget MLX
--spill-gib N Write evicted conversation prefixes to disk (up to N GiB) and read them back instead of prefilling again; zero disables MLX
--mlx-cache-gib N Reusable freed-buffer cache, default 8 GiB MLX
--snapshot-dir DIR Persistent prefix snapshots; none disables them MLX
--no-update-check Disable the startup release check Both

The default sampling settings come from generation_config.json. Requests can override sampling and reply length. CUDA does not implement the MLX-only options above. See API fields for request scope.

Context and memory

On MLX, omitted --context targets the model's metadata window and reduces it to the startup memory estimate when needed, allowing room to retain a prompt for the next turn. An explicit positive value that cannot fit one request is refused at startup. --context 0 removes the metadata cap; finite engine capacity and memory admission still apply. Use the reported context when configuring client compaction.

On CUDA, Qwen defaults to the affordable native capacity. GLM targets a dense 2,051-token window, and Nemotron targets 16,384 tokens; the capacity estimate can lower these defaults. Flash Next's --kv-dtype int8 or int4 counts its smaller cache, so the same memory admits a longer window. Explicit --context 0 targets the affordable native capacity for every CUDA family. A positive CUDA value must fit both the native window and the capacity estimate on every rank; otherwise startup refuses it with fitting guidance. Increasing GLM beyond its dense window enables its sparse-attention path. The startup report distinguishes native and allocated capacity.

MLX defaults to a process budget of 70% of RAM. A family can state a larger share: GLM-5.3-Flash takes 85% on a Mac with 256 GB or less, with nothing else loaded. TENSORFOLD_MEMORY_LIMIT_GB replaces that default in GiB, raising or lowering it; physical RAM and the GPU's recommended working set still cap the result. The server reserves 3 GiB for the rest of the process before setting the MLX allocator limit, so a 110 GiB process budget allows 107 GiB of MLX buffers. Concurrent admission honors the raised budget while accounting for memory held elsewhere on the machine. Admission accounts for weights, cache growth, reply tokens and prefill workspace. Retained prefixes and reusable MLX buffers have separate limits. Admission can evict retained prefixes or queue another stream; fitting weights alone does not establish a usable context size. A larger budget leaves less RAM for other applications and cached file pages. The startup line says how far the variable can raise the budget on this Mac, and a startup refusal says how far it must go. On a 32 GB Mac, Qwen3.8-27B needs more than the default 22.4 GiB, with or without its draft model.

Flash Next's startup weight check excludes n-gram tensors when the loader keeps them in host file mappings. The startup report shows resident and file-backed bytes separately. Cached file pages still consume RAM and can be reclaimed by the OS; see Flash Next memory.

An explicit reply limit is reserved before prefill. A request that exceeds context or memory is refused with fitting guidance; an omitted reply limit is capped by the remaining context. MLX reports a context refusal as HTTP 400 for a non-streamed request or as an error event after opening a stream. CUDA checks context before opening a stream.

The memory-class table below keeps the model combinations under qualification. Its GiB budget ceilings emulate the listed RAM classes before the 3 GiB process reserve. The actual default budget uses OS-reported physical memory and the GPU working set; an explicit memory budget can lower or raise it. Context and peak-memory results remain TBD until a public prompt fixture, checkpoint revision, runtime, command and measurement output accompany each result.

Nominal RAM class Budget ceiling Qwen3.8-27B + DFlash2 Qwen3.8-27B, --drafter none Nemotron 3.5 Lightning Qwen3.8 Flash Next
32 GB 22.4 GiB TBD TBD TBD TBD
36 GB 25.2 GiB TBD TBD TBD TBD
48 GB 33.6 GiB TBD TBD TBD TBD
64 GB 44.8 GiB TBD TBD TBD TBD
96 GB 67.2 GiB TBD TBD TBD TBD
128 GB 89.6 GiB TBD TBD TBD TBD
192 GB 134.4 GiB TBD TBD TBD TBD
256 GB 179.2 GiB TBD TBD TBD TBD

Each model cell needs the fitted context and peak physical process footprint. An emulated budget on a larger host is not a measurement on hardware with that RAM size. These are qualification slots, not minimum-memory promises. Weights that exceed the MLX budget are refused before loading.

Prompt caching

On MLX, chunk starts come from the rendered token sequence. Resume points are assistant-message starts and the second message start, using markers discovered from the chat template. The planner skips points less than 256 tokens from the previous chunk start and otherwise cuts at the first eligible point or after the model family's chunk. Qwen3.8 Flash Next measures one chunk at startup and takes the largest of 8,192, 4,096 and 2,048 tokens (4,096 and 2,048 on GPUs without tensor units) that still leaves room for 128K tokens of context; other families use 2,048. Without recognized markers it uses that grid. There is no configurable --prefill-grid option.

Fresh and resumed requests use the same chunk plan. Reuse stops at a matching token prefix and a valid chunk boundary; the previous reply is prefilled again under the current prompt. A template that rewrites an earlier turn can reduce reuse. A follow-up therefore need not reprocess a full grid cell, but short messages or changed earlier text can make it reprocess more than the latest reply and new messages.

Snapshots include the model, runtime, kernel and chunk-plan identity. System prefixes and retained conversations can survive restarts. CUDA engines keep their own prompt/reply states and do not use the MLX disk-snapshot or retained-prefix options.

NVIDIA GPUs

Use NVIDIA's PyTorch container for CUDA, PyTorch, Triton and the extension compiler; the package has no cuda installation extra. Install TensorFold inside the container without replacing that toolchain.

docker run -it --gpus all --ipc=host --network host nvcr.io/nvidia/pytorch:26.07-py3
python -m pip install git+https://github.com/ashhart/TensorFold.git
tensorfold pull Vontra/Qwen3.8-27B-MLX-4bit z-lab/Qwen3.8-27B-DFlash2
tensorfold serve Vontra/Qwen3.8-27B-MLX-4bit --host 0.0.0.0

Qwen3.8-27B, Flash Next and Nemotron support one or two CUDA ranks; GLM requires two. For two ranks, see the CUDA runbook. Each rank needs its checkpoint and any optional drafter. Rank 0 serves HTTP. Unified GPU/host memory also holds runtime buffers and file-backed model data; the startup estimate is not a measured maximum capacity.

Measurements

Each release's notes give its measured decode, prompt and concurrency numbers against the previous release and the standard servers, on the machines they name: see CHANGELOG.md and the GitHub releases. The recipe book gives the public prompts and benchmark command, and each family's recipe keeps its own tables.

Updating

tensorfold update --check checks for a release; tensorfold update installs it, then the server must restart. A normal installation uses the same interpreter's pip. An editable clone must be clean and able to fast-forward to the release tag; afterwards run python -m pip install -e . in the checkout to refresh metadata and dependencies. --no-update-check or TENSORFOLD_NO_UPDATE_CHECK=1 disables startup checks.

When the update finishes it prints what changed since your version, from CHANGELOG.md, which lists every release. The first time a new version serves, it prints one line linking to its notes.

Development and license

Family interfaces, kernel layout and verification requirements are in the recipe book, family map and kernel map. MIT; see LICENSE and third-party notices. Model weights keep their own licenses.

TensorFold (ashhart/TensorFold)

Searching Database…

这是什么?TensorFold 是一个 LLM 推理引擎,通过 OpenAI 兼容 API 对外提供开放权重大语言模型服务,可在 Apple Silicon 上经 MLX 运行,或在 NVIDIA GPU 上经 CUDA 运行。
这是我导入的库,还是我运行的服务器?它是一个命令行服务器:你运行 “tensorfold serve” 来托管模型,然后把任何兼容 OpenAI API 的客户端指向它的 base URL 和模型 ID。
怎么让它跑起来?用 pip 安装(在 Mac 上还会自动装上 MLX),然后用 “tensorfold pull” 获取检查点,或用 “tensorfold serve” 直接下载并启动 API 服务器。
试用之前需要准备什么?Python 3.11 或更新版本;macOS 上需要 MLX 0.32.2 或更新版本;CUDA 上需要受支持的 NVIDIA GPU,部分模型还需要单独拉取的 DFlash2 草稿检查点。
随便什么模型它都能跑吗?不行,它只支持一小份具名检查点列表(Nemotron、Qwen3.8-27B、Flash Next、GLM-5.3-Flash、Gemma 4),每个都限定特定的量化格式,不支持的布局会在加载前被拒绝。
它是给没有 GPU 的人用的吗?不是,它面向拥有 Apple Silicon Mac 或 NVIDIA CUDA GPU 的人;CUDA 下并发请求还会进一步受限,部分模型家族(GLM、Nemotron)一次只能处理一个请求。
它实际支持哪些硬件?通过 MLX 支持 Apple Silicon Mac,通过 CUDA 支持 NVIDIA GPU,项目描述中还提到了 Vulkan;但 README 的详细指南只覆盖 MLX 和 CUDA。
整个项目都可以免费商用吗?引擎本身采用 Apache-2.0,但 GLM 的一个可选草稿检查点(DFlash2)以非商业许可条款分发。
这里的“精确解码”是什么意思?TensorFold 只在投机草稿 token 与同一引擎串行产出的结果一致时才接受它,因此在相同的引擎、权重、运行时和设置下,使用草稿的输出与不使用草稿的输出完全一致。
为什么有些模型需要单独的“草稿”或 MTP 检查点?它们是投机解码的辅助组件:轻量的头或模型提前预测若干 token,再由完整模型一次性验证,在不改变最终输出的前提下加快生成速度。
我实际需要多少内存或显存?在 MLX 上,TensorFold 默认使用 70% 的 Mac 内存(GLM-5.3-Flash 最高 85%),并允许你用 TENSORFOLD_MEMORY_LIMIT_GB 变量覆盖内存预算;README 中各模型和内存档位的确切峰值内存数据仍标注为待定。
它能高效记住对话的前几轮内容吗?能,它会在多轮之间缓存提示词前缀,这样后续消息就不必重新处理之前的完整提示,前提是聊天历史和模板没有发生破坏缓存前缀的变化。
Creator
ashhart
Size
24.7 MB
Stars
1.4K
Age
3mo
Commits · 90 Days