Skip to main content

Battle-tested building blocks for production Numba workloads.

Project description

numba-utils

Battle-tested building blocks for production Numba workloads. Built for production numerical software with Numba.

✓ Zero dependencies beyond NumPy + Numba  ·  ✓ Callable inside @njit  ·  ✓ Honest benchmarks  ·  ✓ Diagnostics  ·  ✓ CI  ·  ✓ MIT

                    Numba
                      ▲
                      │
                 numba-utils
      ┌───────────────┼───────────────┐
   Arrays        Collections       Parallel
   Algorithms    Random            Profiling
   Decorators    Testing           Diagnostics
from numba import njit
from numba_utils import topk

@njit
def winners(scores):
    return topk(scores, 10)     # O(n), no full sort — runs in nopython mode
from numba import njit
from numba_utils import PriorityQueue, SparseSet

@njit
def simulate(n_events):
    events = PriorityQueue(n_events)    # constructed in nopython mode
    active = SparseSet(100_000)         # O(1) add/discard/contains/clear
    ...
from numba_utils import compare

compare(numpy_impl, njit_impl, args=(values,))
# 31x on a fused kernel — JIT compilation excluded automatically

And the part that almost no library ships — diagnostics for compiled code:

>>> from numba_utils import diagnostics
>>> diagnostics.check(fn)
 cache=True may crash when loaded across processes (farms, network FS)
   NUMBA_UTILS_CACHE=0  or  configure(cache=False)
 fastmath=True relaxes IEEE 754  not for exact/reproducible results

Why this exists

After enough numerical projects — long-running Monte Carlo engines, solvers, simulation farms — you realize you've rewritten the same binary search, the same typed collections, the same sampling algorithms and the same benchmarking helpers again. And debugged the same Numba production surprises again.

numba-utils ships more than code. It ships the production knowledge that usually stays trapped inside numerical projects — as kernels with the pitfalls engineered around, as diagnostics, and as documentation. It does not compete with Numba: it builds on top of it.

Why not...

  • heapq / collections? They can't be called from nopython mode. The containers here are jitclasses usable inside @njit.
  • NumPy? Many helpers are built to run inside compiled kernels, where NumPy calls can't reach. Where NumPy is faster (bandwidth-bound sweeps, its SIMD sort), BENCHMARKS.md says so.
  • SciPy? A heavy dependency that isn't njit-callable; this stays at NumPy + Numba and works in the compiled path.
  • Numba itself? Numba is a compiler. numba-utils is a standard library on top of it.

Design principles

  1. Performance First — nothing ships without a benchmarked justification.
  2. No Hidden Magic — thin, readable layers over Numba; nothing rewrites your code.
  3. Numba Compatible — everything callable from your own @njit code, no hacks.
  4. Minimal APIstopk(arr, 10), not twenty keyword parameters.
  5. Benchmark Honesty — losses are published next to the wins.

The identity behind these: docs/philosophy.md.

Modules

Core — decorators, arrays, algorithms · Performance — parallel (complete operations, not prange wrappers), profiling (JIT excluded by default), diagnostics · Data structures — collections, random · Developer tools — testing, config

Full API: docs/modules.md · Runnable code: examples/

Benchmark honesty

Every algorithm states whether it is faster, similar but more ergonomic, or slower but solving a problem unavailable elsewhere. BENCHMARKS.md contains losing rows on purpose: they tell you when NOT to use a function. Backed in-repo by reproducible benchmarks/, 200+ reference-validated tests (why there's no coverage badge), and CI running all of it. Trade-off records: docs/design/.

Used in

Patterns extracted from real workloads: Monte Carlo equity engines, game-theory solvers (CFR), quantitative research, scientific simulations, optimization loops.

Status

Phase 1 (see ROADMAP.md):

  • decorators, profiling, diagnostics, config
  • arrays, algorithms, random, collections
  • parallel patterns, testing helpers
  • dtype-generic collections, stable_argsort, lexsort
  • PyPI release

Development

python -m venv .venv
.venv/Scripts/pip install -e .[dev]
.venv/Scripts/python -m pytest

Contributions follow GUIDELINES.md — benchmarks are mandatory, honesty is policy.

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

numba_utils-0.1.0.tar.gz (43.7 kB view details)

Uploaded Source

Built Distribution

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

numba_utils-0.1.0-py3-none-any.whl (43.8 kB view details)

Uploaded Python 3

File details

Details for the file numba_utils-0.1.0.tar.gz.

File metadata

  • Download URL: numba_utils-0.1.0.tar.gz
  • Upload date:
  • Size: 43.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for numba_utils-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1d7465a374b229083a2257c01fce2edd583834aedc77fabdd8a29be416b5f77e
MD5 020471295b6057c2519230724b227f99
BLAKE2b-256 555eb8f0239821d34127b155d6d2a96db9ded7a48162583302987f97c8d52b07

See more details on using hashes here.

File details

Details for the file numba_utils-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: numba_utils-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 43.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for numba_utils-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1521abc8d04cb2a390ca39995fcc58d8a76d02cb3d51e52d1fa0cb7a1f53492f
MD5 e23a15201f28660a693673cad2fe01bb
BLAKE2b-256 b171bf39e10c845e5f932018ce6b25ac078eaace7fcf211cd671da5e4027a54d

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