liang2kl commited on
Commit
c931afe
·
verified ·
1 Parent(s): c956635

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +16 -2
README.md CHANGED
@@ -19,7 +19,7 @@ base_model:
19
 
20
  ParoQuant is the state-of-the-art INT4 quantization for LLMs. It closes the accuracy gap with FP16 while running at near-AWQ speed. Supports NVIDIA GPUs (vLLM, Transformers) and Apple Silicon (MLX).
21
 
22
- [`z-lab/Qwen3.5-2B-PARO`](https://huggingface.co/z-lab/Qwen3.5-2B-PARO) is a 4-bit [`Qwen/Qwen3.5-2B`](https://huggingface.co/Qwen/Qwen3.5-2B) quantized with [ParoQuant](https://github.com/z-lab/paroquant). Check out other ParoQuant models from the Hugging Face [collection](https://huggingface.co/collections/z-lab/paroquant). Swap the model name in the commands below to try any of them.
23
 
24
 
25
  ## Quick Start
@@ -27,9 +27,14 @@ ParoQuant is the state-of-the-art INT4 quantization for LLMs. It closes the accu
27
  ### Installation
28
 
29
  ```bash
30
- # NVIDIA GPU
31
  pip install "paroquant[vllm]"
32
 
 
 
 
 
 
33
  # Apple Silicon
34
  pip install "paroquant[mlx]"
35
  ```
@@ -40,12 +45,16 @@ pip install "paroquant[mlx]"
40
  python -m paroquant.cli.chat --model z-lab/Qwen3.5-2B-PARO
41
  ```
42
 
 
 
43
  ### OpenAI-Compatible API Server
44
 
45
  ```bash
46
  python -m paroquant.cli.serve --model z-lab/Qwen3.5-2B-PARO --port 8000
47
  ```
48
 
 
 
49
  ### Agent with Tool Calling
50
 
51
  Start the API server first, then install the agent dependencies and run:
@@ -59,13 +68,18 @@ Tool use (web fetch, filesystem, time) requires [Node.js](https://nodejs.org/en/
59
 
60
  ### Docker (NVIDIA GPU)
61
 
 
 
 
62
  ```bash
63
  # Interactive chat
64
  docker run --pull=always --rm -it --gpus all --ipc=host \
 
65
  ghcr.io/z-lab/paroquant:chat --model z-lab/Qwen3.5-2B-PARO
66
 
67
  # API server (port 8000)
68
  docker run --pull=always --rm -it --gpus all --ipc=host -p 8000:8000 \
 
69
  ghcr.io/z-lab/paroquant:serve --model z-lab/Qwen3.5-2B-PARO
70
  ```
71
 
 
19
 
20
  ParoQuant is the state-of-the-art INT4 quantization for LLMs. It closes the accuracy gap with FP16 while running at near-AWQ speed. Supports NVIDIA GPUs (vLLM, Transformers) and Apple Silicon (MLX).
21
 
22
+ z-lab/Qwen3.5-2B-PARO is a 4-bit [Qwen/Qwen3.5-2B](https://huggingface.co/Qwen/Qwen3.5-2B) quantized with ParoQuant. Check out other ParoQuant models from the Hugging Face [collection](https://huggingface.co/collections/z-lab/paroquant).
23
 
24
 
25
  ## Quick Start
 
27
  ### Installation
28
 
29
  ```bash
30
+ # NVIDIA GPU (CUDA 12.9)
31
  pip install "paroquant[vllm]"
32
 
33
+ # NVIDIA GPU (CUDA 13.0)
34
+ pip install "paroquant[vllm] vllm==0.17.1" \
35
+ --extra-index-url https://wheels.vllm.ai/0.17.1/cu130 \
36
+ --extra-index-url https://download.pytorch.org/whl/cu130
37
+
38
  # Apple Silicon
39
  pip install "paroquant[mlx]"
40
  ```
 
45
  python -m paroquant.cli.chat --model z-lab/Qwen3.5-2B-PARO
46
  ```
47
 
48
+ Add `--llm-only` if you do not wish to load the VLM components.
49
+
50
  ### OpenAI-Compatible API Server
51
 
52
  ```bash
53
  python -m paroquant.cli.serve --model z-lab/Qwen3.5-2B-PARO --port 8000
54
  ```
55
 
56
+ Add `--llm-only` if you do not wish to load the VLM components.
57
+
58
  ### Agent with Tool Calling
59
 
60
  Start the API server first, then install the agent dependencies and run:
 
68
 
69
  ### Docker (NVIDIA GPU)
70
 
71
+ > [!NOTE]
72
+ > The following commands map the local cache directory to the container in order to persist kernel cache across runs. Remove `-v ...` to disable this behaviour.
73
+
74
  ```bash
75
  # Interactive chat
76
  docker run --pull=always --rm -it --gpus all --ipc=host \
77
+ -v $HOME/.cache/paroquant:/root/.cache/paroquant \
78
  ghcr.io/z-lab/paroquant:chat --model z-lab/Qwen3.5-2B-PARO
79
 
80
  # API server (port 8000)
81
  docker run --pull=always --rm -it --gpus all --ipc=host -p 8000:8000 \
82
+ -v $HOME/.cache/paroquant:/root/.cache/paroquant \
83
  ghcr.io/z-lab/paroquant:serve --model z-lab/Qwen3.5-2B-PARO
84
  ```
85