jinns

status coverage

Physics Informed Neural Networks with JAX. jinns is a Python package for physics-informed neural networks (PINNs) in the JAX ecosystem. It provides an intuitive and flexible interface for

  • forward problem: learning a PDE solution.
  • inverse problem: learning the parameters of a PDE. See jinns.solve_alternate() for fine-grained and efficient inverse problems.
  • meta-modeling: learning a family of PDE indexed by its parameters.
  • New in jinns v1.9.2: Second order optimizers which greatly enhances the training of PINNs. We recommend testing them as default optimizers.

jinns specific points:

  • jinns uses JAX - It is directed to JAX users: forward and backward autodiff, vmapping, jitting and more! No reinventing the wheel: it relies on the JAX ecosystem whenever possible, such as equinox for neural networks or optax for optimization.

  • jinns is highly modular - It gives users maximum control for defining their problems, and extending the package. The maths and computations are visible and not hidden behind layers of code!

  • jinns is efficient - It compares favorably to other existing Python package for PINNs on the PINNacle benchmarks, as demonstrated in the table below. For more details on the benchmarks, checkout the PINN multi-library benchmark

  • Implemented PINN architectures

    • Vanilla Multi-Layer Perceptron popular accross the PINNs litterature.

    • Separable PINNs: allows to leverage forward-mode autodiff for computational speed.

    • Hyper PINNs: useful for meta-modeling

  • Other

    • Adaptative Loss Weights are now implemented. Some SoftAdapt, LRAnnealing and ReLoBRaLo are available and users can implement their own strategy. See the tutorial

  • Get started: check out our various notebooks on the documentation.

jinns DeepXDE - JAX DeepXDE - Pytorch PINA Nvidia Modulus
Burgers1D 445 723 671 1977 646
NS2d-C 265 278 441 1600 275
PInv 149 218 CC 1509 135
Diffusion-Reaction-Inv 284 NI 3424 4061 2541
Navier-Stokes-Inv 175 NI 1511 1403 498

Training time in seconds on an Nvidia T600 GPU. NI means problem cannot be implemented in the backend, CC means the code crashed.

A diagram of jinns workflow

Installation

Install the latest version with pip

pip install jinns

Documentation

The project's documentation is hosted on Gitlab page and available at https://mia_jinns.gitlab.io/jinns/index.html.

Found a bug / want a feature ?

Open an issue on the Gitlab repo.

Contributing

Here are the contributors guidelines:

  1. First fork the library on Gitlab.

  2. Then clone and install the library in development mode with

pip install -e .
  1. Install pre-commit and run it. Our pre-commit hooks consist in ruff format and ruff check. You can install ruff simply by pip install ruff. We highly recommend you to check the code type hints with pyright even though we currently have no rule concerning type checking in the pipeline.
pip install pre-commit
pre-commit install
  1. Open a merge request once you are done with your changes, the review will be done via Gitlab.

Contributors

Don't hesitate to contribute and get your name on the list here !

List of contributors: Hugo Gangloff, Nicolas Jouvin, Lucia Clarotto, Inass Soukarieh, Mohamed Badi

Cite us

Please consider citing our work if you found it useful to yours, using this ArXiV preprint

@article{gangloff_jouvin2024jinns,
  title={jinns: a JAX Library for Physics-Informed Neural Networks},
  author={Gangloff, Hugo and Jouvin, Nicolas},
  journal={arXiv preprint arXiv:2412.14132},
  year={2024}
}

Acknowledgement

The library benefited from discussions with other researchers and devs. Special thanks to the Scimba library team, go check out their work if you are interested in sciML and hybrid numerical methods !

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for hugo.gangloff from gravatar.com hugo.gangloff Avatar for njouvin from gravatar.com njouvin

Credits

Author/Maintainer: Hugo Gangloff

License

Apache Software License (Apache License 2.0)

Requires

Python >=3.11

Provides Extra

notebook gpu-cuda13 gpu-cuda12 cpu dev docs

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jinns-1.10.0.tar.gz (21.1 MB view details)

Uploaded Source

Built Distribution

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

jinns-1.10.0-py3-none-any.whl (158.9 kB view details)

Uploaded Python 3

File details

Details for the file jinns-1.10.0.tar.gz.

File metadata

  • Download URL: jinns-1.10.0.tar.gz
  • Upload date:
  • Size: 21.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for jinns-1.10.0.tar.gz
Algorithm Hash digest
SHA256 04e68f507577a200f13d4d821c6ffb48d6cb2aba1e80edbb9ac42b655a59865f
MD5 089b0731e93510464ef76177ff943291
BLAKE2b-256 18d8fc4b8912d03829073fe21572b5fe3b6f586abb18f9755ceeb2b754666141

See more details on using hashes here.

File details

Details for the file jinns-1.10.0-py3-none-any.whl.

File metadata

  • Download URL: jinns-1.10.0-py3-none-any.whl
  • Upload date:
  • Size: 158.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for jinns-1.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e1085b7cd0261c7d1b7c82861dfcff729fc3b1d5e931041347851db75b35d562
MD5 f6796fa2642d397aa0b62cf2fd2a8224
BLAKE2b-256 48195ee0194a81e71c0e366528413521cc7d718b981d06c2d645226ca72a8f91

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.10.0 This release

2 files

1.9.4

2 files

1.9.3

2 files

1.9.2

2 files

1.9.1

2 files

1.9.0

2 files

1.8.1

2 files

1.8.0

2 files

1.7.1

2 files

1.7.0

2 files

1.6.1

2 files

1.6.0

2 files

1.5.1

2 files

1.5.0

2 files

1.4.0

2 files

1.3.0

2 files

1.2.0

2 files

1.1.0

2 files

1.0.0

2 files

0.9.0

2 files

0.8.10

2 files

0.8.9

2 files

0.8.8

2 files

0.8.7

2 files

0.8.6

2 files

0.8.5

2 files

0.8.4

2 files

0.8.3

2 files

0.8.2

2 files

0.8.1

2 files

0.8.0

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.1

2 files

0.6.0

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 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