Skip to main content

RPQ-pytorch

Reverse Product Quantization (RPQ) of weights to reduce static memory usage.

Table of Contents

Introduction

Product quantization is a method for reducing the memory requirements for vector similarity search. It reduces the memory footprint by chunking the vectors into subvectors that are each compressed into a set of codebooks with 256 codes each. This allows us to have a set of codes that can be represented by uint8 indices instead of the full vector representation.

If we reverse this process, we can dynamically spawn a larger set of vectors from a much smaller set of codebooks containing sub-vectors and a set of randomized uint8 indices, rather than having to persistently hold a much larger set of vectors. This can be used during the forward pass to expand/compile the weight just-in-time in order to perform the operations on the input.

This creates a state for a model where the weights are "dormant" and expanded to their active state just before use. This plays very well with methods like gradient checkpointing (and inference, similarly) where we can unpack the weights again rather then storing them. In other words, the weights are part of the dynamic computational graph and can be forgotten/unpacked whenever they are needed.

However, this doesn't come for free, the indices inherit from a set of shared codebooks, so the larger the weights, the more likelihood that vectors generated will share sub-vectors. This can be prevented by increasing the number of codebooks, but requires more testing to see what the minimum number of codebooks required for each implementation should be.

For instance, in the Usage section we define an RPQOPT model(OPT variant w/ RPQ weights) where the number of codebooks is set to the number of heads. This is chosen abitrarily, but works well since the hidden_dim must be divisible by num_codebooks.

The effect of having a set of entangled vectors is unknown and would require rigorous testing with standard benchmarks for comparison. Intuitively, this would have a different outcome depending on the way the final weight structure is used. For a vector quantization module, it could be advantageous to have codes be entangled to avoid the issue of "dead codes" and increase codebook utilization.

Installation

pip install rpq-pytorch

Usage

Standalone Weights

A standalone module RPQWeight is available as an nn.Module wrapper that intializes a set of dynamic PQ weight and returns the expanded set of weight vectors.

from rpq.nn import RPQWeight

w = RPQWeight(num_codebooks=72, codebook_dim=128, num_vectors=9216) 

print(w.codebooks.shape, w.indices.shape) # torch.Size([72, 256, 128]) torch.Size([72, 9216])

print(w().shape) # torch.Size([9216, 9216])

Layers

A set of common layers are re-implemented with quantized weights. It follows the same usage as torch.nn modules with an extra argument for the num_codebooks for each layer. For each layer, the out_features/num_embeddings must be divisible by the num_codebooks.

from rpq.nn import RPQLinear

layer = RPQLinear(in_features=1024, out_features=1024, num_codebooks=16)

x = torch.randn(1, 1, 1024) # (b, n, d)
y = layer(x) # (1, 1, 4096)

Layers implemented:

  • RPQLinear
  • RPQEmbedding*
  • RPQConv1d
  • RPQConv2d
  • RPQConvTranspose2d
  • RPQConv1d
  • RPQConvTranspose1d
  • RPQConv3d
  • RPQConvTranspose3d
  • RPQBilinear

*Note: Embedding layers are a lookup table and therefore very fast, as such the operation to expand the weights for RPQEmbedding adds a lot of time to the operation especially for a small number of tokens (10s of $\mu s$ -> 10s of ms).

Models

Using the layer implementations, we can implement models via drop-in replacement of their static weight counterparts.

RPQViT (ViT Giant)
from vit_pytorch import ViT
from rpq.models.rpqvit import RPQViT
from rpq.utils import model_size

# vit_giant_patch14_336
model = ViT(
    image_size=336,
    patch_size=14,
    num_classes=1000,
    dim=1280,
    depth=32,
    heads=16,
    mlp_dim=5120,
    dropout=0.1,
    emb_dropout=0.1
)

# rpqvit_giant_patch14_336
rpq_model = RPQViT(
    image_size=336,
    patch_size=14,
    num_classes=1000,
    dim=1280,
    depth=32,
    heads=16,
    mlp_dim=5120,
    dropout=0.1,
    emb_dropout=0.1
)

model_size(model)
model_size(rpq_model)
model size: 2252.157MB
model size: 361.429MB  

Approximately ~6x reduction in model size.

RPQOPT (opt-66b)
import torch
from transformers.models.opt.modeling_opt import OPTConfig
from transformers import GPT2Tokenizer
from rpq.models.rpqopt import RPQOPTModel
from rpq.utils import model_size


tokenizer = GPT2Tokenizer.from_pretrained("facebook/opt-66b")
conf = OPTConfig.from_pretrained("facebook/opt-66b")
rpq_model = RPQOPTModel(conf) # randomly initialized model

inputs = tokenizer("Hello, my dog is cute.", return_tensors="pt")

with torch.no_grad():
    outputs = rpq_model(**inputs)

model_size(rpq_model)
model size: 5885.707MB 

This is an RPQOPT-66b initialized at float32 precision, a static weight version (standard OPT-66b) would be 264 GB in size. This amounts to approximately ~44x reduction in size.

Benchmarks

Due to the entanglement of the weight matrix arising as result of the inheritance from a shared set of codebooks, testing the RPQ model variants against the original methods would be important to characterize issues/tradeoffs with training stability, especially at scale. Those tests will be displayed in the table below:

Model Config Model Size Dataset Validation Accuracy Epochs
ViT vit_base_patch16_224 330MB MNIST TBD 90
RPQViT vit_base_patch16_224 88MB MINST TBD 90
ViT vit_base_patch16_224 330MB CIFAR10 TBD 90
RPQViT vit_base_patch16_224 88MB CIFAR10 TBD 90
ViT vit_base_patch16_224 330MB Imagenet TBD 90
RPQViT vit_base_patch16_224 88MB Imagenet TBD 90

TODO

  • Implement RPQConv1d layer
  • Implement RPQConv2d layer
  • Implement RPQConv3d layer
  • Implement RPQConvTranspose1d layer
  • Implement RPQConvTranspose2d layer
  • Implement RPQConvTranspose3d layer
  • Implement RPQBilinear layer
  • Perform benchmarks with ViTs (ViT vs RPQViT)
  • Perform benchmarks with LLMs (BERT, OPT, etc.,)
  • Explore methods of conversion from pre-trained static weights to dynamic RPQ weights

Metadata

Release files for RPQ-pytorch 0.0.34

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for RPQ-pytorch 0.0.34
File Size Uploaded Provenance Actions
RPQ-pytorch-0.0.34.tar.gz 31.4 kB Without provenance Details for RPQ-pytorch-0.0.34.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for RPQ-pytorch 0.0.34
File Interpreter ABI Platform Actions
RPQ_pytorch-0.0.34-py3-none-any.whl Python 3 none any Details for RPQ_pytorch-0.0.34-py3-none-any.whl

Total release size: 66.2 kB

Release files / RPQ-pytorch-0.0.34.tar.gz

Download URL RPQ-pytorch-0.0.34.tar.gz
Size 31.4 kB
Tags Source
SHA-256 checksum
How to use checksums
260defa0703cfed7d1ca2d8156133cbd28ac2f0e166920b56a365781b5248acd
BLAKE2b-256 checksum
How to use checksums
33b00c09dafac1b3053bcb2a63fe06b296ff360e9e357851e3ceecab1e03d620
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.5

Release files / RPQ_pytorch-0.0.34-py3-none-any.whl

Download URL RPQ_pytorch-0.0.34-py3-none-any.whl
Size 34.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
eed345f0f8720ad5ffc6d1172cc0f5a9fb14cd8dfa8f800addc867300442c4be
BLAKE2b-256 checksum
How to use checksums
6e85b6df5ff1817534aef52fded55c11b7dd66256d2bae29c425404e7aaedbb6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.5

Security for RPQ-pytorch 0.0.34

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page