π Welcome to sbijax
!#
Simulation-based inference in JAX
sbijax
implements several algorithms for simulation-based inference in
JAX using Haiku,
Distrax and BlackJAX. Specifically, sbijax
implements
Sequential Monte Carlo ABC (
SMCABC
)Neural Posterior Estimation C (short
SNP
)Contrastive Neural Ratio Estimation (short
SNR
)
Caution
β οΈ As per the LICENSE file, there is no warranty whatsoever for this free software tool. If you discover bugs, please report them.
Installation#
To install from PyPI, call:
pip install sbijax
To install the latest GitHub <RELEASE>, just call the following on the command line:
pip install git+https://github.com/dirmeier/sbijax@<RELEASE>
See also the installation instructions for JAX, if
you plan to use sbijax
on GPU/TPU.
Contributing#
Contributions in the form of pull requests are more than welcome. A good way to start is to check out issues labelled βgood first issueβ.
In order to contribute:
Clone
sbijax
and installhatch
viapip install hatch
,create a new branch locally
git checkout -b feature/my-new-feature
orgit checkout -b issue/fixes-bug
,implement your contribution and ideally a test case,
test it by calling
hatch run test
on the (Unix) command line,submit a PR π
Acknowledgements#
Note
π The API of the package is heavily inspired by the excellent Pytorch-based sbi package which is substantially more feature-complete and user-friendly.
License#
sbijax
is licensed under the Apache 2.0 License.