zipnn 0.3.5

A lossless and near-lossless compression method optimized for numbers/tensors in the Foundation Models environment

ZipNN - A Lossless Compression Library for AI pipelines

TL;DR - simple, fast, and effective model compression

Download compressed models from Hugging Face

Try out yourself the compressed ibm-granite granite-7b-instruct hosted on Hugging Face:

pip install zipnn

from transformers import AutoTokenizer, AutoModelForCausalLM
from zipnn import zipnn_hf

zipnn_hf()

tokenizer = AutoTokenizer.from_pretrained("royleibov/granite-7b-instruct-ZipNN-Compressed")
model = AutoModelForCausalLM.from_pretrained("royleibov/granite-7b-instruct-ZipNN-Compressed")

ZipNN also allows you to seamlessly save local disk space in your cache after the model is downloaded.

To compress the cached model, simply run:

python zipnn_compress_path.py safetensors --model royleibov/granite-7b-instruct-ZipNN-Compressed --hf_cache

The model will be decompressed automatically and safely as long as zipnn_hf() is added at the top of the file like in the example above.

To decompress manually, simply run:

python zipnn_decompress_path.py --model royleibov/granite-7b-instruct-ZipNN-Compressed --hf_cache

You can try other state-of-the-art compressed models from the updating list below:

ZipNN Compressed Models Hosted on Hugging Face
compressed meta-llama/Llama-3.2-11B-Vision-Instruct
compressed ibm-granite/granite-7b-instruct
compressed meta-llama/Meta-Llama-3.1-8B-Instruct
compressed Qwen/Qwen2-VL-7B-Instruct
compressed ai21labs/Jamba-v0.1
compressed upstage/solar-pro-preview-instruct
compressed microsoft/Phi-3.5-mini-instruct
compressed ibm-granite/granite-3b-code-base-128k

You can also try one of these python notebooks hosted on Kaggle: granite 3b, Llama 3.2, phi 3.5.

Click here to explore other examples of compressed models hosted on Hugging Face
Click here to see full Hugging Face integration documentation

Getting started (fast)

Download the scripts for compressing/decompressing AI Models:

wget -i https://raw.githubusercontent.com/zipnn/zipnn/main/scripts/scripts.txt

To compress a file:

python3 zipnn_compress_file.py model_name

To decompress a file:

python3 zipnn_decompress_file.py compressed_model_name.znn

Introduction

In the realm of data compression, achieving a high compression/decompression ratio often requires careful consideration of the data types and the nature of the datasets being compressed. For instance, different strategies may be optimal for floating-point numbers compared to integers, and datasets in monotonic order may benefit from distinct preparations.

ZipNN is a lossless compression library optimized for numbers/tensors in the Foundation Models environment, designed to automatically prepare the data for compression according to its type. By simply calling zipnn.compress(data), users can rely on the package to apply the most effective compression technique under the hood.

Click here to explore the options we use for different datasets and data types

Given a specific data set, ZipNN automatically rearranges the data according to it's type, and applies the most effective techniques for the given instance to improve compression ratios and speed. It is especially effective for BF16 models, typically saving 33% of the model size, whereas with models of type FP32 it usually reduces the model size by 17%.

Some of the techniques employed in ZipNN are described in our paper: Lossless and Near-Lossless Compression for Foundation Models A follow up version with a more complete description is under preparation.

Currently, ZipNN compression methods are implemented on CPUs, and GPU implementations are on the way.

Results

Below is a comparison of compression results between ZipNN and several other methods on bfloat16 data.

Compressor name	Compression ratio / Output size	Compression Throughput	Decompression Throughput
ZipNN v0.2.0	1.51 / 66.3%	1120MB/sec	1660MB/sec
ZSTD v1.56	1.27 / 78.3%	785MB/sec	950MB/sec
LZ4	1 / 100%	---	---
Snappy	1 / 100%	---	---

• Gzip, Zlib compression rate are similar to ZSTD, but much slower.
• The above results are for a single-threaded compression (Working with chunks size of 256KB).
• Similar results with other BF16 Models such as Mistral, Lamma-3, Lamma-3.1, Arcee-Nova and Jamba.

Installation using pip

pip install zipnn

Install source code

git clone [e-mail]:zipnn/zipnn.git
cd zipnn

We are using two submodules:

• Cyan4973/FiniteStateEntropy [https://github.com/Cyan4973/FiniteStateEntropy]
• facebok/zstd [https://github.com/facebook/zstd] tag 1.5.6

git submodule update --init --recursive

Compile locally using pip

pip install -e .

Dependencies

This project requires the following Python packages:

• numpy
• zstandard
• torch

Usage

Ready Made Scripts for file Compression/ Decompression

You can integrate zipnn compression and decompression into your own projects by utilizing the scripts available in the scripts folder. This folder contains the following scripts:

• zipnn_compress_file.py: For compressing an individual file.
• zipnn_decompress_file.py: For decompressing an individual file.
• zipnn_compress_path.py: For compressing all files under a path.
• zipnn_decompress_path.py: For decompressing all files under a path.

Compress one file:

python zipnn_compress_file.py model_name

Decompress one file:

python zipnn_decompress_file.py model_name.znn

For detailed information on how to use these scripts, please refer to the README.md file located in the scripts folder.

Import Package Manually

You can use the package manually, like so:

Import zipnn:

from zipnn import ZipNN

Instance class:

zpn = ZipNN(method='zstd', input_format='torch')

Create a 1MB tensor with random numbers from a uniform distribution between -1 and 1 The dtype is bfloat

import torch
original_tensor = torch.rand(10124*1024, dtype=torch.bfloat16) * 2 - 1

Compression:

compressed_data = zpn.compress(original_tensor)

Decompression:

decompressed_data = zpn.decompress(compressed_data)

Check for correctness:

torch.equal(original_tensor, decompressed_data)

Example

Example of a real module

In this example, ZipNN and ZSTD compress and decompress 1GB of the Granite model and validate that the original file and the decompressed file are equal.
The script reads the file and compresses and decompresses in Byte format.

> python3 simple_example_granite.py
...
Are the original and decompressed byte strings the same [BYTE]?  True

Example of compressing a model hosted on Hugging Face

In this example, ZipNN compresses a full model hosted on the Hugging Face AI-Hub.

From the model's directory (which can be forked locally. Make sure you git lfs pull upstream before continuing) run:

python3 zipnn_compress_path.py safetensors --path .

Add the compressed weights to git-lfs tracking

git lfs track "*.znn" &&
sed -i 's/.safetensors/.safetensors.znn/g' model.safetensors.index.json &&
git add *.znn .gitattributes model.safetensors.index.json &&
git rm *.safetensors

Done! Now push the changes as per the documentation.

To use the model simply run our ZipNN Hugging Face method before proceeding as normal:

from zipnn import zipnn_hf

zipnn_hf()

# Load the model from your compressed Hugging Face model card as you normally would
...

You can test Jamba-v0.1-ZipNN-Compressed and granite-7b-instruct-ZipNN-Compressed yourself (both compressed to 67% their original sizes - which could save ~1PB for ai21labs Jamba-v0.1 and ~30TB for ibm-granite granite-7b-instruct of monthly downloads).

Configuration

The default configuration is ByteGrouping of 4 with vanilla ZSTD (running with 8 threads), and the input and outputs are "byte". For more advanced options, please consider the following parameters:

• method: Compression method, Supporting zstd, lz4, snappy (default value = 'zstd').

• input_format: The input data format, can be one of the following: torch, numpy, byte (default value = 'byte').

• bytearray_dtype: The data type of the byte array, if input_format is 'byte'. If input_format is torch or numpy, the dtype will be derived from the data automatically (default value = 'float32').

• threads: The maximum threads for the compression and the bit manipulation. If 0, the code decides according to the dataset length (default value = 1).

• compression_threshold: Save original buffer if not compress above the threshold (default value = 0.95).

• check_th_after_percent: Check the compression threshold after % from the number of chunk and stop compressing if not pass the compression_threshold. (default value = 10[%]).

• byte_reorder: Number of grouping. The format is the following:

  • Bit Format:

    • [7] - Group 0/1: 4th Byte
    • [6-5] - Group 0/1/2: 3rd Byte
    • [4-3] - Group 0/1/2/3: 2nd Byte
    • [2-0] - Group 0/1/2/3/4: 1st Byte

  • Examples:

    • bg16: Two groups - 0_00_01_010 (decimal 10)
    • fp32: Four groups - 1_10_11_100 (decimal 220)
    • int32: Truncate two MSBs - 0_00_01_001 (decimal 9)

• reorder_signbit: This parameter controls the reordering of the sign bit for float32 or bfloat16 to improve compression. Options are:

  • 255: No reordering of the sign bit.
  • 16: Reorders the sign bit for bfloat16.
  • 32: Reorders the sign bit for float32.
  • 0: Automatically decides based on the data type (default value = 0).

• compression_chunk: Chunk size for compression. (default value = 256KB).

Click here to explore additional ZipNN configuration options

Validation test

Run tests for Byte/File input types, Byte/File compression types, Byte/File decompression types.

python3 -m unittest discover -s tests/ -p test_suit.py

Statistics

Support and Questions

We are excited to hear your feedback!

For issues and feature requests, please open a GitHub issue.

Contributing

We welcome and value all contributions to the project! You can contact us in this email: [e-mail]

Change Log

v0.3.5

• Add float32 to the C implementation with Huffman compression.

v0.3.4

• Plugin for Hugging Face transformers to allow using from_pretrained and decompressing the model after downloading it from Hugging Face.

• Add Delta compression support in python -> save Xor between two models and compress them).

v0.3.2

• Change ZipNN suffix from .zpn to .znn

v0.3.1

• Prepare dtype16 (BF16 and FP16) for multi-threading by changing its C logic. For each chunk, byte ordering, bit ordering, and compression are processed separately.

• Integrate the Streaming support into zipnn python code.

v0.2.4

• Add support for Streaming when using outside scripts

• Fix bug: Compression didn't work when compressing files larger than 3GB

v0.2.3

• Change the byte ordering implementation to C (for better performance).

• Change the bfloat16/float16 implementation to a C implementation with Huffman encoding, running on chunks of 256KB each.

• Float 32 using ZSTD compression as in v0.1.1

• Add support with uint32 with ZSTD compression.

v0.1.1

• Python implementation of compressing Models, float32, float15, bfloat16 with byte ordering and ZSTD.

Cite

@article{hershcovitch2024lossless,
  title={Lossless and Near-Lossless Compression for Foundation Models},
  author={Hershcovitch, Moshik and Choshen, Leshem and Wood, Andrew and Enmouri, Ilias and Chin, Peter and Sundararaman, Swaminathan and Harnik, Danny},
  journal={arXiv preprint arXiv:2404.15198},
  year={2024}
}