Skip to content

Commit

Permalink
fixes to readme; add contributors to credits.
Browse files Browse the repository at this point in the history
  • Loading branch information
janfb committed Apr 29, 2024
1 parent 7d02d26 commit 9a8c7c0
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 14 deletions.
34 changes: 21 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,15 @@

[Getting Started](https://sbi-dev.github.io/sbi/tutorial/00_getting_started/) | [Documentation](https://sbi-dev.github.io/sbi/)

`sbi` is a PyTorch package for simulation-based inference. Simulation-based inference is the process of finding parameters of a simulator from observations.
`sbi` is a PyTorch package for simulation-based inference. Simulation-based inference is
the process of finding parameters of a simulator from observations.

`sbi` takes a Bayesian approach and returns a full posterior distribution over the parameters of the simulator, conditional on the observations.
The package implements a variety of inference algorithms, including _amortized_ and _sequential_ methods.
Amortized methods return a posterior that can be applied to many different observations without retraining; sequential methods focus the inference on one particular observation to be more simulation-efficient.
See below for an overview of implemented methods.
`sbi` takes a Bayesian approach and returns a full posterior distribution over the
parameters of the simulator, conditional on the observations. The package implements a
variety of inference algorithms, including _amortized_ and _sequential_ methods.
Amortized methods return a posterior that can be applied to many different observations
without retraining; sequential methods focus the inference on one particular observation
to be more simulation-efficient. See below for an overview of implemented methods.

`sbi` offers a simple interface for posterior inference in a few lines of code

Expand Down Expand Up @@ -53,7 +56,7 @@ print(posterior)

## Tutorials

For first time users, you can now head over to the turorials and get going with [Getting Started](https://sbi-dev.github.io/sbi/tutorial/00_getting_started/).
For first-time users: You can now head over to the tutorials and get going with [Getting Started](https://sbi-dev.github.io/sbi/tutorial/00_getting_started/).

## Inference Algorithms

Expand Down Expand Up @@ -94,19 +97,24 @@ The following inference algorithms are currently available. You can find instruc

## Feedback and Contributions

We welcome any feedback on how `sbi` is working for your inference problems (see [Discussions](https://github.com/sbi-dev/sbi/discussions)) and are happy to receive bug reports, pull requests and other feedback (see
[contribute](http://sbi-dev.github.io/sbi/contribute/)).
We wish to maintain a positive community, please read our [Code of Conduct](CODE_OF_CONDUCT.md).
We welcome any feedback on how `sbi` is working for your inference problems (see
[Discussions](https://github.com/sbi-dev/sbi/discussions)) and are happy to receive bug
reports, pull requests, and other feedback (see
[contribute](http://sbi-dev.github.io/sbi/contribute/)). We wish to maintain a positive
community; please read our [Code of Conduct](CODE_OF_CONDUCT.md).

## Acknowledgements
## Acknowledgments

`sbi` is the successor (using PyTorch) of the
[`delfi`](https://github.com/mackelab/delfi) package. It was started as a fork of Conor
M. Durkan's `lfi`. `sbi` runs as a community project. See also [credits](https://github.com/sbi-dev/sbi/blob/master/docs/docs/credits.md).
[`delfi`](https://github.com/mackelab/delfi) package. It started as a fork of Conor M.
Durkan's `lfi`. `sbi` runs as a community project. See also
[credits](https://github.com/sbi-dev/sbi/blob/master/docs/docs/credits.md).

## Support

`sbi` has been supported by the German Federal Ministry of Education and Research (BMBF) through project ADIMEM (FKZ 01IS18052 A-D), project SiMaLeSAM (FKZ 01IS21055A) and the Tübingen AI Center (FKZ 01IS18039A).
`sbi` has been supported by the German Federal Ministry of Education and Research (BMBF)
through project ADIMEM (FKZ 01IS18052 A-D), project SiMaLeSAM (FKZ 01IS21055A) and the
Tübingen AI Center (FKZ 01IS18039A).

## License

Expand Down
15 changes: 14 additions & 1 deletion docs/docs/credits.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Credits

## Community and Contributions

`sbi` is a community-driven package. We are grateful to all our contributors who have
played a significant role in shaping `sbi`. Their valuable input, suggestions, and
direct contributions to the codebase have been instrumental in the development of `sbi`.

## License

`sbi` is licensed under the [Apache License (Apache-2.0)](https://www.apache.org/licenses/LICENSE-2.0) and
Expand All @@ -9,9 +15,16 @@
> Copyright (C) 2020 Conor M. Durkan.
> All contributors hold the copyright of their specific contributions.
## Support

`sbi` has been supported by the German Federal Ministry of Education and Research (BMBF) through the project ADIMEM, FKZ 01IS18052 A-D). [ADIMEM](https://fit.uni-tuebingen.de/Project/Details?id=9199) is a collaborative project between the groups of Jakob Macke (Uni Tübingen), Philipp Berens (Uni Tübingen), Philipp Hennig (Uni Tübingen) and Marcel Oberlaender (caesar Bonn) which aims to develop inference methods for mechanistic models.
`sbi` has been supported by the German Federal Ministry of Education and Research (BMBF)
through the project ADIMEM (FKZ 01IS18052 A-D).
[ADIMEM](https://fit.uni-tuebingen.de/Project/Details?id=9199) is a collaborative
project between the groups of Jakob Macke (Uni Tübingen), Philipp Berens (Uni Tübingen),
Philipp Hennig (Uni Tübingen), and Marcel Oberlaender (caesar Bonn), which aims to develop
inference methods for mechanistic models.

![](static/logo_bmbf.svg)

Expand Down

0 comments on commit 9a8c7c0

Please sign in to comment.