Skip to main content

d-Matrix Compressor

Project description

dmx-compressor

Build License Documentation GitHub release Commits Contributors Stars


This project contains tools for deep neural net co-design for custom hardware accelerators.


Overview

In essence this is an extension of the PyTorch framework that implements hardware-efficient features, including

  • custom low-precision numerical formats and arithmetic,
  • fine-grain structured weight sparsity, and
  • custom operator approximation logic.

In addition, the project provides a set of optimization tools for co-design using the above features.

Getting started

pip install dmx-compressor

Usage

Basic API

Given a PyTorch model, e.g. Net(), wrap it in a DmxModel container:

from dmx.compressor.modeling import DmxModel

model = DmxModel.from_torch(Net())

Here model is functionally equivalent to Net(), and all torch functionalities are still available, but model is equipped with d-Matrix specific features, making it ready for co-design configuration and/or optimization, at training time or post-training. See advanced topics for further details.

model.dmx_config is a dictionary that contains all, and only those, configurations that affect the functional behavior of the model, different from the behavior of the original Net(). Use method model.transform() to set these configurations, through application of configuration rules. See advanced topics for engineering of configuration rules.

There are two predefined special rule sets config_rules.BASELINE and config_rules.BASIC; the former is a dummy that does not change the original model's functional behavior, whereas the latter brings the model to a functional state that is equivalent to basic-mode execution on d-Matrix's hardware, e.g.

from dmx.compressor import config_rules
model = model.transform(
    model.dmx_config,
    *config_rules.BASIC,
)

Hugging Face pipeline API

To leverage the popularity of Hugging Face's pipeline API for inference, we extend transformers.pipeline() to dmx.compressor.modeling.hf.pipeline(), which retains all existing functionality of pipelines while enabling model transformation and configuration for deployment on d-Matrix hardware.

from dmx.compressor.modeling.hf import pipeline

pipe = pipeline(
    task="text-generation",
    model="facebook/opt-125m",
    dmx_config="BASIC",  # make the model deployable on d-Matrix backend
    ...
)

# Deploy pipe the same way as Hugging Face provides.

Next steps

For more detailed information, go over the following documents on specific topics. Find more usage examples here.

  • Configurations
  • Numerics
  • Weight sparsity
  • Custom approximation logic

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dmx_compressor-0.1.7.tar.gz (106.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dmx_compressor-0.1.7-py3-none-any.whl (110.1 kB view details)

Uploaded Python 3

File details

Details for the file dmx_compressor-0.1.7.tar.gz.

File metadata

  • Download URL: dmx_compressor-0.1.7.tar.gz
  • Upload date:
  • Size: 106.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.10.2 Darwin/24.2.0

File hashes

Hashes for dmx_compressor-0.1.7.tar.gz
Algorithm Hash digest
SHA256 e55eb6d6788c70eb040019ab90a12c3c72ca4b795e0d67d916d85a5d18098c61
MD5 fc0fa0cfc9d537aa7412fd9d6d8734ce
BLAKE2b-256 9be3f1cd092906330091fc7d2c83df7f411ca0e2da30faa6507bb9097e74e292

See more details on using hashes here.

File details

Details for the file dmx_compressor-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: dmx_compressor-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 110.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.10.2 Darwin/24.2.0

File hashes

Hashes for dmx_compressor-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 bc6c06fc5ce4e5e43992b789a7f5ff1dff20603a0593ef3fe363544b13d70840
MD5 97da282eb338402315997be1c21841a3
BLAKE2b-256 f6599b80479e1c2532127d9be94fe5d3c8cb57c647f9b179972e1d579b0d8c24

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page