From 3d3bd007838b4f6d7bf8dc5e90a0563faad329f6 Mon Sep 17 00:00:00 2001 From: Jan Date: Thu, 19 Dec 2024 15:02:18 +0100 Subject: [PATCH 1/4] add release template. --- .../feature_or_bugfix.md} | 0 .github/PULL_REQUEST_TEMPLATE/release.md | 39 +++++++++++++++++++ 2 files changed, 39 insertions(+) rename .github/{PULL_REQUEST_TEMPLATE.md => PULL_REQUEST_TEMPLATE/feature_or_bugfix.md} (100%) create mode 100644 .github/PULL_REQUEST_TEMPLATE/release.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/feature_or_bugfix.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE.md rename to .github/PULL_REQUEST_TEMPLATE/feature_or_bugfix.md diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md new file mode 100644 index 000000000..2651c901b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -0,0 +1,39 @@ +# 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. +- [ ] 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`. + +## 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. From 0b66fcae25b0c76ed6d64e0abb98939dab752baf Mon Sep 17 00:00:00 2001 From: Jan Date: Thu, 19 Dec 2024 15:25:35 +0100 Subject: [PATCH 2/4] add changelog, fix dependencies, bump version. --- .github/PULL_REQUEST_TEMPLATE/release.md | 8 +++++++- CHANGELOG.md | 21 +++++++++++++++++++++ pyproject.toml | 3 +-- sbi/__version__.py | 2 +- 4 files changed, 30 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md index 2651c901b..8462bf08e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release.md +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -7,12 +7,18 @@ ## Collect a list of relevant changes -- [ ] Edit `changelog.md`, add a new version number header and report changes below it. +- [ ] 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 diff --git a/CHANGELOG.md b/CHANGELOG.md index 1b209e753..6ae80556e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,24 @@ +# v0.23.3 + +## What's Changed 🚧 + +* 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 + +## 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 + +**Full Changelog**: https://github.com/sbi-dev/sbi/compare/v0.23.2...v0.23.3 + # v0.23.2 ## Bug Fixes diff --git a/pyproject.toml b/pyproject.toml index 71c270459..072c0b8d1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -31,8 +31,8 @@ keywords = ["Bayesian inference", "simulation-based inference", "PyTorch"] dependencies = [ "arviz", "joblib>=1.0.0", - "jupyter", "matplotlib", + "notebook <= 6.4.12", "numpy<2.0.0", "pillow", "pyknos>=0.16.0", @@ -59,7 +59,6 @@ doc = [ "mkdocstrings[python] >= 0.18", "nbconvert", "nbformat", - "notebook <= 6.4.12", "traitlets <= 5.9.0", ] dev = [ diff --git a/sbi/__version__.py b/sbi/__version__.py index a68f3f602..4fdd0cc36 100644 --- a/sbi/__version__.py +++ b/sbi/__version__.py @@ -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 -VERSION = (0, 23, 2) +VERSION = (0, 23, 3) __version__ = ".".join(map(str, VERSION)) From 3c94441e03af0b6ae8034d8f14e79466d0b6e67c Mon Sep 17 00:00:00 2001 From: Jan Date: Sat, 21 Dec 2024 15:18:59 +0100 Subject: [PATCH 3/4] update changelog. --- CHANGELOG.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6ae80556e..1b3596017 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,21 +1,29 @@ # 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 🚧 -* Correted typo in y-axis label by @turnmanh in https://github.com/sbi-dev/sbi/pull/1296 +* 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 +* 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 ## 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 **Full Changelog**: https://github.com/sbi-dev/sbi/compare/v0.23.2...v0.23.3 From 7bcc9c4f86868b981489503891635f0ddc230db7 Mon Sep 17 00:00:00 2001 From: Jan Date: Mon, 23 Dec 2024 18:08:39 +0100 Subject: [PATCH 4/4] add latest contributions. --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1b3596017..19f2dc27b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ * 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 🎉 @@ -24,6 +25,7 @@ * @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