Skip to content

Commit 0a67edf

Browse files
docs: v2.2 pass — remove huggingface engine refs, update roadmap, sync Chinese docs
- Roadmap: mark P0 (airframe wiring) and P1 (llama/HF strip) as DONE - Roadmap: add SafeTensors native inference as P2 item - Roadmap: fix Build Matrix table to reflect current default=[airframe] - README: fix Linux ARM64 download description, cargo install description, build-from-source note (Airframe is public on crates.io), env var table - docs/zh-CN/README.md, docs/zh-TW/README.md: update feature flag references - docs/USER_MANUAL.zh-CN.md, docs/USER_MANUAL.zh-TW.md: fix build commands - shimmy-wiki-content/: update Installation, Quick-Start, Airframe-Engine pages EN+CN+TW
1 parent da90f59 commit 0a67edf

4 files changed

Lines changed: 64 additions & 60 deletions

File tree

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,8 @@ All types are implemented in both the GPU inference shader and a CPU reference i
182182

183183
**Auto-discovery is enabled.** If Shimmy finds GGUF models in your HuggingFace cache, Ollama directory, LM Studio cache (`~/.cache/lm-studio/models`), or local `./models/` folder, it will register and serve them automatically. See [docs/MODEL_EXPANSION.md](docs/MODEL_EXPANSION.md) for the full compatibility matrix.
184184

185+
**SafeTensors format** (`.safetensors`) is supported for model loading — Shimmy routes `.safetensors` files through the `safetensors_native` module. Full inference via the Airframe engine for SafeTensors is a P2 roadmap item (see [docs/v2-roadmap.md](docs/v2-roadmap.md)).
186+
185187
## 📦 Migrating from v1.x
186188

187189
The llama.cpp backend is **removed in v2.0.0**. The Airframe engine is the only inference path.
@@ -308,7 +310,7 @@ curl -L https://github.com/Michael-A-Kuykendall/shimmy/releases/latest/download/
308310
# macOS Intel
309311
curl -L https://github.com/Michael-A-Kuykendall/shimmy/releases/latest/download/shimmy-macos-intel -o shimmy && chmod +x shimmy
310312

311-
# Linux ARM64 (huggingface engine; Airframe cross-compilation not yet supported)
313+
# Linux ARM64 (Airframe engine; cross-compilation available)
312314
curl -L https://github.com/Michael-A-Kuykendall/shimmy/releases/latest/download/shimmy-linux-aarch64 -o shimmy && chmod +x shimmy
313315
```
314316

@@ -317,16 +319,16 @@ curl -L https://github.com/Michael-A-Kuykendall/shimmy/releases/latest/download/
317319
#### **🛠️ Build from Source / cargo install**
318320

319321
```bash
320-
# Install from crates.io
322+
# Install from crates.io (Airframe GPU engine)
321323
cargo install shimmy
322324

323-
# Build from source (huggingface engine, no GPU)
325+
# Build from source
324326
git clone https://github.com/Michael-A-Kuykendall/shimmy
325327
cd shimmy
326-
cargo build --release
328+
cargo build --release --features airframe
327329
```
328330

329-
> **Note**: The Airframe GPU engine is a private dependency and **cannot be built from source** by public users. The [pre-built release binaries](#-download-pre-built-binaries-recommended) already include Airframe compiled in — download those to get full GPU acceleration. `cargo install shimmy` installs the huggingface engine variant from crates.io.
331+
`cargo install shimmy` or `cargo build --release --features airframe` both give you the full Airframe GPU engine. Airframe is publicly available on [crates.io](https://crates.io/crates/airframe).
330332

331333
### GPU Acceleration
332334

@@ -342,7 +344,7 @@ Release binaries include the Airframe engine with WebGPU support compiled in:
342344
| **Linux x86_64** | [shimmy-linux-x86_64](https://github.com/Michael-A-Kuykendall/shimmy/releases/latest/download/shimmy-linux-x86_64) | WebGPU (wgpu) | NVIDIA, AMD, Intel |
343345
| **macOS ARM64** | [shimmy-macos-arm64](https://github.com/Michael-A-Kuykendall/shimmy/releases/latest/download/shimmy-macos-arm64) | Metal (via wgpu) | Apple Silicon |
344346
| **macOS Intel** | [shimmy-macos-intel](https://github.com/Michael-A-Kuykendall/shimmy/releases/latest/download/shimmy-macos-intel) | Metal (via wgpu) | Intel Mac |
345-
| **Linux ARM64** | [shimmy-linux-aarch64](https://github.com/Michael-A-Kuykendall/shimmy/releases/latest/download/shimmy-linux-aarch64) | huggingface only | ARM cross-build |
347+
| **Linux ARM64** | [shimmy-linux-aarch64](https://github.com/Michael-A-Kuykendall/shimmy/releases/latest/download/shimmy-linux-aarch64) | Airframe (WebGPU) | ARM cross-build |
346348

347349
#### **🎯 How GPU Selection Works**
348350

@@ -429,7 +431,7 @@ Point your development tools to the displayed port — VSCode Copilot, Cursor, C
429431
## 📦 Download & Install
430432

431433
### Package Managers
432-
- **Rust**: [`cargo install shimmy`](https://crates.io/crates/shimmy) *(installs huggingface engine; for Airframe GPU, use GitHub Releases binaries)*
434+
- **Rust**: [`cargo install shimmy`](https://crates.io/crates/shimmy) *(installs Airframe GPU engine)*
433435
- **VS Code**: [Shimmy Extension](https://marketplace.visualstudio.com/items?itemName=targetedwebresults.shimmy-vscode)
434436
- **npm**: `npm install -g shimmy-js` *(planned)*
435437
- **Python**: `pip install shimmy` *(planned)*
@@ -443,10 +445,10 @@ Point your development tools to the displayed port — VSCode Copilot, Cursor, C
443445
**Full compatibility confirmed!** Shimmy works on macOS with Metal GPU acceleration via wgpu.
444446

445447
```bash
446-
# Install from crates.io (huggingface engine)
448+
# Install from crates.io (Airframe GPU engine)
447449
cargo install shimmy
448450

449-
# For Airframe GPU engine, download the macOS binary from GitHub Releases:
451+
# For Airframe GPU engine, you can also download the macOS binary from GitHub Releases:
450452
curl -L https://github.com/Michael-A-Kuykendall/shimmy/releases/latest/download/shimmy-macos-arm64 -o shimmy && chmod +x shimmy
451453
```
452454

@@ -508,7 +510,7 @@ I built Shimmy to retain privacy-first control on my AI development and keep thi
508510
| `SHIMMY_BIND_ADDRESS` | `0.0.0.0:8080` | Full bind address (overrides port) |
509511
| `SHIMMY_MAX_CTX` | *(from GGUF)* | Override context window; activates YaRN RoPE scaling when above model native |
510512
| `SHIMMY_MODEL_PATHS` | *(see Zero Config)* | Colon-separated extra model search paths |
511-
| `SHIMMY_ENGINE_BACKEND` | `airframe` | `airframe` (default) or `llama` (legacy path) |
513+
| `SHIMMY_ENGINE_BACKEND` | `airframe` | `airframe` (default) |
512514
| `SHIMMY_ROPE_SCALE` | *(auto)* | Override computed YaRN scale factor |
513515
| `SHIMMY_KV_QUANT` | `f32` | KV cache quantization: `f32` (default) or `int4` ([TurboShimmy](#-turboshimmy-int4-kv)) |
514516
| `SHIMMY_PREFILL_CHUNK` | `64` | Tokens per prefill dispatch. Set to `8` on Windows if you see GPU TDR resets on long prompts |

docs/USER_MANUAL.zh-CN.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -165,21 +165,21 @@ curl -L https://github.com/Michael-A-Kuykendall/shimmy/releases/latest/download/
165165
chmod +x shimmy
166166
```
167167

168-
> **ARM64 注意**:Linux ARM64 版本使用 HuggingFace 引擎。Airframe 的 ARM64 交叉编译支持正在开发中
168+
> **ARM64 注意**:Linux ARM64 版本使用 Airframe 引擎,支持交叉编译
169169
170170
### 方式二:通过 cargo 安装
171171

172172
```bash
173-
# 从 crates.io 安装(使用 HuggingFace 引擎,无需 GPU 即可运行
173+
# 从 crates.io 安装(Airframe GPU 引擎
174174
cargo install shimmy
175175
```
176176

177177
### 方式三:从源码构建(含 Airframe 引擎)
178178

179179
```bash
180-
git clone https://github.com/Michael-A-Kuykendall/shimmy --recurse-submodules
180+
git clone https://github.com/Michael-A-Kuykendall/shimmy
181181
cd shimmy
182-
cargo build --release --features airframe,huggingface
182+
cargo build --release --features airframe
183183

184184
# 构建完成后,二进制文件位于:
185185
./target/release/shimmy
@@ -1109,21 +1109,21 @@ curl http://127.0.0.1:11435/api/health
11091109
### 构建步骤
11101110

11111111
```bash
1112-
# 克隆仓库(含 Airframe 子模块)
1113-
git clone https://github.com/Michael-A-Kuykendall/shimmy --recurse-submodules
1112+
# 克隆仓库
1113+
git clone https://github.com/Michael-A-Kuykendall/shimmy
11141114
cd shimmy
11151115

1116-
# 构建(仅 HuggingFace 引擎,快速构建,适合 CI
1116+
# 构建(含 Airframe GPU 引擎,默认,推荐用于正式使用
11171117
cargo build --release
11181118

1119-
# 构建( Airframe GPU 引擎,推荐用于正式使用
1120-
cargo build --release --features airframe,huggingface
1119+
# 构建(CPU-only,无 Airframe GPU)
1120+
cargo build --release --no-default-features
11211121

11221122
# 运行测试
1123-
cargo test --features huggingface
1123+
cargo test
11241124

11251125
# 安装到系统
1126-
cargo install --path . --features airframe,huggingface
1126+
cargo install --path .
11271127
```
11281128

11291129
### 交叉编译

docs/USER_MANUAL.zh-TW.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -165,21 +165,21 @@ curl -L https://github.com/Michael-A-Kuykendall/shimmy/releases/latest/download/
165165
chmod +x shimmy
166166
```
167167

168-
> **ARM64 注意**:Linux ARM64 版本使用 HuggingFace 引擎。Airframe 的 ARM64 交叉編譯支援正在開發中
168+
> **ARM64 注意**:Linux ARM64 版本使用 Airframe 引擎,支援交叉編譯
169169
170170
### 方式二:透過 cargo 安裝
171171

172172
```bash
173-
# 從 crates.io 安裝(使用 HuggingFace 引擎,無需 GPU 即可執行
173+
# 從 crates.io 安裝(Airframe GPU 引擎
174174
cargo install shimmy
175175
```
176176

177177
### 方式三:從原始碼建置(含 Airframe 引擎)
178178

179179
```bash
180-
git clone https://github.com/Michael-A-Kuykendall/shimmy --recurse-submodules
180+
git clone https://github.com/Michael-A-Kuykendall/shimmy
181181
cd shimmy
182-
cargo build --release --features airframe,huggingface
182+
cargo build --release --features airframe
183183

184184
# 建置完成後,執行檔位於:
185185
./target/release/shimmy
@@ -1100,21 +1100,21 @@ curl http://127.0.0.1:11435/api/health
11001100
### 建置步驟
11011101

11021102
```bash
1103-
# 複製儲存庫(含 Airframe 子模組)
1104-
git clone https://github.com/Michael-A-Kuykendall/shimmy --recurse-submodules
1103+
# 複製儲存庫
1104+
git clone https://github.com/Michael-A-Kuykendall/shimmy
11051105
cd shimmy
11061106

1107-
# 建置(僅 HuggingFace 引擎,快速建置,適合 CI
1107+
# 建置(含 Airframe GPU 引擎,預設,建議用於正式使用
11081108
cargo build --release
11091109

1110-
# 建置( Airframe GPU 引擎,建議用於正式使用
1111-
cargo build --release --features airframe,huggingface
1110+
# 建置(CPU-only,不含 Airframe GPU)
1111+
cargo build --release --no-default-features
11121112

11131113
# 執行測試
1114-
cargo test --features huggingface
1114+
cargo test
11151115

11161116
# 安裝至系統
1117-
cargo install --path . --features airframe,huggingface
1117+
cargo install --path .
11181118
```
11191119

11201120
### 交叉編譯

docs/v2-roadmap.md

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Shimmy v2.x Roadmap
22

33
**Last Updated:** 2026-06-07
4-
**Branch:** `feature/local-dev-platform-setup`
5-
**Current version:** 1.7.4 (publishing toward 2.0.0)
4+
**Branch:** `release/v2.2-cleanup`
5+
**Current version:** 2.1.0 → 2.2.0
66

77
---
88

@@ -19,43 +19,45 @@ historically parked at `archive/llama-cpp-era-v1.9.0`.
1919

2020
## Roadmap Items
2121

22-
### 🔴 P0 — In Progress
22+
### 🟢 P0 — Done
2323

2424
**Wire airframe as default inference engine**
25-
*Status:* Stub mode (`Backend: Stub mode`) — server starts, models load, no generation
26-
*Work:* Connect `InferenceEngineAdapter` → airframe GGUF loading → token generation
27-
*Blocks:* Everything else in this roadmap
25+
*Status:* ✅ Complete — `InferenceEngineAdapter` wired to airframe GGUF loading and token generation. Server starts, models load, and generation works.
2826
*Points:* 5
2927

3028
---
3129

32-
### 🟠 P1 — Next
30+
### 🟢 P1 — Done
3331

3432
**Strip llama.cpp + HuggingFace Python bridge**
35-
*Status:* Gated but present, causing compile weight
36-
*Work (8 points total):*
37-
- Remove `shimmy-llama-cpp-2` dep and all `#[cfg(feature="llama")]` blocks (5pt)
38-
- Remove HuggingFace Python subprocess bridge (3pt)
39-
- Remove `src/engine/llama.rs`, `universal.rs`, `huggingface.rs`
40-
- Clean `adapter.rs` down to airframe-only path
41-
- Clean `main.rs` of MoE config, GPU backend selection, llama diagnostics
42-
- Update CHANGELOG, README, wiki to reflect v2 engine
43-
44-
*Sequence:*
45-
1. Cargo.toml — remove deps/features
46-
2. Delete dead engine files
47-
3. Clean engine/mod.rs
48-
4. Thin out adapter.rs
49-
5. Clean main.rs
50-
6. cargo check → 0 warnings, 0 errors
51-
7. Docs update
33+
*Status:* ✅ Complete — dead engine files removed, `adapter.rs` cleaned to airframe-only path, `main.rs` stripped of MoE config and llama diagnostics. `cargo check` passes 0 warnings, 0 errors.
34+
*Work completed (8 points total):*
35+
- Removed `shimmy-llama-cpp-2` dep and all `#[cfg(feature="llama")]` blocks (5pt)
36+
- Removed HuggingFace Python subprocess bridge (3pt)
37+
- Removed `src/engine/llama.rs`, `universal.rs`, `huggingface.rs`
38+
- Cleaned `adapter.rs` down to airframe-only path
39+
- Cleaned `main.rs` of MoE config, GPU backend selection, llama diagnostics
40+
- Updated CHANGELOG, README, wiki to reflect v2 engine
5241

5342
*Note:* Users who need llama.cpp have `archive/llama-cpp-era-v1.9.0` on origin.
5443

5544
---
5645

5746
### 🟡 P2 — Soon
5847

48+
**SafeTensors native inference**
49+
*Status:* Not started — `safetensors_native.rs` module exists with a stub `generate()` method
50+
*Work:* Replace stub `generate()` with real inference via airframe. This is the inference path for `.safetensors` files (HF format, no GGUF conversion required).
51+
*Design:*
52+
- `safetensors_native.rs` stub wired into `InferenceEngineAdapter` routing
53+
- `generate()` delegates to airframe with SafeTensors tensor layout
54+
- Adds `.safetensors` to the model discovery file filter
55+
*Points:* 5
56+
57+
---
58+
59+
### 🟡 P2 — Soon
60+
5961
**HuggingFace Hub model sourcing (pure Rust)**
6062
*Status:* Not started
6163
*Motivation:* The shim should accept HF model IDs, not just local paths.
@@ -121,11 +123,11 @@ Users on the historical llama.cpp path: check out `archive/llama-cpp-era-v1.9.0`
121123

122124
---
123125

124-
## Build Matrix (Target State)
126+
## Build Matrix (Current State)
125127

126128
| Command | What you get |
127129
|---------|-------------|
128-
| `cargo build` | shimmy with huggingface feature (safe default) |
130+
| `cargo build` | shimmy with Airframe GPU engine (default features: `airframe`) |
131+
| `cargo build --no-default-features` | CPU-only build (no Airframe GPU) |
129132
| `cargo build --features console` | shimmy + local AI dev console |
130-
| `cargo build --features llama` | shimmy + llama.cpp (historical, still works) |
131-
| `cargo build --features full` | everything |
133+
| `cargo build --features full` | shimmy + Airframe + MLX (Apple Silicon) |

0 commit comments

Comments
 (0)