You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/data_analysis/HPC-module-SLEAP.md
+17-14Lines changed: 17 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Use the SLEAP module on the SWC HPC cluster
1
+
# Use SLEAP on the SWC HPC cluster
2
2
3
3
```{include} ../_static/swc-wiki-warning.md
4
4
```
@@ -37,7 +37,7 @@ $ ssh hpc-gw2
37
37
To learn more about accessing the HPC via SSH, see the [relevant how-to guide](ssh-cluster-target).
38
38
39
39
### Access to the SLEAP module
40
-
Once you are on the HPC gateway node, you can see the available SLEAP modules by running `module avail SLEAP`:
40
+
Once you are on the HPC gateway node, you can list the available SLEAP modules:
41
41
42
42
```{code-block} console
43
43
$ module avail SLEAP
@@ -48,11 +48,14 @@ $ module avail SLEAP
48
48
D: Default Module
49
49
...
50
50
```
51
-
-`SLEAP/2026-05-08` corresponds to `SLEAP v.1.6.3` ([PyTorch backend](https://docs.sleap.ai/)) — this is the recommended module for all new projects, and what this guide documents.
52
-
- Older modules use the legacy TensorFlow backend (e.g. `SLEAP/2025-09-30` is `SLEAP v.1.3.4`). Load these by full name if you need to maintain compatibility with an existing project, and refer to the [legacy SLEAP documentation](https://legacy.sleap.ai/). Modules with dates before `2025-09-30` are no longer recommended (built for an older Ubuntu).
51
+
-`SLEAP/2026-05-08` corresponds to [SLEAP v1.6.3](https://docs.sleap.ai/v1.6.3/) (PyTorch backend) — this is the recommended module for all new projects, and what this guide documents.
52
+
- Older modules use the [legacy TensorFlow backend](https://legacy.sleap.ai/). Use these only if you need compatibility with an existing project.
53
+
- Modules dated before `2025-09-30` were built for an older Ubuntu base and are no longer recommended.
53
54
54
-
If a module has been successfully loaded, it will be listed among
55
-
other loaded modules when you run `module list`:
55
+
To load the recommended PyTorch-based version (the default):
56
+
57
+
58
+
To view the modules that are currently loaded:
56
59
57
60
```{code-block} console
58
61
$ module list
@@ -80,10 +83,10 @@ you will need to use the SLEAP GUI for some steps, such as labelling frames.
80
83
Thus, you also need to install SLEAP on your local PC/laptop.
81
84
82
85
We recommend following the official [SLEAP installation guide](https://docs.sleap.ai/latest/installation/).
83
-
To minimise the risk of issues due to incompatibilities between versions, ensure the version of your local installation of SLEAP matches the one you plan to load in the cluster.
86
+
To avoid compatibility issues, make sure your local SLEAP version matches the module you plan to use on the cluster.
87
+
The guide also includes a [version compatibility table](https://docs.sleap.ai/latest/installation/#version-compatibility) showing which versions of `sleap`, `sleap-io`, and `sleap-nn` belong together—use this when installing a specific version or updating pinned packages.
84
88
85
-
For, example, to match the latest SLEAP module at the time of writing (`SLEAP/2026-05-08`),
86
-
you will need to run the following command in your local terminal:
89
+
For example, to match the current default module (`SLEAP/2026-05-08`, SLEAP v1.6.3), you can install the corresponding versions locally with:
0 commit comments