Skip to content

Commit 0846c20

Browse files
authored
Update README.rst
1 parent 4491c40 commit 0846c20

File tree

1 file changed

+26
-22
lines changed

1 file changed

+26
-22
lines changed

README.rst

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
*swyft v0.4.x*
2-
==============
3-
1+
Swyft v0.4
2+
==========
43

54
.. image:: https://badge.fury.io/py/swyft.svg
65
:target: https://badge.fury.io/py/swyft
@@ -47,11 +46,29 @@
4746

4847
*swyft* is the official implementation of Truncated Marginal Neural Ratio Estimation (TMNRE),
4948
a hyper-efficient, simulation-based inference technique for complex data and expensive simulators.
49+
As of v0.4.0, swyft is based on pytorch-lightning.
50+
51+
52+
Swyft in action
53+
---------------
54+
55+
56+
.. image:: docs/source/_static/img/SBI-curve.gif
57+
:width: 800
58+
:align: center
59+
60+
61+
* Swyft makes it convenient to perform Bayesian or Frequentist inference of hundreds, thousands or millions of parameter posteriors by constructing optimal data summaries.
62+
* To this end, Swyft estimates likelihood-to-evidence ratios for arbitrary marginal posteriors; they typically require fewer simulations than the corresponding joint.
63+
* Swyft performs targeted inference by prior truncation, combining simulation efficiency with empirical testability.
64+
* Swyft is based on stochastic simulators, which map parameters stochastically to observational data. Swyft makes it convenient to define such simulators as graphical models.
65+
* In scientific settings, a cost-benefit analysis often favors approximating the posterior marginality; *swyft* provides this functionality.
66+
The package additionally implements our prior truncation technique, routines to empirically test results by estimating the expected coverage,
67+
and a simulator manager with `zarr <https://zarr.readthedocs.io/en/stable/>`_ storage to simplify use with complex simulators.
68+
5069

51-
.. note::
52-
As of v0.4.0, swyft will be based on pytorch-lightning, and the entire API
53-
will be overhauled. Right now v0.4.0 is still in pre-release, and
54-
documentation is not yet fully updated.
70+
Further information
71+
-------------------
5572

5673
* **Documentation & installation**: https://swyft.readthedocs.io/
5774
* **Example usage**: https://swyft.readthedocs.io/en/latest/tutorial-notebooks.html
@@ -61,22 +78,9 @@ a hyper-efficient, simulation-based inference technique for complex data and exp
6178
* **Contributing**: https://swyft.readthedocs.io/en/latest/contributing-link.html
6279
* **Citation**: https://swyft.readthedocs.io/en/latest/citation.html
6380

64-
*swyft*:
65-
66-
* estimates likelihood-to-evidence ratios for arbitrary marginal posteriors; they typically require fewer simulations than the corresponding joint.
67-
* performs targeted inference by prior truncation, combining simulation efficiency with empirical testability.
68-
* seamless reuses simulations drawn from previous analyses, even with different priors. (not yet supported in swyft v0.4.x, see `v0.3.2 <https://github.com/undark-lab/swyft/releases/tag/v0.3.2>`_)
69-
* integrates `dask <https://dask.org/>`_ and `zarr <https://zarr.readthedocs.io/en/stable/>`_ to make complex simulation easy. (not yet supported in swyft v0.4.x, see `v0.3.2 <https://github.com/undark-lab/swyft/releases/tag/v0.3.2>`_)
70-
71-
*swyft* is designed to solve the Bayesian inverse problem when the user has access to a simulator that stochastically maps parameters to observational data.
72-
In scientific settings, a cost-benefit analysis often favors approximating the posterior marginality; *swyft* provides this functionality.
73-
The package additionally implements our prior truncation technique, routines to empirically test results by estimating the expected coverage,
74-
and a `dask <https://dask.org/>`_ simulator manager with `zarr <https://zarr.readthedocs.io/en/stable/>`_ storage to simplify use with complex simulators.
75-
76-
7781

78-
Related
79-
-------
82+
Swyft history
83+
-------------
8084

8185
* `v0.3.2 <https://github.com/undark-lab/swyft/releases/tag/v0.3.2>`_ is the version that was submitted to `JOSS <https://joss.theoj.org/papers/10.21105/joss.04205>`_.
8286
* `tmnre <https://github.com/bkmi/tmnre>`_ is the implementation of the paper `Truncated Marginal Neural Ratio Estimation <https://arxiv.org/abs/2107.01214>`_.

0 commit comments

Comments
 (0)