Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

prepare release #1337

Merged
merged 4 commits into from
Dec 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Preparing a release

## Decide what will be the upcoming version number

- `sbi` currently uses the [Semver 2.0.0](https://semver.org/) convention.
- Edit the version number in the tuple at `sbi/sbi/__version__.py`.

## Collect a list of relevant changes

- [ ] Edit `changelog.md`: Add a new version number header and report changes below it.

Trick: To get a list of all changes since the last PR, you can start creating a
release via GitHub already (https://github.com/sbi-dev/sbi/releases, see below), add a
tag and then let GitHub automatically draft the release notes. Note that some changes
might not be worth mentioning, or others might be missing or needing more explanation.
- [ ] Use one line per change, include links to the pull requests that implemented each of
the changes.
- [ ] **Credit contributors**!
- [ ] If there are new package dependencies or updated version constraints for the existing
dependencies, add/modify the corresponding entries in `pyproject.toml`.
- [ ] Test the installation in a fresh conda env to make sure all dependencies match.

## Run tests locally and make sure they pass

- Run the **full test suite, including slow tests.**
- [ ] slow tests are passing
- [ ] GPU tests are passing

## Upload to pypi

The upload to `pypi` will happen automatically once a release is made
via GitHub.

To do so, **after merging this PR**, you need to

- [ ] copy the new content you added to `changelog.md` to the clipboard
- [ ] draft a new release here: https://github.com/sbi-dev/sbi/releases
- [ ] create a new tag using the `vX.XX.X` scheme
- [ ] paste the content of the `changelog` you copied above and edit it where needed
- [ ] select "pre-release" if needed (default no) or "latest release" (default yes)
- [ ] select "create a discussion" if there are breaking or important changes and users
should have a platform to discuss issues and questions.
- [ ] "publish" or "draft" the release.

Once the release is *published* via Github, the upload to PyPi will be triggered.
31 changes: 31 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
# v0.23.3

## Highlights 🤩

* docs: Add conda-forge install instructions by @matthewfeickert in https://github.com/sbi-dev/sbi/pull/1340
* feat: `NLE` with multiple iid conditions by @janfb in https://github.com/sbi-dev/sbi/pull/1331

## What's Changed 🚧

* fix: Correted typo in y-axis label by @turnmanh in https://github.com/sbi-dev/sbi/pull/1296
* docs: update embedding networks notebook by @emmanuel-ferdman in https://github.com/sbi-dev/sbi/pull/1297
* fix pickle issues in MCMC posterior + test by @manuelgloeckler in https://github.com/sbi-dev/sbi/pull/1291
* Minor fix for EnsemblePosterior weights.setter by @CompiledAtBirth in https://github.com/sbi-dev/sbi/pull/1299
* Remove deprecated neural_net access from `utils` by @tvwenger in https://github.com/sbi-dev/sbi/pull/1302
* [test] add tests for ensemble posterior weights by @samadpls in https://github.com/sbi-dev/sbi/pull/1307
* Clarify last round behavior of SNPE-A by @michaeldeistler in https://github.com/sbi-dev/sbi/pull/1323
* expose batched sampling option; error handling by @janfb in https://github.com/sbi-dev/sbi/pull/1321
* Fix #1316: remove sample_dim docstring for condition. by @janfb in https://github.com/sbi-dev/sbi/pull/1338
* docs: fix tutorial typos by @janfb in https://github.com/sbi-dev/sbi/pull/1341
* docs: run and seed SBC tutorial by @manuel-morales-a in https://github.com/sbi-dev/sbi/pull/1336

## New Contributors 🎉

* @emmanuel-ferdman made their first contribution in https://github.com/sbi-dev/sbi/pull/1297
* @CompiledAtBirth made their first contribution in https://github.com/sbi-dev/sbi/pull/1299
* @tvwenger made their first contribution in https://github.com/sbi-dev/sbi/pull/1302
* @matthewfeickert made their first contribution in https://github.com/sbi-dev/sbi/pull/1340
* @manuel-morales-a made their first contribution in https://github.com/sbi-dev/sbi/pull/1336

**Full Changelog**: https://github.com/sbi-dev/sbi/compare/v0.23.2...v0.23.3

# v0.23.2

## Bug Fixes
Expand Down
3 changes: 1 addition & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ keywords = ["Bayesian inference", "simulation-based inference", "PyTorch"]
dependencies = [
"arviz",
"joblib>=1.0.0",
"jupyter",
"matplotlib",
"notebook <= 6.4.12",
janfb marked this conversation as resolved.
Show resolved Hide resolved
"numpy<2.0.0",
"pillow",
"pyknos>=0.16.0",
Expand All @@ -59,7 +59,6 @@ doc = [
"mkdocstrings[python] >= 0.18",
"nbconvert",
"nbformat",
"notebook <= 6.4.12",
"traitlets <= 5.9.0",
]
dev = [
Expand Down
2 changes: 1 addition & 1 deletion sbi/__version__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This file is part of sbi, a toolkit for simulation-based inference. sbi is licensed
# under the Apache License Version 2.0, see <https://www.apache.org/licenses/>

VERSION = (0, 23, 2)
VERSION = (0, 23, 3)

__version__ = ".".join(map(str, VERSION))
Loading