You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27Lines changed: 27 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,33 @@ It provides users and researchers with:
14
14
BayesFlow (version 2+) is designed to be a flexible and efficient tool that enables rapid statistical inference
15
15
fueled by continuous progress in generative AI and Bayesian inference.
16
16
17
+
## Migrating from BayesFlow 1.x to BayesFlow 2.0+
18
+
19
+
You are currently looking at BayesFlow 2.0+, which is a complete rewrite of the library.
20
+
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.
23
+
24
+
> [!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:
> * 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.
0 commit comments