From 9152e933871eee48a40be6f67b9f802a37c41b69 Mon Sep 17 00:00:00 2001 From: Jan Date: Mon, 30 Dec 2024 14:25:24 +0100 Subject: [PATCH] docs: prepare release, bump version (#1337) * add release template. * add changelog, fix dependencies, bump version. * update changelog. * add latest contributions. --- .../feature_or_bugfix.md} | 0 .github/PULL_REQUEST_TEMPLATE/release.md | 45 +++++++++++++++++++ CHANGELOG.md | 31 +++++++++++++ pyproject.toml | 3 +- sbi/__version__.py | 2 +- 5 files changed, 78 insertions(+), 3 deletions(-) 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..8462bf08e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -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. diff --git a/CHANGELOG.md b/CHANGELOG.md index 1b209e753..19f2dc27b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 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))