Skip to content

Commit 7f7c7b5

Browse files
committed
readme updates preparing for merge
1 parent bff5153 commit 7f7c7b5

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

README.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![DOI](https://img.shields.io/badge/DOI-10.21105%2Fjoss.05702-blue?style=for-the-badge)](https://doi.org/10.21105/joss.05702)
55
![PyPI - License](https://img.shields.io/pypi/l/bayesflow?style=for-the-badge)
66

7-
BayesFlow 2 is a Python library for simulation-based **Amortized Bayesian Inference** with neural networks.
7+
BayesFlow (version 2.0+) is a Python library for simulation-based **Amortized Bayesian Inference** with neural networks.
88
It provides users and researchers with:
99

1010
- A user-friendly API for rapid Bayesian workflows
@@ -49,7 +49,7 @@ history = workflow.fit_online(epochs=50, batch_size=32, num_batches_per_epoch=50
4949
diagnostics = workflow.plot_default_diagnostics(test_data=300)
5050
```
5151

52-
For an in-depth exposition, check out our walkthrough notebooks below. More tutorials are always welcome!
52+
For an in-depth exposition, check out our walkthrough notebooks below.
5353

5454
1. [Linear regression starter example](examples/Linear_Regression_Starter.ipynb)
5555
2. [From ABC to BayesFlow](examples/From_ABC_to_BayesFlow.ipynb)
@@ -59,6 +59,8 @@ For an in-depth exposition, check out our walkthrough notebooks below. More tuto
5959
6. [Bayesian experimental design](examples/Bayesian_Experimental_Design.ipynb)
6060
7. [Simple model comparison example](examples/One_Sample_TTest.ipynb)
6161

62+
More tutorials are always welcome! Please consider making a pull request if you have a cool Bayesflow example that you want to contribute.
63+
6264
## Install
6365

6466
### Backend
@@ -69,9 +71,8 @@ First, install one machine learning backend of choice. Note that BayesFlow **wil
6971
- [Install PyTorch](https://pytorch.org/get-started/locally/)
7072
- [Install TensorFlow](https://www.tensorflow.org/install)
7173

72-
If you don't know which backend to use, we recommend JAX to get started.
73-
It is the fastest backend and already works pretty reliably with the current
74-
dev version of bayesflow.
74+
If you don't know which backend to use, we recommend JAX as it is currently
75+
the fastest backend.
7576

7677
Once installed, [set the backend environment variable as required by keras](https://keras.io/getting_started/#configuring-your-backend). For example, inside your Python script write:
7778

@@ -93,22 +94,22 @@ This way, you also don't have to manually set the backend every time you are sta
9394

9495
### Using pip
9596

96-
You can install the dev version with pip:
97+
You can install the Bayesflow from Github with pip:
9798

9899
```bash
99-
pip install git+https://github.com/bayesflow-org/bayesflow@dev
100+
pip install git+https://github.com/bayesflow-org/bayesflow@main
100101
```
101102

102-
### Using Conda (coming soon)
103+
### Using Conda
103104

104-
The dev version is not conda-installable yet.
105+
Bayesflow is currently not conda-installable.
105106

106107
### From Source
107108

108-
If you want to contribute to BayesFlow, we recommend installing the dev branch from source:
109+
If you want to contribute to BayesFlow, we recommend installing it from source:
109110

110111
```bash
111-
git clone -b dev [email protected]:bayesflow-org/bayesflow.git
112+
git clone -b main [email protected]:bayesflow-org/bayesflow.git
112113
cd <local-path-to-bayesflow-repository>
113114
conda env create --file environment.yaml --name bayesflow
114115
```
@@ -167,10 +168,24 @@ You can cite BayesFlow along the lines of:
167168
}
168169
```
169170

171+
## FAQ
172+
173+
- *I am starting with Bayesflow, which backend shall I use?*
174+
A: We recommend JAX as it is currently the fastest backend.
175+
176+
- *What is the difference between Bayesflow 2.0+ and previous versions?*
177+
A: Bayesflow 2.0+ is a complete rewrite of the library. It shares the same
178+
overall goals with previous versions, but has much better modularity
179+
and extensibility. What is more, the new Bayesflow has multi-backend support via Keras3,
180+
while the old Bayesian was based on tensorflow only.
181+
182+
- *I still need the old Bayesflow for some of my projects. How can I install it?*
183+
A: You can find and install the old Bayesflow version via the "bayesflow1" branch on github.
184+
170185
## Awesome Amortized Inference
171186

172187
If you are interested in a curated list of resources, including reviews, software, papers, and other resources related to amortized inference, feel free to explore our [community-driven list](https://github.com/bayesflow-org/awesome-amortized-inference).
173188

174189
## Acknowledgments
175190

176-
This project is currently managed by researchers from Rensselaer Polytechnic Institute, TU Dortmund University, and Heidelberg University. It is partially funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation, Project 528702768). The project is further supported by Germany's Excellence Strategy -- EXC-2075 - 390740016 (Stuttgart Cluster of Excellence SimTech) and EXC-2181 - 390900948 (Heidelberg Cluster of Excellence STRUCTURES), as well as the Informatics for Life initiative funded by the Klaus Tschira Foundation.
191+
This project is currently managed by researchers from Rensselaer Polytechnic Institute, TU Dortmund University, and Heidelberg University. It is partially funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) Projects 528702768 and 508399956. The project is further supported by Germany's Excellence Strategy -- EXC-2075 - 390740016 (Stuttgart Cluster of Excellence SimTech) and EXC-2181 - 390900948 (Heidelberg Cluster of Excellence STRUCTURES), the collaborative research cluster TRR 391 – 520388526, as well as the Informatics for Life initiative funded by the Klaus Tschira Foundation.

0 commit comments

Comments
 (0)