Skip to main content

No project description provided

Project description

numerax

tests docs

Statistical and numerical computation functions for JAX, focusing on tools not available in the main JAX API.

📖 Documentation

Installation

pip install numerax

Features

Special Functions

Inverse functions for statistical distributions with differentiability support:

import jax.numpy as jnp
import numerax

# Inverse functions for statistical distributions
x = numerax.special.gammap_inverse(p, a)  # Gamma quantiles
y = numerax.special.erfcinv(x)  # Inverse complementary error function

# Chi-squared distribution (includes JAX functions + custom ppf)
x = numerax.stats.chi2.ppf(q, df, loc=0, scale=1)

Key features:

  • Halley's method for fast convergence
  • Custom JVP implementation for exact gradients
  • Numerical stability with adaptive precision
  • Full JAX transformation compatibility

Profile Likelihood

Efficient profile likelihood computation for statistical inference with nuisance parameters:

import jax.numpy as jnp
import numerax

# Example: Normal distribution with mean inference, variance profiling
def normal_llh(params, data):
    mu, log_sigma = params
    sigma = jnp.exp(log_sigma)
    return jnp.sum(-0.5 * jnp.log(2 * jnp.pi) - log_sigma 
                   - 0.5 * ((data - mu) / sigma) ** 2)

# Profile over log_sigma, infer mu
is_nuisance = [False, True]  # mu=inference, log_sigma=nuisance

def get_initial_log_sigma(data):
    return jnp.array([jnp.log(jnp.std(data))])

profile_llh = numerax.stats.make_profile_llh(
    normal_llh, is_nuisance, get_initial_log_sigma
)

# Evaluate profile likelihood
data = jnp.array([1.2, 0.8, 1.5, 0.9, 1.1])
llh_val, opt_nuisance, diff, n_iter = profile_llh(jnp.array([1.0]), data)

Key features:

  • JIT-compiled for performance
  • L-BFGS optimization with convergence diagnostics
  • Configurable tolerance and initial values
  • Handles parameter masking automatically

Utilities

Development utilities for creating JAX functions with custom derivatives while ensuring proper documentation support. Includes decorators for preserving function metadata when using JAX's advanced features.

Requirements

  • Python ≥ 3.12
  • JAX
  • jaxtyping
  • optax

Acknowledgements

This work is supported by the Department of Energy AI4HEP program.

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

numerax-1.0.0.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

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

numerax-1.0.0-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file numerax-1.0.0.tar.gz.

File metadata

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

File hashes

Hashes for numerax-1.0.0.tar.gz
Algorithm Hash digest
SHA256 68339c517cc24b9e0666ff52e1566e7aa07033788f2cb141ddc29c20aaebc125
MD5 c979ddbceeb4560349e0b400967aeeaa
BLAKE2b-256 3830e6a1bab9197ea1d7dc32e74856ee287942b230e1f32e5d22c32f82912f5f

See more details on using hashes here.

Provenance

The following attestation bundles were made for numerax-1.0.0.tar.gz:

Publisher: publish.yml on juehang/numerax

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

File details

Details for the file numerax-1.0.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for numerax-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7179ff657b5d63bb238c74996c3682293773c2290a2c25b148f7cffe45a5a6e0
MD5 af43314a3964149320ba6c30a9bc302b
BLAKE2b-256 9a56a4692d282fc14647eba8ae19eb41b947a13e18b68b15dc7805daed3e845a

See more details on using hashes here.

Provenance

The following attestation bundles were made for numerax-1.0.0-py3-none-any.whl:

Publisher: publish.yml on juehang/numerax

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