Skip to main content

jaxfne

PyPI Docs License

jaxfne

Tensor-Field Neural Equations (TFNE) expressed as a JAX simulation engine for layer-resolved neural circuits, source operators, field proxies, probes, objectives, and evidence receipts.

Scientific grammar

[ \text{Emitter} \rightarrow \text{Source} \rightarrow \text{Field} \rightarrow \text{Probe} \rightarrow \text{Objective} \rightarrow \text{Optimizer} \rightarrow \text{Evidence} ]

Execution grammar

[ \text{CircuitSpec} \rightarrow \texttt{construct} \rightarrow \texttt{Model} \rightarrow \texttt{simulate} \rightarrow \texttt{Signals} ]

Adaptation (optional HDP family): finite-dimensional hidden biophysical state (H) and adaptive parameter coordinates (\Theta) (synaptic and intrinsic), mediated by

[ \dot X = F_X(X,H,\Theta,U),\quad \dot H = F_H(H,X,\Theta,U),\quad \dot\Theta = F_\Theta(H,X,\Theta). ]

(H)-state is the latent representation; HDP is the adaptive dynamical formulation that uses it. See H-state / HDP guide.

Install

pip install jaxfne
pip install "jaxfne[viz]"   # optional plotting

Development: pip install -e ".[dev,viz]" after cloning.

Minimal example

import jaxfne as jtfne

jtfne.enable_x64()
tensor  = jtfne.load_canonical_neuronal_tensor("canonical-v1-column-1000n")
model   = jtfne.construct(tensor, jtfne.RuntimeConfiguration(seed=0, duration_ms=1000.0, dt_ms=0.5))
signals = jtfne.simulate(model)

Import convention: import jaxfne as jtfne. Builder paths, paradigms, and optimization: Quickstart.

Relative and calibrated outputs

Simulated quantities are relative by default. Calibrated claims require an explicit transformation with evidence. See Scope & status.

Documentation

Resource Link
Quickstart docs/quickstart.md
Site jaxfne.readthedocs.io
Tutorials docs/tutorials/
Études docs/etudes/
Public API contract (0.4.13) docs/public_surface_contract.md
Changelog docs/changelog.md

Citation

CITATION.cff · citation guide

Release files for jaxfne 0.4.15

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

Source distribution (sdist)

Source distribution for jaxfne 0.4.15
File Size Uploaded
jaxfne-0.4.15.tar.gz 30.2 MB Details

Built distribution (wheel)

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

Total release size: 30.7 MB

Release files / jaxfne-0.4.15.tar.gz

Download URL jaxfne-0.4.15.tar.gz
Size 30.2 MB
Tags Source
SHA-256 checksum
How to use checksums
3c4f6412080ab14bf13ebe54a4883baf2ca2fce9ad5245fe8675339acf7b574c
BLAKE2b-256 checksum
How to use checksums
b3e87b22bb47f03289a0e420cac58da8828d885d68d1db0bc3c5892362a7a27d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release files / jaxfne-0.4.15-py3-none-any.whl

Download URL jaxfne-0.4.15-py3-none-any.whl
Size 490.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2a232968acfa8e3de30dbb5da2261caa1044afba453d31d1c7e7af69237ea679
BLAKE2b-256 checksum
How to use checksums
74d554a4ea3283b18bfc4af504201d7ab34be5857093f834739e02de57f3dde0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release history Release notifications | RSS feed

0.4.25

2 release files

0.4.24

2 release files

0.4.23

2 release files

0.4.22

2 release files

0.4.18

2 release files

0.4.17

2 release files

0.4.16

2 release files

This release

0.4.15 This release

2 release files

0.4.14

2 release files

0.4.8

2 release files

0.4.7

2 release files

0.4.5

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.42

2 release files

0.3.41

2 release files

0.3.40

2 release files

0.3.39

2 release files

0.3.37

2 release files

0.3.31

2 release files

0.3.22

2 release files

0.3.21

2 release files

0.3.14

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.2.30

2 release files

0.2.28

2 release files

0.2.18

2 release files

0.2.10

2 release files

0.2.3

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.2

2 release files

0.1.1

2 release files

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