Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Releases: talmolab/sleap

SLEAP v1.5.1

02 Oct 19:11
daf0d95

Choose a tag to compare

What's Changed

SLEAP v1.5.1 – Bug fixes & Documentation Improvements

This release focuses on a few bug fixes in the training pipeline, improving installation instructions, and updating documentation for a smoother user experience.

Note: Starting with SLEAP v1.5+, all deep learning functionality is powered by the PyTorch-based sleap-nn backend. TensorFlow models (with UNet backbones) from earlier versions are still supported for inference. Refer Migrating to 1.5+ docs for more details!

How to install?

You can now install SLEAP quickly using uv

Step 1: Install uv - an ultra-fast Python package manager

# Windows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

Step 2: Install sleap

# Windows/ Linux (CUDA)
uv tool install "sleap[nn]" --index https://download.pytorch.org/whl/cu128 --index https://pypi.org/simple

# Windows/ Linux (CPU)
uv tool install "sleap[nn]" --index https://download.pytorch.org/whl/cpu --index https://pypi.org/simple

# macOS
uv tool install "sleap[nn]"

Check the full installation guide for platform-specific instructions and advanced options.

Once you've installed SLEAP, run the below command from anywhere in your terminal

sleap-label

The GUI should open up!


Highlights

  • Improved installation:
    • Platform-specific dependency groups for sleap installation with CUDA support.
    • Fixed CUDA installation issues on Windows.
    • Updated installation instructions and options for clarity.
  • Documentation updates:
    • Fixed typos and broken links.
    • Improved CLI docs with new options and guidance on legacy CLIs.
    • Fixed MkDocs versioning and improved doc site structure.
  • Error handling: sleap-nn import errors are now handled gracefully with clear user guidance.
  • Bug fixes: Minor fixes across CLI and docs to improve stability.

Full Changelog: v1.5.0...v1.5.1

SLEAP v1.5.0

30 Sep 21:44
aeaba8b

Choose a tag to compare

What's New in SLEAP 1.5

SLEAP 1.5 represents a major milestone with significant architectural improvements, performance enhancements, and new installation methods. Here are the key changes:

Major Changes

Updated dependencies

We have now updated to support Python 3.12+ and support many new versions of the many libraries that SLEAP uses. This should make it much easier to install on modern platforms, support new architectures, and make development much easier.

UV-Based Installation

SLEAP 1.5+ now uses uv for installation, making it much faster than previous methods. Get up and running in seconds with our streamlined installation process.

PyTorch Backend

Neural network backend switched from TensorFlow to PyTorch via sleap-nn, providing:

  • Much faster training and inference speeds: Up to 2.5x faster training and inference times.
  • Modern deep learning capabilities: PyTorch with upcoming integrations with a whole slew of modern deep learning models and packages.
  • Improved developer experience: Check out the dedicated backend repo at https://github.com/talmolab/sleap-nn
  • Multi-GPU training: Full support for using multiple GPUs for accelerated and larger scale training.
  • Backwards compatibility: You are able to use your existing trained SLEAP models from v1.4.1 for the UNet backend with no changes (see notes below).

Refreshed Documentation Websites

Standalone Libraries

SLEAP GUI is now supported by two new packages for modular workflows:

SLEAP-IO

I/O backend for handling labels, processing .slp files, and data manipulation. Essential for any SLEAP workflow and can be used independently for data processing tasks.

SLEAP-NN

PyTorch-based neural network backend for training and inference. Perfect for custom training pipelines, remote processing, and headless server deployments.

Torch Backend Changes

New Backbones

SLEAP 1.5 introduces three powerful new backbone architectures (check here for more details):

  • UNet - Classic encoder-decoder architecture for precise pose estimation
  • SwinT - Swin Transformer for state-of-the-art performance
  • ConvNeXt - Modern convolutional architecture with improved efficiency

Legacy Support

We've maintained full backward compatibility:

  • GUI Support: SLEAP now uses a new YAML-based config file structure, but you can still upload and work with old SLEAP JSON files in the GUI. For details on converting legacy SLEAP 1.4 config/JSON files to the new YAML format, see our conversion guide.
  • TensorFlow Model Inference: Continue to support running inference on old TensorFlow models (UNet backbone only). Check using legacy models for more details.

SLEAP v1.4.1

19 Dec 17:57

Choose a tag to compare

SLEAP 1.4.1 releases many new changes since the last big release 1.3.3. We hope users enjoy these long awaited new features and fixes!

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 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.

Quick install

mamba (Windows/Linux/GPU):

mamba create -y -n sleap -c conda-forge -c nvidia -c sleap/label/dev -c sleap -c anaconda sleap=1.4.1

mamba (Mac):

mamba create -y -n sleap -c conda-forge -c anaconda -c sleap sleap=1.4.1

pip (any OS except Apple Silicon):

pip install sleap[pypi]==1.4.1

Highlights

Full Changelog

Enhancements

Fixes

Dependencies

Documentation

Refactors

Read more

SLEAP v1.3.4

03 Sep 20:49

Choose a tag to compare

SLEAP 1.3.4 has no changes to the SLEAP source code, but adds constraints to the attrs and opencv versions being pulled in.

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 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.

Quick install

mamba (Windows/Linux/GPU):

mamba create -y -n sleap -c conda-forge -c nvidia -c sleap -c anaconda sleap=1.3.4

mamba (Mac):

mamba create -y -n sleap -c conda-forge -c anaconda -c sleap sleap=1.3.4

pip (any OS except Apple Silicon):

pip install sleap[pypi]==1.3.4

Full Changelog

  • Constrain attrs (mac) and opencv (linux) in 1.3.4 #1927

SLEAP v1.4.1a2

28 Jun 18:40
436b177

Choose a tag to compare

SLEAP v1.4.1a2 Pre-release
Pre-release

SLEAP v1.4.1a2 is a pre-release. See 1.3.3 for the latest stable release. The crucial change here is Fix zmq inference by @roomrys in #1800 since inference was not working in the pre-release v1.4.1a1 due to the addition of zmq port options for training in #1780 that were not being used for inference.

Quick install

mamba (Windows/Linux/GPU):

mamba create -y -n sleap_v1.4.1a2 -c conda-forge -c nvidia -c sleap/label/dev -c anaconda sleap=1.4.1a2

mamba (Mac):

mamba create -y -n sleap_v1.4.1a2 -c conda-forge -c anaconda -c sleap/label/dev sleap=1.4.1a2

pip (any OS except Apple Silicon):

pip install sleap[pypi]==1.4.1a2

What's Changed

Fixes

Workflow Changes

Enhancements and Refactors

  • Set selected instance to None after removal by @roomrys in #1808
  • Add InstancesList class to handle backref to LabeledFrame by @roomrys in #1807

Full Changelog: v1.4.1a1...v1.4.1a2

SLEAP v1.4.1a1

03 Jun 02:53
61dbe62

Choose a tag to compare

SLEAP v1.4.1a1 Pre-release
Pre-release

SLEAP v1.4.1a1 is a pre-release. See 1.3.3 for the latest stable release. There are many changes to dependencies in this pre-release: if you are having installation issues with v1.3.3, you should try this version instead.

Quick install

mamba (Windows/Linux/GPU):

mamba create -y -n sleap_v1.4.1a1 -c conda-forge -c nvidia -c sleap/label/dev -c anaconda sleap=1.4.1a1

mamba (Mac):

mamba create -y -n sleap_v1.4.1a1 -c conda-forge -c anaconda -c sleap/label/dev sleap=1.4.1a1

pip (any OS except Apple Silicon):

pip install sleap[pypi]==1.4.1a1

What's Changed

Enhancements

Refactors

Fixes

Dependency Changes

Workflow Changes

Website Changes

New Contributors

Full Changelog: v1.3.3...v1.4.1a1

SLEAP v1.4.1a0

29 May 01:00
74bada8

Choose a tag to compare

SLEAP v1.4.1a0 Pre-release
Pre-release

What's Changed

New Contributors

Full Changelog: v1.3.3...v1.4.1a0

SLEAP v1.4.0a0

20 May 18:11
6a0cf9c

Choose a tag to compare

SLEAP v1.4.0a0 Pre-release
Pre-release

What's Changed

New Contributors

Full Changelog: v1.3.3...v1.4.0a0

SLEAP v1.3.3

15 Sep 23:54

Choose a tag to compare

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, 1.3.1, and 1.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 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.

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

Dependencies

Full Changelog: v1.3.2...v1.3.3

SLEAP v1.3.2

10 Sep 17:07

Choose a tag to compare

SLEAP 1.3.2 adds some nice usability features thanks to both the community ideas and new contributors! See 1.3.0 and 1.3.1 for previous notable changes.

From 1.3.2+, to install SLEAP through PyPI use pip install sleap[pypi] to ensure all dependencies are gathered.

As a reminder:

The 1.3.1 dependency update requires Mamba 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.

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

Full Changelog

Enhancements

Fixes

Dependencies

New Contributors

Full Changelog: v1.3.1...v1.3.2