SLEAP v1.5.2

What's Changed

SLEAP v1.5.2 – Bug Fixes & Dependency Updates

This release includes important bug fixes for GUI rendering and Windows compatibility, dependency updates for improved stability, and further documentation improvements.

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 --python 3.13 "sleap[nn]==1.5.2" --index https://download.pytorch.org/whl/cu128 --index https://pypi.org/simple

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

# macOS
uv tool install --python 3.13 "sleap[nn]==1.5.2"

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!

---

Upgrading from v1.5.1?

If you already have SLEAP v1.5.1 installed, you can upgrade to v1.5.2 using the following commands based on your installation method:

If installed with uv tool install:

The simplest upgrade command (preserves your original Python version and index URLs):

uv tool upgrade sleap

Or, if you want to ensure you're using Python 3.13 and refresh your installation:

uv tool uninstall sleap
# Then reinstall with the commands from the installation section above

Note: uv tool upgrade automatically preserves the index URLs (CUDA/CPU) and Python version from your original installation. If you installed with --index https://download.pytorch.org/whl/cu128, the upgrade will continue using the CUDA 12.8 index.

If installed with pip in a conda environment:

conda activate sleap
pip install --upgrade "sleap[nn]"

For platform-specific indexes (CUDA/CPU), add the appropriate --extra-index-url:

# CUDA 12.8
pip install --upgrade "sleap[nn]" --extra-index-url https://download.pytorch.org/whl/cu128 --index-url https://pypi.org/simple

# CPU
pip install --upgrade "sleap[nn]" --extra-index-url https://download.pytorch.org/whl/cpu --index-url https://pypi.org/simple

If installed with uv add (project-based):

# Navigate to your project directory
uv sync --upgrade

If installed from source:

cd sleap
git pull
uv sync --upgrade

After upgrading, verify the installation:

python -c "import sleap; sleap.versions()"

You should see SLEAP: 1.5.2 in the output.

---

Highlights

• Dependency updates:

  • Updated minimum sleap-io version to 0.5.7
  • Updated minimum sleap-nn version to 0.0.4
  • Removed cattrs dependency for simplified dependency management
  • Added --python 3.13 flag to installation commands to prevent Python 3.14 compatibility issues

• Bug fixes:

  • Fixed color rendering in sleap-render: Videos now display correct colors with proper BGR to RGB conversion (#2444)
  • Fixed Windows GUI crash: Resolved Qt widget attribute error when loading .slp files on Windows (#2440)
  • Fixed instance coloring: Multiple instances in older SLEAP projects now display with distinct colors instead of the same color (#2434)

• Documentation improvements:

  • Consolidated repetitive installation documentation (reduced by 55 lines while preserving all essential information)
  • Improved uv add installation workflow instructions with Windows troubleshooting tips
  • Clearer platform-specific installation guidance

Full Changelog: v1.5.1...v1.5.2