adds backwards compatibilty for louvain (#114)

* adds backwards compatibilty for louvain * adds release notes * add installer * update notebooks * updates notebooks * updates release notes
scverse · Jan 3, 2024 · 6460b7c · 6460b7c
1 parent cc04c58
commit 6460b7c
Show file tree

Hide file tree

Showing 14 changed files with 791 additions and 845 deletions.
diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ The easiest way to install *rapids-singlecell* is to use one of the *yaml* file
 ```
 conda env create -f conda/rsc_rapids_23.04.yml
 # or
-mamba env create -f conda/rsc_rapids_23.10.yml
+mamba env create -f conda/rsc_rapids_23.12.yml
 ```
 ### PyPI
 ```

diff --git a/conda/rsc_rapids_23.10.yml → conda/rsc_rapids_23.12.yml b/conda/rsc_rapids_23.10.yml → conda/rsc_rapids_23.12.yml
@@ -5,7 +5,7 @@ channels:
  - conda-forge
  - bioconda
 dependencies:
- - rapids=23.10
+ - rapids=23.12
  - python=3.10
  - cuda-version=11.8
  - cudnn

diff --git a/docs/Installation.md b/docs/Installation.md
@@ -4,7 +4,7 @@ The easiest way to install *rapids-singlecell* is to use one of the *yaml* file
 ```
 conda env create -f conda/rsc_rapids_23.04.yml
 # or
-mamba env create -f conda/rsc_rapids_23.10.yml
+mamba env create -f conda/rsc_rapids_23.12.yml
 ```
 ## PyPI
 As of version 0.4.0 *rapids-singlecell* is now on PyPI.

diff --git a/docs/notebooks/demo_gpu-PR.ipynb b/docs/notebooks/demo_gpu-PR.ipynb
diff --git a/docs/notebooks/demo_gpu-seuratv3-brain-1M.ipynb b/docs/notebooks/demo_gpu-seuratv3-brain-1M.ipynb
diff --git a/docs/notebooks/demo_gpu-seuratv3.ipynb b/docs/notebooks/demo_gpu-seuratv3.ipynb
diff --git a/docs/notebooks/demo_gpu.ipynb b/docs/notebooks/demo_gpu.ipynb
diff --git a/docs/release-notes/0.9.5.md b/docs/release-notes/0.9.5.md
@@ -0,0 +1,9 @@
+### 0.9.5
+
+```{rubric} Bug fixes
+```
+* {func}`~rapids_singlecell.tl.louvain` now has backward compatibility with older rapids versions {pr}`114` {smaller}`S Dicks`
+
+```{rubric} Misc
+```
+* Updates Conda yaml file to work with rapids-23.12 {pr}`114` {smaller}`S Dicks`
diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md
@@ -3,6 +3,9 @@
 # Release notes
 
 ## Version 0.9.0
+```{include} /release-notes/0.9.5.md
+``````
+
 ```{include} /release-notes/0.9.4.md
 ``````
 

diff --git a/notebooks/demo_gpu-PR.ipynb b/notebooks/demo_gpu-PR.ipynb
diff --git a/notebooks/demo_gpu-seuratv3-brain.ipynb b/notebooks/demo_gpu-seuratv3-brain.ipynb
diff --git a/notebooks/demo_gpu-seuratv3.ipynb b/notebooks/demo_gpu-seuratv3.ipynb
diff --git a/notebooks/demo_gpu.ipynb b/notebooks/demo_gpu.ipynb
diff --git a/src/rapids_singlecell/tools/_clustering.py b/src/rapids_singlecell/tools/_clustering.py
@@ -5,6 +5,7 @@
 import pandas as pd
 from anndata import AnnData
 from natsort import natsorted
+from packaging import version
 from scanpy.tools._utils import _choose_graph
 from scanpy.tools._utils_clustering import rename_groups, restrict_adjacency
 from scipy import sparse
@@ -221,6 +222,7 @@ def louvain(
     """
     # Adjacency graph
     from cugraph import Graph
+    from cugraph import __version__ as cuv
     from cugraph import louvain as culouvain
 
     adata = adata.copy() if copy else adata
@@ -247,12 +249,19 @@ def louvain(
     g.from_cudf_adjlist(offsets, indices, weights)
 
     # Cluster
-    louvain_parts, _ = culouvain(
-        g,
-        resolution=resolution,
-        max_level=n_iterations,
-        threshold=threshold,
-    )
+    if version.parse(cuv) >= version.parse("23.08.00"):
+        louvain_parts, _ = culouvain(
+            g,
+            resolution=resolution,
+            max_level=n_iterations,
+            threshold=threshold,
+        )
+    else:
+        louvain_parts, _ = culouvain(
+            g,
+            resolution=resolution,
+            max_iter=n_iterations,
+        )
 
     # Format output
     groups = (