diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml index 7db6b4d74..e33c9df3e 100644 --- a/.github/workflows/website.yml +++ b/.github/workflows/website.yml @@ -8,7 +8,7 @@ on: # 'main' triggers updates to 'sleap.ai', all others to 'sleap.ai/develop' - main - develop - - liezl/add-pip-extras + - shrivaths/changelog-announcement-1 paths: - "docs/**" - "README.rst" diff --git a/docs/bulletin.md b/docs/bulletin.md new file mode 100644 index 000000000..848e1d8a2 --- /dev/null +++ b/docs/bulletin.md @@ -0,0 +1,128 @@ +# What's New? + +## SLEAP v1.3.3 + +_09/15/2023_ + +This is a brown-bag release following insufficient restrictions on allowable `tensorflow` versions for the "pypi" extra `sleap[pypi]` in 1.3.2. While the conda packages for 1.3.2 were not affected (since `tensorflow` is pulled in from anaconda), the PyPI only package installed via `pip install sleap[pypi]` had conflicts between the version of `tensorflow` and the version of `keras`. See [1.3.0](https://github.com/talmolab/sleap/releases/tag/v1.3.0), [1.3.1](https://github.com/talmolab/sleap/releases/tag/v1.3.1), and [1.3.2](https://github.com/talmolab/sleap/releases/tag/v1.3.2) for previous notable changes. + +**From 1.3.2+, to install SLEAP through pip use `pip install sleap[pypi]` to ensure all dependencies are gathered.** + +As a reminder: + +> The 1.3.1 dependency update requires [Mamba](https://mamba.readthedocs.io/en/latest/index.html) for faster dependency resolution. If you already have anaconda installed, then you _can_ set the solver to libmamba in the base environment: +>``` +>conda update -n base conda +>conda install -n base conda-libmamba-solver +>conda config --set solver libmamba +>``` +>Any subsequent `mamba` commands in the docs will need to be replaced with `conda` if you choose to use your existing Anaconda installation. +> +>Otherwise, follow the [recommended installation instruction for Mamba](https://mamba.readthedocs.io/en/latest/installation.html). + +### Quick install +**`mamba` (Windows/Linux/GPU)**: +``` +mamba create -y -n sleap -c conda-forge -c nvidia -c sleap -c anaconda sleap=1.3.3 +``` + +**`mamba` (Mac)**: +``` +mamba create -y -n sleap -c conda-forge -c anaconda -c sleap sleap=1.3.3 +``` + +**`pip` (any OS except Apple Silicon)**: +``` +pip install sleap[pypi]==1.3.3 +``` + +### Full Changelog + +##### Fixes +* Do not try to remove item if already deleted by @roomrys in https://github.com/talmolab/sleap/pull/1498 +* Set `LD_LIBRARY_PATH` on mamba activate by @roomrys in https://github.com/talmolab/sleap/pull/1496 +* Reset `LD_LIBRARY_PATH` on deactivate by @roomrys in #1502 + +##### Dependencies +* Add version restirctions to tendorflow for pypi by @roomrys in #1485 +* Remove `imageio` pin by @roomrys in #1501 + +**Full Changelog**: https://github.com/talmolab/sleap/compare/v1.3.2...v1.3.3 + +--- + +## SLEAP v1.3.2 + +_09/10/2023_ + +SLEAP 1.3.2 adds some nice usability features thanks to both the community ideas and new contributors! See [1.3.0](https://github.com/talmolab/sleap/releases/tag/v1.3.0) and [1.3.1](https://github.com/talmolab/sleap/releases/tag/v1.3.1) for previous notable changes. As a reminder: + +> The 1.3.1 dependency update requires [Mamba](https://mamba.readthedocs.io/en/latest/index.html) for faster dependency resolution. If you already have anaconda installed, then you _can_ set the solver to libmamba in the base environment: +>``` +>conda update -n base conda +>conda install -n base conda-libmamba-solver +>conda config --set solver libmamba +>``` +>Any subsequent `mamba` commands in the docs will need to be replaced with `conda` if you choose to use your existing Anaconda installation. +> +>Otherwise, follow the [recommended installation instruction for Mamba](https://mamba.readthedocs.io/en/latest/installation.html). + +### Quick install +**`mamba` (Windows/Linux/GPU)**: +``` +mamba create -y -n sleap -c conda-forge -c nvidia -c sleap -c anaconda sleap=1.3.2 +``` + +**`mamba` (Mac)**: +``` +mamba create -y -n sleap -c conda-forge -c anaconda -c sleap sleap=1.3.2 +``` + +**`pip` (any OS except Apple Silicon)**: +``` +pip install sleap[pypi]==1.3.2 +``` + +### Highlights +* Limit max tracks via track-local queues by @shrivaths16 and @talmo in https://github.com/talmolab/sleap/pull/1447 +* Add option to remove videos in batch by @gitttt-1234 in https://github.com/talmolab/sleap/pull/1382 and https://github.com/talmolab/sleap/pull/1406 +* Add shortcut to export analysis for current video by @KevinZ0217 in https://github.com/talmolab/sleap/pull/1414 and https://github.com/talmolab/sleap/pull/1444 +* Add video path and frame indices to metrics by @roomrys in https://github.com/talmolab/sleap/pull/1396 +* Add a button for copying model config to clipboard by @KevinZ0217 in https://github.com/talmolab/sleap/pull/1433 +* Add Option to Export CSV by @gitttt-1234 in https://github.com/talmolab/sleap/pull/1438 + +### Full Changelog + +##### Enhancements +* Add option to remove videos in batch by @gitttt-1234 in https://github.com/talmolab/sleap/pull/1382 and https://github.com/talmolab/sleap/pull/1406 +* Add `Track` when add `Instance` by @roomrys in https://github.com/talmolab/sleap/pull/1408 +* Add `Video` to cache when adding `Track` by @roomrys in https://github.com/talmolab/sleap/pull/1407 +* Add shortcut to export analysis for current video by @KevinZ0217 in https://github.com/talmolab/sleap/pull/1414 and https://github.com/talmolab/sleap/pull/1444 +* Add video path and frame indices to metrics by @roomrys in https://github.com/talmolab/sleap/pull/1396 +* Improve error message for detecting video backend by @roomrys in https://github.com/talmolab/sleap/pull/1441 +* Add a button for copying model config to clipboard by @KevinZ0217 in https://github.com/talmolab/sleap/pull/1433 +* Add Option to Export CSV by @gitttt-1234 in https://github.com/talmolab/sleap/pull/1438 +* Limit max tracks via track-local queues by @shrivaths16 and @talmo in https://github.com/talmolab/sleap/pull/1447 + +##### Fixes +* Minor fix in computation of OKS by @shrivaths16 in https://github.com/talmolab/sleap/pull/1383 and https://github.com/talmolab/sleap/pull/1399 +* Fix `Filedialog` to work across (mac)OS by @roomrys in https://github.com/talmolab/sleap/pull/1393 +* Fix panning bounding box by @gitttt-1234 in https://github.com/talmolab/sleap/pull/1398 +* Fix skeleton templates by @roomrys in https://github.com/talmolab/sleap/pull/1404 +* Fix labels export for json by @roomrys in https://github.com/talmolab/sleap/pull/1410 +* Correct GUI state emulation by @roomrys in https://github.com/talmolab/sleap/pull/1422 +* Update status message on status bar by @shrivaths16 in https://github.com/talmolab/sleap/pull/1411 +* Fix error thrown when last video is deleted by @shrivaths16 in https://github.com/talmolab/sleap/pull/1421 +* Add model folder to the unzip path by @roomrys in https://github.com/talmolab/sleap/pull/1445 +* Fix drag and drop by @talmo in https://github.com/talmolab/sleap/pull/1449 + +##### Dependencies +* Pin micromamba version by @roomrys in https://github.com/talmolab/sleap/pull/1376 +* Add pip extras by @roomrys in https://github.com/talmolab/sleap/pull/1481 + +##### New Contributors +* @shrivaths16 made their first contribution in https://github.com/talmolab/sleap/pull/1383 +* @gitttt-1234 made their first contribution in https://github.com/talmolab/sleap/pull/1382 +* @KevinZ0217 made their first contribution in https://github.com/talmolab/sleap/pull/1414 + +**Full Changelog**: https://github.com/talmolab/sleap/compare/v1.3.1...v1.3.2 \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 9a91f6c38..60d59495f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,6 +17,7 @@ SLEAP Documentation notebooks/index Developer API datasets + What's new GitHub Releases help