Skip to main content

auto-zkml

This package is designed to provide functionality that facilitates the transition from ML algorithms to ZKML. Its two main functionalities are:

  • Serialization: saving a trained ML model in a specific format to be interpretable by other programs.

  • model-complexity-reducer (mcr): Given a model and a training dataset, transform the model and the data to obtain a lighter representation that maximizes the tradeoff between performance and complexity.

It's important to note that although the main goal is the transition from ML to ZKML, auto-zkml can be useful in other contexts, such as:

  • The model's weight needs to be minimal, for example for mobile applications.
  • Minimal inference times are required for low latency applications.
  • We want to check if we have created an overly complex model and a simpler one would give us the same performance (or even better).
  • The number of steps required to perform the inference must be less than X (as is currently constrained by the ZKML paradigm).

Installation

Install from PyPi

For the latest release:

pip install auto-zkml

Installing from source

Clone the repository and install it with pip:

    git clone git@github.com:gizatechxyz/auto-zkml.git
    cd auto-zkml
    pip install .

Serialization

To see in more detail how this tool works, check out this tutorial.

To run it:

from auto_zkml import serialize_model

serialize_model(YOUR_TRAINED_MODEL, "OUTPUT_PATH/MODEL_NAME.json")

mcr

To see in more detail how this tool works, check out this tutorial.

To run it:

model, transformer = mcr(model = MY_MODEL,
                         X_train = X_train,
                         y_train = y_train,
                         X_eval = X_test,
                         y_eval = y_test,
                         eval_metric = 'rmse',
                         transform_features = True)

Supported Models

Model status
XGBRegressor ✅
XGBClassifier ✅
LGBMRegressor ✅
LGBMClassifier ✅
Logistic Regression ⏳
GARCH ⏳

Metadata

Release files for auto-zkml 0.1.0

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

Source distribution (sdist)

Source distribution for auto-zkml 0.1.0
File Size Uploaded Provenance Actions
auto_zkml-0.1.0.tar.gz 12.4 kB Without provenance Details for auto_zkml-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for auto-zkml 0.1.0
File Interpreter ABI Platform Actions
auto_zkml-0.1.0-py3-none-any.whl Python 3 none any Details for auto_zkml-0.1.0-py3-none-any.whl

Total release size: 29.0 kB

Release files / auto_zkml-0.1.0.tar.gz

Download URL auto_zkml-0.1.0.tar.gz
Size 12.4 kB
Tags Source
SHA-256 checksum
How to use checksums
8825e2cdd6b68d2766ee0c2b3e3a9e62c6276d953a07db07bb09e17d7ce19821
BLAKE2b-256 checksum
How to use checksums
3179d53485640886244638bac53365a389d6adad56cbaea86079762f6d3e4f3c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.3

Release files / auto_zkml-0.1.0-py3-none-any.whl

Download URL auto_zkml-0.1.0-py3-none-any.whl
Size 16.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b85a0496b42adb2012301cd92a44a32d587d38defabbfce082c2962c722f1e5c
BLAKE2b-256 checksum
How to use checksums
8854ff523dbf20fc45511fde7e45961490113e10c7dfcd192ac859511ef67f74
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.3

Security for auto-zkml 0.1.0

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.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

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