WaveCut commited on
Commit
af88250
·
verified ·
1 Parent(s): 7552666

Document OrbitQuant 0.2.0 runtime

Browse files
Files changed (1) hide show
  1. README.md +2 -2
README.md CHANGED
@@ -19,7 +19,7 @@ OrbitQuant is a calibration-free post-training quantization method for image and
19
  Install OrbitQuant and the Hugging Face runtime dependencies:
20
 
21
  ```bash
22
- pip install "orbitquant[hf]"
23
  ```
24
 
25
  Download this model repository as an OrbitQuant artifact, then load the source Diffusers pipeline with the quantized component patched in:
@@ -49,7 +49,7 @@ image = pipe(
49
  image.save("z-image-orbitquant.png")
50
  ```
51
 
52
- `runtime_mode="auto_fused"` is the default optimized runtime. On CUDA it tries the native packed low-bit matmul kernel first, then Triton packed matmul. On MPS it requires the native Metal packed matmul kernel. Use `runtime_mode="dequant_bf16"` only as an explicit compatibility/debug reference path.
53
 
54
  ## Native Settings
55
 
 
19
  Install OrbitQuant and the Hugging Face runtime dependencies:
20
 
21
  ```bash
22
+ pip install "orbitquant[hf,kernels]>=0.2.0"
23
  ```
24
 
25
  Download this model repository as an OrbitQuant artifact, then load the source Diffusers pipeline with the quantized component patched in:
 
49
  image.save("z-image-orbitquant.png")
50
  ```
51
 
52
+ `runtime_mode="auto_fused"` is the default optimized runtime. On CUDA, the `kernels` extra provides the Triton packed fallback; a locally built native CUDA package is preferred automatically when installed. On MPS, build and install the native Metal package from the OrbitQuant source tree. See the [OrbitQuant runtime instructions](https://github.com/iamwavecut/OrbitQuant#native-packed-kernels). Use `runtime_mode="dequant_bf16"` only as an explicit compatibility/debug reference path.
53
 
54
  ## Native Settings
55