Skip to main content

A state-of-the-art framework for LLM fingerprinting and adversarial testing

Project description

MLprints

A framework for generating, training, and verifying LLM fingerprints.

Quick start

1 - Install

uv sync

Then use uv run mlprints … for the examples below, or activate the environment uv created.

Alternatively, in a virtual environment (with Python ≥ 3.11):

pip install -e .

2 - Set experiments directory

export MLPRINTS_EXPERIMENTS_DIR=/path/to/experiments

Alternatively, pass --experiments-dir to mlprints generate.

Some assets are downloaded on demand and cached locally (no large bundled data tree).

The currently registered fingerprint algorithm is Perinucleus, with training support. Available verifiers are string matching and a watermark z-test.

CLI

Command Role
mlprints generate CONFIG.yaml Generate fingerprints; add --train to train in the same run when supported.
mlprints train CONFIG.yaml --fingerprints-dir DIR Train on a previous generate output (DIR must contain fingerprints.yaml).
mlprints verify CONFIG.yaml --fingerprints DIR --model MODEL Verify a model using saved fingerprints.

Run mlprints <command> --help for command-specific options.

Generate fingerprints example

mlprints generate src/mlprints/configs/fingerprint/perinucleus_config.yaml

Generate and train in one step (algorithms that support training):

mlprints generate src/mlprints/configs/fingerprint/perinucleus_config.yaml --train

Under your experiments root, each run writes:

  • fingerprints/{algo}/{timestamp}/fingerprints.yaml
  • fingerprints/{algo}/{timestamp}/config.yaml
  • fingerprints/{algo}/{timestamp}/metadata.yaml

Train fingerprints example

mlprints train src/mlprints/configs/fingerprint/perinucleus_config.yaml \
  --fingerprints-dir /path/to/fingerprints/{algo}/{timestamp}

Checkpoints and training metadata are written under that fingerprint directory (e.g. trained/.../checkpoints/).

Verify fingerprints example

mlprints verify src/mlprints/configs/verify/match_config.yaml \
  --fingerprints /path/to/fingerprints/{algo}/{timestamp} \
  --model /path/to/model \
  --apply-chat-template

Verification results are written under verification/{timestamp}/.

Grid configs

Wrap any parameter in {grid: [...]} to run every combination:

learning_rate:
  grid: [1.0e-5, 2.0e-5]

Generation expands grids under algo.params; training expands algo.training; verification expands verifier.params and inference. Ordinary YAML lists remain unchanged. Use --skip-existing to reuse matching runs.

How to add a new fingerprint

  1. Implement generation (and optional training) in src/mlprints/fingerprint/.
  2. Register in FINGERPRINT_ALGOS in src/mlprints/common/fingerprints.py.
  3. Add src/mlprints/configs/fingerprint/<name>_config.yaml with algo.name, algo.params, and optionally algo.training if training is required.
  4. Implement and register a verifier when the scheme needs one.

Contributing

Issues and pull requests are very welcome. For questions, contact edoardo@sentient.xyz.

Disclaimer: Most of the code pushed has been either handwritten, or written with AI on a first passage only then to be severly revised and edited for performance and clarity over countless hours. The end result is a repo that is meant to be very flexible, readable and usable by AI and humans alike. Therefore, any contributions that worsen the standard set will be asked to be revised. Any contributions that improve the standard are very welcome (and such is continuously improved). It is both a means as much as an ends (instead of only the first, in which case we would have spared ourselves plenty of development time).

License

Released under the GNU Affero General Public License v3.0 or later. Full text in LICENSE.

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

mlprints-0.1.0a2.tar.gz (65.7 kB view details)

Uploaded Source

Built Distribution

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

mlprints-0.1.0a2-py3-none-any.whl (77.8 kB view details)

Uploaded Python 3

File details

Details for the file mlprints-0.1.0a2.tar.gz.

File metadata

  • Download URL: mlprints-0.1.0a2.tar.gz
  • Upload date:
  • Size: 65.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for mlprints-0.1.0a2.tar.gz
Algorithm Hash digest
SHA256 24495d6f934b67dce64a3986b99ebb4181e70414f2d56395d65356f91b980502
MD5 0775d23caf1fbb3c42920b61e7ab1595
BLAKE2b-256 d79c91d704a31b7fc8601ac114a8d6ca61676dd075c67e8d5646a94d25891e26

See more details on using hashes here.

File details

Details for the file mlprints-0.1.0a2-py3-none-any.whl.

File metadata

  • Download URL: mlprints-0.1.0a2-py3-none-any.whl
  • Upload date:
  • Size: 77.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for mlprints-0.1.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 c7da5206ac9dbd7b81795e3a348db81ae820268be3a744051bd3dc83f9921775
MD5 d19530ccd9fc892a7c0f457616740685
BLAKE2b-256 c1212aa0a978b58950ae4474ebad74c533b52a8786c338c70f21bcc2a9d6b1c1

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