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

PR1: Add release notes and changelogs to the sleap.ai website #1500

Open
wants to merge 17 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 8 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
1 change: 1 addition & 0 deletions .github/workflows/website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ on:
- main
- develop
- liezl/add-pip-extras
shrivaths16 marked this conversation as resolved.
Show resolved Hide resolved
- shrivaths/changelog-announcement-1
paths:
- "docs/**"
- "README.rst"
Expand Down
77 changes: 77 additions & 0 deletions docs/bulletin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Bulletin

## SLEAP v1.3.2
shrivaths16 marked this conversation as resolved.
Show resolved Hide resolved

_mm/dd/yyyy_
Copy link

Choose a reason for hiding this comment

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

The date placeholder _mm/dd/yyyy_ for SLEAP v1.3.2 should be replaced with the actual release date to maintain consistency and provide complete information.

- _mm/dd/yyyy_
+ 03/15/2023  # Example date, replace with the actual release date

Committable suggestion

IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
## SLEAP v1.3.2
_mm/dd/yyyy_
## SLEAP v1.3.2
03/15/2023 # Example date, replace with the actual release date


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
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ SLEAP Documentation
notebooks/index
Developer API <api>
datasets
bulletin
GitHub <https://github.com/talmolab/sleap>
Releases <https://github.com/talmolab/sleap/releases>
help
Loading