Skip to main content

yax

yax — des réseaux de neurones au plus près de jax

PyPI Python Documentation

yax sert à écrire des réseaux de neurones avec jax, sans concepts ajoutés (bio). Un modèle est une classe Python dont les tableaux sont les paramètres : jax.grad, jax.jit, jax.vmap et la fameuse lib d'optimisation optax s'appliquent sur les modèles directement. Si on le souhaite, une fonction yax.training.train fait la boucle d'entraînement et sauvegarde le meilleur modèle.

pip install yaxlib

En trente secondes

Une sinusoïde bruitée, un perceptron multicouche, un entraînement :

import jax.numpy as jnp
import jax.random as jr
import yax

X = jr.uniform(jr.key(0), (256, 1), minval=-3.0, maxval=3.0)
Y = jnp.sin(X) + 0.1 * jr.normal(jr.key(1), X.shape)

model = yax.layers.MLP(layer_sizes=(1, 32, 32, 1), activation="tanh", rkey=jr.key(2))
config = yax.configs.TrainConfig(learning_rate=1e-2, nb_epochs=100)

run = yax.training.train("out/sinus", config,
                         yax.obj.mse,                # l'objectif à minimiser
                         model,
                         (X[:200], Y[:200], 32),     # entraînement, par batchs de 32
                         (X[200:], Y[200:]),         # validation
                         rkey=jr.key(3))

print(run.loss)                                      # perte de validation du meilleur modèle
Y_pred = yax.batch_apply(run.trained_model, X)

Le dossier out/sinus/0 contient l'historique de l'entrainement ainsi que le modèle entrainé, sauvegardé à sa meilleure validation. Dans une autre session, yax.training.load_run("out/sinus/0") permet de retrouver tout cela. Un second entrainement (en variant la config par exemple) s'enregistrera dans "out/sinus/1" etc.

Ce que yax vous donne

  • Un modèle est un pytree. Déclarez une classe qui hérite de yax.Module: ses champs sont les paramètres entrainables ou statiques. Rien à envelopper, rien à filtrer : jax.grad(loss)(model) rend un modèle de même forme dont les feuilles sont les gradients.
  • Une seule signature, partout. apply(x,rkey) traite un exemple x. Ensuite jax.vmap permet de traiter un batch; rkey est la source d'aléatoire quand il y en a (dropout, tirages). Le mode d'évaluation se bascule avec la méthode: model.set_inference(True).
  • Un entraînement qui laisse des traces. Chaque appel à yax.training.train crée un dossier numéroté avec le meilleur modèle, l'état de l'optimiseur, la configuration et l'historique. Les runs d'un même dossier se comparent, et yax.training.find_best_run désigne le meilleur au sein du mother_folder.
  • Des briques prêtes à l'emploi, toutes écrites comme vous les écririez : couches (MLP, convolutions n-dimensionnelles, GRU et LSTM, attention multi-têtes, blocs transformer, message passing), modèles complets (U-Net, opérateur de Fourier, VAE, flot normalisant, diffusion, mini-YOLO), fonctions de pertes, optimiseurs, prétraitements de données.
  • Des mini-fonctionnalités sympathiques. Essayez par exemple yax.ipprint(model) dans un notebook.

Pourquoi pas flax ou equinox ?

Par simplicité. Chaque framework se mesure aux concepts qu'il ajoute à jax : flax apporte ses collections de variables, ses scopes et son cycle init/apply ; equinox réduit cela à des modules-pytrees, mais y ajoute sa machinerie de filtrage. yax ajoute le strict minimum pour construire des modèles à base de layers imbriqués. Tout ce qui n'est pas dans yax se code en jax ordinaire, sans friction.

Pour continuer

  • Prise en main : un quart d'heure, des données, un modèle, un entraînement, un rechargement.
  • Aller plus loin : sous le capot du modèle, l'aléa et le mode inférence, les samplers, la configuration de l'entraînement, les pertes à soi.
  • Référence de l'API et démos : une démonstration par famille de modèles, qui converge en quelques secondes sur CPU.

Développement

pip install yaxlib[dev]     # ajoute pytest
pytest tests/

Metadata

Release files for yaxlib 0.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for yaxlib 0.3.3
File Size Uploaded Provenance
yaxlib-0.3.3.tar.gz 217.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for yaxlib 0.3.3
File Interpreter ABI Platform
yaxlib-0.3.3-py3-none-any.whl Python 3 none any Details

Total release size: 286.8 kB

Release files / yaxlib-0.3.3.tar.gz

Download URL yaxlib-0.3.3.tar.gz
Size 217.6 kB
Tags Source
SHA-256 checksum
How to use checksums
d4833bbb49b26bd372b6130201e05eb93ab74bb32a367f2c22a6f896e701332e
BLAKE2b-256 checksum
How to use checksums
78cdae8eaa3f7f54b516f26f9d0a7a25b1ff3a21242156b00781a797e72cc425
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / yaxlib-0.3.3-py3-none-any.whl

Download URL yaxlib-0.3.3-py3-none-any.whl
Size 69.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
02f4e654b1b415b43283808893e04b0070ac9ee0dcbfaf00fab108b4079b5851
BLAKE2b-256 checksum
How to use checksums
86f1a14591dbf6acc5fdf394d62a110e46c6ecb18a9d426f2189c158ded211e4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for yaxlib 0.3.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page