Skip to content

Commit 885bb81

Browse files
committed
Mini-changes to readme
1 parent 7f7c7b5 commit 885bb81

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
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 (version 2.0+) is a Python library for simulation-based **Amortized Bayesian Inference** with neural networks.
7+
BayesFlow 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
1111
- A rich collection of neural network architectures
1212
- Multi-backend support via [Keras3](https://keras.io/keras_3/): You can use [PyTorch](https://github.com/pytorch/pytorch), [TensorFlow](https://github.com/tensorflow/tensorflow), or [JAX](https://github.com/google/jax)
1313

14-
BayesFlow is designed to be a flexible and efficient tool that enables rapid statistical inference
14+
BayesFlow (version 2+) is designed to be a flexible and efficient tool that enables rapid statistical inference
1515
fueled by continuous progress in generative AI and Bayesian inference.
1616

1717
## Conceptual Overview
@@ -59,7 +59,7 @@ For an in-depth exposition, check out our walkthrough notebooks below.
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.
62+
More tutorials are always welcome! Please consider making a pull request if you have a cool application that you want to contribute.
6363

6464
## Install
6565

@@ -71,7 +71,7 @@ First, install one machine learning backend of choice. Note that BayesFlow **wil
7171
- [Install PyTorch](https://pytorch.org/get-started/locally/)
7272
- [Install TensorFlow](https://www.tensorflow.org/install)
7373

74-
If you don't know which backend to use, we recommend JAX as it is currently
74+
If you don't know which backend to use, we recommend JAX as it is currently
7575
the fastest backend.
7676

7777
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:
@@ -102,7 +102,7 @@ pip install git+https://github.com/bayesflow-org/bayesflow@main
102102

103103
### Using Conda
104104

105-
Bayesflow is currently not conda-installable.
105+
Bayesflow is currently not conda-installable.
106106

107107
### From Source
108108

@@ -171,16 +171,16 @@ You can cite BayesFlow along the lines of:
171171
## FAQ
172172

173173
- *I am starting with Bayesflow, which backend shall I use?*
174-
A: We recommend JAX as it is currently the fastest backend.
174+
**A**: We recommend JAX as it is currently the fastest backend.
175175

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
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
178178
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.
179+
and extensibility. What is more, the new BayesFlow has multi-backend support via Keras3,
180+
while the old version was based on TensorFlow.
181181

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.
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 `stable-legacy` branch on GitHub.
184184

185185
## Awesome Amortized Inference
186186

0 commit comments

Comments
 (0)