Skip to content

Commit e590a43

Browse files
committed
[no ci] README: move details on migration to FAQ
1 parent 8895928 commit e590a43

File tree

1 file changed

+42
-20
lines changed

1 file changed

+42
-20
lines changed

README.md

Lines changed: 42 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,28 +18,14 @@ fueled by continuous progress in generative AI and Bayesian inference.
1818

1919
You are currently looking at BayesFlow 2.0+, which is a complete rewrite of the library.
2020
While it shares the same overall goals with the 1.x versions, the API is not compatible.
21-
You can find the most recent version of BayesFlow 1.x on the `stable-legacy` branch.
22-
The latest [BayesFlow 1.x documentation](https://bayesflow.org/stable-legacy/index.html) can be accessed by selecting the "stable-legacy" entry in the version picker of the documentation.
2321

2422
> [!CAUTION]
25-
> You should not upgrade (yet) if one of the following applies:
26-
>
27-
> - You have an ongoing project that uses BayesFlow 1.x, and you do not want to allocate time for migrating to the new API.
28-
> - You require a feature that was not ported to BayesFlow 2.0+ yet. To our knowledge, this applies to:
29-
> * Two-level/Hierarchical models: `TwoLevelGenerativeModel`, `TwoLevelPrior`.
30-
> * Sensitivity analysis: functionality from the `bayesflow.sensitivity` module.
31-
> * MCMC (discontinued): The `bayesflow.mcmc` module. We are considering other options to enable the use of BayesFlow in an MCMC setting.
32-
> * Networks: `EvidentialNetwork`.
33-
> * Model misspecification detection: MMD test in the summary space (see #384).
34-
> - You have already trained models in BayesFlow 1.x, that you do not want to re-train with the new version. Loading models from version 1.x in version 2.0+ is not supported.
35-
>
36-
> If you encounter any functionality that is missing and not listed here, please let us know by opening an issue.
37-
38-
The new version brings many features, like multi-backend support via Keras3, and improved modularity and extensibility.
39-
We recommend to upgrade if none of the above conditions apply.
40-
Continue reading below for installation instructions and examples to get started.
41-
The [Moving from BayesFlow v1.1 to v2.0](examples/From_BayesFlow_1.1_to_2.0.ipynb) guide highlights how concepts and classes relate between the two versions.
42-
For additional information, please refer to the [FAQ](#faq) below.
23+
> A few features, most notably hierarchical models, have not been ported to BayesFlow 2.0+
24+
> yet. We are working on those features and plan to add them soon. You can find the complete
25+
> list in the [FAQ](#faq) below.
26+
27+
The [Moving from BayesFlow v1.1 to v2.0](examples/From_BayesFlow_1.1_to_2.0.ipynb) guide
28+
highlights how concepts and classes relate between the two versions.
4329

4430
## Conceptual Overview
4531

@@ -242,11 +228,47 @@ while the old version was based on TensorFlow.
242228

243229
-------------
244230

231+
**Question:**
232+
Should I switch to BayesFlow 2.0+ now? Are there features that are still missing?
233+
234+
**Answer:**
235+
In general, we recommend to switch, as the new version is easier to use and will continue
236+
to receive improvements and new features. However, a few features are still missing, so you
237+
might want to wait until everything you need has been ported to BayesFlow 2.0+.
238+
239+
Depending on your needs, you might not want to upgrade yet if one of the following applies:
240+
241+
- You have an ongoing project that uses BayesFlow 1.x, and you do not want to allocate
242+
time for migrating it to the new API.
243+
- You have already trained models in BayesFlow 1.x, that you do not want to re-train
244+
with the new version. Loading models from version 1.x in version 2.0+ is not supported.
245+
- You require a feature that was not ported to BayesFlow 2.0+ yet. To our knowledge,
246+
this applies to:
247+
* Two-level/Hierarchical models: `TwoLevelGenerativeModel`, `TwoLevelPrior`.
248+
* Sensitivity analysis: functionality from the `bayesflow.sensitivity` module.
249+
* MCMC (discontinued): The `bayesflow.mcmc` module. We are considering other options
250+
to enable the use of BayesFlow in an MCMC setting.
251+
* Networks: `EvidentialNetwork`.
252+
* Model misspecification detection: MMD test in the summary space (see #384).
253+
254+
If you encounter any functionality that is missing and not listed here, please let us
255+
know by opening an issue.
256+
257+
-------------
258+
245259
**Question:**
246260
I still need the old BayesFlow for some of my projects. How can I install it?
247261

248262
**Answer:**
249263
You can find and install the old Bayesflow version via the `stable-legacy` branch on GitHub.
264+
The corresponding [documentation](https://bayesflow.org/stable-legacy/index.html) can be
265+
accessed by selecting the "stable-legacy" entry in the version picker of the documentation.
266+
267+
You can also install the latest version of BayesFlow v1.x from PyPI using
268+
269+
```
270+
$ pip install "bayesflow<2.0"
271+
```
250272

251273
-------------
252274

0 commit comments

Comments
 (0)