Skip to main content

A lightweight neural-network library built on JAX

Project description

JAXFlow Logo

JAXFlow

PyPI version License Build Status Coverage Status

A lightweight neural-network library built on JAX
– fast imports, pure-functional APIs, and batteries-included for research and production.


🚀 Features

  • Module API
    Define layers with familiar setup/__call__ style or pure-function transforms.
  • PyTree compatibility
    Everything is a JAX PyTree; seamless jit, vmap, pmap, and pjit.
  • Rich layer collection
    Dense, Conv, BatchNorm, Dropout, and more in jaxflow.layers.
  • Optimizers & Schedulers
    Thin wrappers around Optax in jaxflow.optimizers.
  • Activations & Initializers
    relu, gelu, swish, he_normal, glorot_uniform, …
  • Losses & Metrics
    Standard losses (mse, cross_entropy) and metrics (accuracy, precision, …).
  • Callbacks & Checkpointing
    Training hooks and Orbax-powered jaxflow.checkpt utilities.
  • Pre-built Models
    ResNet, Transformer, MLP, and easy to extend in jaxflow.models.
  • Modular & Lazy
    Top-level import is lightning-fast; submodules load on demand.

📦 Installation

bash pip install jaxflow

Note:

Requires JAX (CPU/GPU/TPU), e.g.

pip install "jax[cuda]>=0.4.0" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html

Python ≥3.8


🎉 Quickstart


📖 Documentation

API Reference: https://mthd98.github.io/JAXFlow/

Cookbook: Layer recipes, advanced transforms, multi-host training


🛠️ Structure

jaxflow/ ├── core/ # Variable, RNG contexts ├── gradient/ # Gradient utilities ├── activations/ # relu, gelu, swish, … ├── initializers/ # weight initializers ├── layers/ # Dense, Conv, BatchNorm, … ├── losses/ # mse, cross_entropy, … ├── optimizers/ # Optax wrappers, schedulers ├── callbacks/ # EarlyStopping, Logging, … ├── metrics/ # accuracy, precision, … ├── models/ # ResNet, Transformer, … └── regularizers/ # Dropout, weight decay, …


🤝 Contributing

We welcome contributions! Please see our CONTRIBUTING.md for:

  1. Setting up a dev environment

  2. Code style & linting

  3. Testing & CI guidelines

  4. How to file issues & propose features


📄 License

This project is licensed under the Apache-2.0 License. See the LICENSE file for details.


“Simplicity is the ultimate sophistication.” – Leonardo da Vinci With JAXFlow, keep your research code clean, fast, and reproducible.

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

jaxflow-0.1.0.dev0.tar.gz (44.4 kB view details)

Uploaded Source

Built Distribution

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

jaxflow-0.1.0.dev0-py3-none-any.whl (60.3 kB view details)

Uploaded Python 3

File details

Details for the file jaxflow-0.1.0.dev0.tar.gz.

File metadata

  • Download URL: jaxflow-0.1.0.dev0.tar.gz
  • Upload date:
  • Size: 44.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for jaxflow-0.1.0.dev0.tar.gz
Algorithm Hash digest
SHA256 1fc3e7ac36ffd19500b24b88488f23cd7c24a0ad1cf0cbd681616b9897f2bb74
MD5 e2e14fdd579c5e4d34675836da13c63a
BLAKE2b-256 e74c92a18bd0b8cd638bb5081da380f48e2352959acd34e860bd1ba02a870d19

See more details on using hashes here.

Provenance

The following attestation bundles were made for jaxflow-0.1.0.dev0.tar.gz:

Publisher: python-publish.yml on mthd98/JAXFlow

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

File details

Details for the file jaxflow-0.1.0.dev0-py3-none-any.whl.

File metadata

  • Download URL: jaxflow-0.1.0.dev0-py3-none-any.whl
  • Upload date:
  • Size: 60.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for jaxflow-0.1.0.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 0b86e367f9c185a170211f54d7d7a89eeff2a051f9ac11fd8c42b0e444aca485
MD5 beb7c2511efb87f7dcdd08395bf0bcbf
BLAKE2b-256 4f6ff401f91c0da3d68b4f5a6a6e2e02de83cd710220c554991e6daea4800495

See more details on using hashes here.

Provenance

The following attestation bundles were made for jaxflow-0.1.0.dev0-py3-none-any.whl:

Publisher: python-publish.yml on mthd98/JAXFlow

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