Document RKLLM artifacts and checksums

README.md

@@ -1,9 +1,8 @@
 ---
-license: other
-license_name: qwen-research
+license: apache-2.0
 base_model: Qwen/Qwen2.5-3B-Instruct
-library_name: rkllm
 pipeline_tag: text-generation
+library_name: rkllm
 tags:
 - rkllm
 - rockchip
@@ -11,96 +10,48 @@ tags:
 - rk3588
 - qwen
 - qwen2.5
-
 ---
 
 # Qwen2.5-3B-Instruct-RKLLM
 
-RKLLM-converted versions of Qwen2.5-3B-Instruct for Rockchip RK3576 and RK3588.
-
-`.rkllm` files require the Rockchip RKLLM runtime and cannot be loaded directly with Transformers, llama.cpp, or Ollama.
-
-## Base Model
+RKLLM-converted Qwen2.5-3B-Instruct language-model artifacts for Rockchip RK3576 and RK3588 NPUs.
 
-- Model: Qwen2.5-3B-Instruct
-- Author: Alibaba Cloud Qwen Team
-- Original Model: [Qwen/Qwen2.5-3B-Instruct](https://huggingface.co/Qwen/Qwen2.5-3B-Instruct)
-- Original License: Qwen Research License
+These hardware-specific `.rkllm` files require a compatible Rockchip RKLLM runtime. They are not Transformers checkpoints and cannot be loaded directly with Transformers, llama.cpp, or Ollama.
 
-Refer to the [upstream model card](https://huggingface.co/Qwen/Qwen2.5-3B-Instruct) for the original model’s capabilities and limitations.
+## Base model
 
-## Supported Platforms
+- Upstream model: [Qwen/Qwen2.5-3B-Instruct](https://huggingface.co/Qwen/Qwen2.5-3B-Instruct)
+- License: Qwen Research License
+- Model type: LLM (text only)
 
-| SoC    | Quantization | Status                   |
-| ------ | ------------ | ------------------------ |
-| RK3576 | W4A16        | ✅ Tested                 |
-| RK3576 | W8A8         | ✅ Tested                 |
-| RK3588 | W8A8         | ✅ Supported (not tested) |
+Review the upstream license and usage restrictions before use or redistribution.
 
-RK3576 W4A16 and W8A8 have been tested. RK3588 W8A8 is supported as a target platform but has not been board-tested because no RK3588 board is available.
+## Conversion and variants
 
-## Conversion
+Converted with RKLLM Toolkit 1.2.3. Use a file built for the exact target SoC.
 
-- RKLLM Toolkit: 1.2.3
-- Target Platforms: RK3576, RK3588
+| Target | Quantization | File | SHA256 |
+| --- | --- | --- | --- |
+| RK3576 | W4A16 | [Qwen2.5-3B-Instruct_RK3576_w4a16.rkllm](RK3576/Qwen2.5-3B-Instruct_RK3576_w4a16.rkllm) | `5f2480e10a794848c8d4a5a21a61c015d96570f2a58e4543897b694b59576908` |
+| RK3576 | W8A8 | [Qwen2.5-3B-Instruct_RK3576_w8a8.rkllm](RK3576/Qwen2.5-3B-Instruct_RK3576_w8a8.rkllm) | `5a14ed85f65d3c2890ef8e2b4ab9f094bf9b0992ddebd6f2b9ad8d3b539897b9` |
+| RK3588 | W8A8 | [Qwen2.5-3B-Instruct_RK3588_w8a8.rkllm](RK3588/Qwen2.5-3B-Instruct_RK3588_w8a8.rkllm) | `054a4ac54ea7d483ac17431df5286eb6b2a81d351fbb44b55dc4491f71a7ea46` |
 
-## Available Variants
-
-| File                                                         | Quantization |
-| ------------------------------------------------------------ | ------------ |
-| [Qwen2.5-3B-Instruct_w4a16_RK3576.rkllm](RK3576/Qwen2.5-3B-Instruct_w4a16_RK3576.rkllm) | W4A16        |
-| [Qwen2.5-3B-Instruct_w8a8_RK3576.rkllm](RK3576/Qwen2.5-3B-Instruct_w8a8_RK3576.rkllm) | W8A8         |
-| [Qwen2.5-3B-Instruct_w8a8_RK3588.rkllm](RK3588/Qwen2.5-3B-Instruct_w8a8_RK3588.rkllm) | W8A8         |
-
-## Repository Structure
-
-```text
-.
-├── Qwen2.5-3B-Instruct_data_quant.json
-├── RK3576
-│   ├── Qwen2.5-3B-Instruct_w4a16_RK3576.rkllm
-│   └── Qwen2.5-3B-Instruct_w8a8_RK3576.rkllm
-└── RK3588
-    └── Qwen2.5-3B-Instruct_w8a8_RK3588.rkllm
-```
+The repository also includes `Qwen2.5-3B-Instruct_data_quant.json`, used as calibration data during conversion.
 
 ## Usage
 
-Download the desired RKLLM model and deploy it with the RKLLM runtime on the matching Rockchip platform.
-
-For faster deployment without setting up the environment manually, see [Hanzo-Huang/rkllm-docker](https://github.com/Hanzo-Huang/rkllm-docker).
-
-### Docker Deployment
-
-Use the model-specific image for the fastest RK3576 W4A16 deployment. The model is included in the image:
-
-```bash
-sudo docker run --rm -it \
-  --privileged \
-  -p 8001:8001 \
-  -v /dev:/dev \
-  ghcr.io/hanzo-huang/rkllm-docker/qwen2.5-3b-instruct:w4a16-rk3576
-```
-
-Alternatively, use the reusable environment image and mount a downloaded model:
-
 ```bash
-sudo docker run --rm -it \
-  --privileged \
-  -p 8001:8001 \
-  -v /dev:/dev \
-  -v ./:/app/models:ro \
-  -e MODEL_PATH=/app/models/RK3576/Qwen2.5-3B-Instruct_w4a16_RK3576.rkllm \
-  -e TARGET_PLATFORM=rk3576 \
-  ghcr.io/hanzo-huang/rkllm-docker:env-latest
+hf download HanzoHuang/Qwen2.5-3B-Instruct-RKLLM \
+  RK3576/Qwen2.5-3B-Instruct_RK3576_w4a16.rkllm \
+  --local-dir Qwen2.5-3B-Instruct-RKLLM
 ```
 
-The second command requires downloading the selected `.rkllm` file first. Use the matching model variant and target platform.
+Use the Qwen2.5 Instruct chat template with the RKLLM runtime. For Docker deployment, see [Hanzo-Huang/rkllm-docker](https://github.com/Hanzo-Huang/rkllm-docker).
 
-## License
+## Limitations
 
-The original Qwen2.5-3B-Instruct model is released under the Qwen Research License. Converted artifacts are derived from the original model and remain subject to the applicable upstream license terms.
+These are target-specific converted artifacts. Validate quality and runtime compatibility on your Rockchip device.
 
 ## Acknowledgements
 
-Thanks to the Alibaba Cloud Qwen Team for releasing the original model and to Rockchip and RKLLM contributors for the deployment toolchain.
+Thanks to the Qwen Team, Rockchip, and the RKLLM community.