Skip to content

Add advice regarding moving from v1 to v2 to README. #427

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Merged
merged 11 commits into from
Apr 28, 2025
Merged

Add advice regarding moving from v1 to v2 to README. #427

merged 11 commits into from
Apr 28, 2025

Conversation

vpratz
Copy link
Collaborator

@vpratz vpratz commented Apr 22, 2025

As we do not have full feature parity yet, I think it is important to be up-front with the functionality that is still missing, to avoid confusion and disappointment. As we now have the 2.0.0 version on PyPI, some advice on whether to upgrade or not might be helpful.

This PR adds the list of missing functionality from #388, as well as some additional considerations. Feel free to edit, but I think getting something like this out soon would be good.

Closes #388.

@vpratz
[no ci] Add advice regarding moving from v1 to v2 to README.
142ff2f 
Raise awareness regarding missing features and incompatibility between
the versions. Similar changes can be made for the docs.
@vpratz vpratz added the documentation Improvements or additions to documentation label Apr 22, 2025
@vpratz
Copy link
Collaborator Author

vpratz commented Apr 22, 2025

I have added a short phrase regarding the v1 docs, and a link to the migration advice so people can find it.

LarsKue added 2 commits April 22, 2025 10:37
@LarsKue
Hotfix Version 2.0.1 (bayesflow-org#431)
546f812 
* fix optimal transport config (bayesflow-org#429)

* run linter

* [skip-ci] bump version to 2.0.1
@LarsKue
Merge branch 'dev'
3c83a47
@stefanradev93
Copy link
Contributor

@paul-buerkner What do you think? I believe we can shorten some of the description, as most of the old functionality is probably not relevant. The two level model is probably the most important gap which I intend to close soon.

@LarsKue
Merge pull request bayesflow-org#436 from bayesflow-org/dev
d31a761 
Optimal transport hot fixes, consistency models test, and fast imports
@paul-buerkner
Copy link
Contributor

I like it. About shortening, do you mean the new edits of this PR or older stuff in the vignette? Having some more details cannot hurt I would say. Why would you want to shorten it?

@paul-buerkner
Copy link
Contributor

Edit: I now realize this is supposed to be part of the readme not the vignette. Yes, I agree we should shorten it a lot.
Or perhaps better, put the caution sign to the top but all the details down somewhere in the FAQ (and a link to it at the top). It is not helpful for a readme file if I have to read a lot about old stuff without seeing all the cool new stuff first.

@vpratz
Copy link
Collaborator Author

vpratz commented Apr 25, 2025

I have moved the details to the FAQ. Any thoughts on how to best highlight the section in the top part? I'm not sure whether it needs a separate heading, or some highlighting is enough.
I can see that presenting new features is the exciting part with the new release, but I think at least in the next few weeks we should also focus on our existing user base, so that they do not get the impression that there is a new version and "nothing works anymore".
As the new version is on PyPI now, and some users may upgrade by accident, I think having this information somewhere prominent soon is important.

@vpratz
Copy link
Collaborator Author

vpratz commented Apr 25, 2025

Again, feel free to edit as you see fit. If you are happy with the text, I will copy the FAQ section to the FAQ on the website as well...

@LarsKue LarsKue changed the base branch from main to dev April 25, 2025 18:16
@codecov Codecov
Copy link

codecov bot commented Apr 25, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

paul-buerkner
paul-buerkner approved these changes Apr 28, 2025
View reviewed changes
Copy link
Contributor

@paul-buerkner paul-buerkner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thank you! From my side, we can merge as is.

@vpratz vpratz merged commit a7f9162 into bayesflow-org:dev Apr 28, 2025
15 checks passed
@vpratz vpratz deleted the docs-migration-advice branch April 28, 2025 14:38
@vpratz vpratz mentioned this pull request Apr 28, 2025
Closed
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@paul-buerkner paul-buerkner paul-buerkner approved these changes

@stefanradev93 stefanradev93 Awaiting requested review from stefanradev93

@LarsKue LarsKue Awaiting requested review from LarsKue

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Compile list of functionality not yet ported to v2
4 participants
@vpratz @stefanradev93 @paul-buerkner @LarsKue