Skip to main content

An sklearn-style FID metric class for Jax

Project description

FIDax

A JAX implementation of the Fréchet Inception Distance (FID) metric for evaluating generative models in form of a sklearn-compatible metric.

Features

  • Pure JAX Implementation: Leverages JAX's JIT compilation for fast computation
  • Pre-computed Statistics: Supports using pre-computed real image statistics for faster evaluation
  • GPU Accelerated: Optimized for CUDA-enabled GPUs
  • Torchmetrics Compatible: Results match torchmetrics implementation up to 1e-1 absolute tolerance with FP32 execution of the InceptionV3 model and FP64 for the metric computation on CIFAR10 tests

Installation

# Clone the repository
git clone git@github.com:wittenator/fidax.git
cd fidax

# Install dependencies using uv
uv sync --frozen

or install it directly as a dependency with e.g. uv:

uv add fidax

Quick Start

import jax 
jax.config.update("jax_enable_x64", True)
import jax.numpy as jnp
from fidax.fid import FrechetInceptionDistance

# Initialize FID metric
fid = FrechetInceptionDistance()

# Update with real images (shape: [N, 299, 299, 3], range: [-1, 1])
real_images = jnp.random.uniform(-1, 1, (100, 299, 299, 3))
fid.update(real_images, real=True)

# Update with generated/fake images
fake_images = jnp.random.uniform(-1, 1, (100, 299, 299, 3))
fid.update(fake_images, real=False)

# Compute FID score
fid_score = fid.compute()
print(f"FID Score: {fid_score}")

Advanced Usage

Pre-computed Statistics

# Use pre-computed real statistics for faster evaluation
real_stats = {
    "mu": mu_real,      # Mean of real activations
    "sigma": sigma_real # Covariance of real activations
}

fid = FrechetInceptionDistance(real_stats=real_stats)
# Only need to update with fake images
fid.update(fake_images, real=False)

Requirements

  • Python ≥ 3.12
  • JAX with CUDA support
  • Flax
  • NumPy

See pyproject.toml for complete dependency list.

Development

This project uses a development container with GPU support. To set up the development environment:

# The dev container will automatically install dependencies
# Run tests
uv run pytest src/fidax/test_fid_metric.py

Testing

The implementation includes tests against torchmetrics:

uv run pytest src/fidax/test_fid_metric.py -v

Tests verify:

  • Equivalence with torchmetrics implementation
  • Pre-computed statistics functionality
  • Real-world performance on CIFAR-10 dataset

License

Apache 2.0 License - see LICENSE for details.

Related Projects

  • jax-fid-parallel - Parallel implementation of FID computation in JAX
  • jax-fid - Original JAX implementation of FID that inspired this project

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

fidax-0.3.tar.gz (118.9 kB view details)

Uploaded Source

Built Distribution

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

fidax-0.3-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

Details for the file fidax-0.3.tar.gz.

File metadata

  • Download URL: fidax-0.3.tar.gz
  • Upload date:
  • Size: 118.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","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 fidax-0.3.tar.gz
Algorithm Hash digest
SHA256 40c00dd4cc3beb58219636ee86950cf4fe954e30fa190ea8ad7a4b5633f76438
MD5 9b3dd7f977272a9c81318b3f846fe35a
BLAKE2b-256 db332f989ffce57cf87f3b818936655fcf7e2930dffe1bdfba1ba2dc13f2059e

See more details on using hashes here.

File details

Details for the file fidax-0.3-py3-none-any.whl.

File metadata

  • Download URL: fidax-0.3-py3-none-any.whl
  • Upload date:
  • Size: 19.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","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 fidax-0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1a08597ff2dad9a02f020676ebf6143fac22a4e33465ec51d575202535dfae05
MD5 791c43d9ffc060b79ddc5dfc9ece56ec
BLAKE2b-256 08486976f035be36bf6648e7b97f29d49e80071e018fbdea189e75cfd8f3118f

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