Skip to main content

A versatile kit for training and using linear probes on neural network activations.

Project description

Probes

A lightweight, modular library for training linear probes and steering vectors on neural network activations.

Core Design (V2)

This library separates Semantics (the probe model) from Fitting (how it's learned).

1. The Models: LinearProbe and ProbeCollection

  • LinearProbe (probekit.core.probe): A container for a single probe (+ normalization stats).
  • ProbeCollection (probekit.core.collection): A container for a batch of probes.
    • to_tensor(): Stacks weights into [B, D] and biases into [B].
    • best_layer(metric): Finds the probe with the best validation accuracy.

2. The Fitters

Functional solvers in probekit.fitters take training data and return a LinearProbe (or ProbeCollection).

  • fit_logistic: Standard L2-regularized Logistic Regression.
  • fit_elastic_net: ElasticNet (L1 + L2), useful for sparse features (SAEs, Neurons).
  • fit_dim: Difference-in-Means (Class 1 Mean - Class 0 Mean).

Batched GPU Fitters

Optimized PyTorch implementations in probekit.fitters.batch handle 3D inputs [B, N, D] efficiently on GPU:

  • fit_logistic_batch: Batched IRLS/Newton solver with auto-switch between dense Newton and memory-safe Newton-CG.
  • fit_dim_batch: Vectorized DiM with median thresholding.
  • fit_elastic_net_path: Efficiently fits a regularization path (multiple alphas) using warm-starting.

Quick Start

The high-level API supports explicit backend control (backend="torch" / backend="sklearn"), and in backend="auto" mode it prefers torch when inputs are already torch tensors.

from probekit import sae_probe, dim_probe

# 1. Single Probe (X: [N, D], y: [N])
probe = sae_probe(X_2d, y_1d)

# 2. Batched Probes (X: [B, N, D], y: [B, N] or [N])
# Uses torch batch fitters and returns a ProbeCollection
probes = sae_probe(X_3d, y)
weights, biases = probes.to_tensor() # [B, D], [B]

# 3. Force backend explicitly
probe_torch = sae_probe(X_2d_torch, y_1d_torch, backend="torch")
probe_cpu = sae_probe(X_3d_numpy, y_2d_numpy, backend="sklearn")

Steering Vectors

You can build steering vectors for individual probes or entire collections:

from probekit import build_steering_vector, build_steering_vectors

# Single
vec = build_steering_vector(probe, sae_model, layer=10)

# Batched (Maps layers to probes)
vecs = build_steering_vectors(probe_collection, sae_model, layers=[8, 9, 10])

Structure

  • probekit/core/: LinearProbe and ProbeCollection definitions.
  • probekit/fitters/:
    • logistic.py, elastic.py, dim.py: Single-probe (CPU/sklearn) fitters.
    • batch/: Optimized GPU-batched fitters (IRLS, ISTA, DiM).
  • probekit/api.py: High-level aliases and dimension routing.
  • probekit/steering/: Tools for building steering vectors.

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

probekit-0.3.0.tar.gz (29.7 kB view details)

Uploaded Source

Built Distribution

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

probekit-0.3.0-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

Details for the file probekit-0.3.0.tar.gz.

File metadata

  • Download URL: probekit-0.3.0.tar.gz
  • Upload date:
  • Size: 29.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for probekit-0.3.0.tar.gz
Algorithm Hash digest
SHA256 9b272340ef695c5471b6f7e21c234e0f999e5f860e727786458776547ddf2680
MD5 653b2882011c041b8dedd6f2f95f27aa
BLAKE2b-256 74e74b8189d8081675e30ed359c7923eefde7d1623ce39b2199d99c8b7601824

See more details on using hashes here.

Provenance

The following attestation bundles were made for probekit-0.3.0.tar.gz:

Publisher: publish.yml on ZuiderveldTimJ/probekit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file probekit-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: probekit-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 35.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for probekit-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 03e35186d48cff0f91bbdc7bc010735d2e3d7560afe6dc17cedab5de6b10b627
MD5 36a14fe72e86901f52a1a1406bd40412
BLAKE2b-256 8d8994d3abee5610df91676157c68508f6bc980f6dde02f8fac611745ef32b90

See more details on using hashes here.

Provenance

The following attestation bundles were made for probekit-0.3.0-py3-none-any.whl:

Publisher: publish.yml on ZuiderveldTimJ/probekit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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