Skip to content

Commit

Permalink
[pre-commit.ci] auto fixes from pre-commit.com hooks
Browse files Browse the repository at this point in the history
for more information, see https://pre-commit.ci
  • Loading branch information
pre-commit-ci[bot] committed Dec 3, 2023
1 parent 877a635 commit d3d1db5
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions src/rapids_singlecell/tools/_clustering.py
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ def louvain(
described in:
Blondel, V.D., Guillaume, J.-L., Lambiotte, R., & Lefebvre, E. (2008).
Fast unfolding of community hierarchies in large networks, J. Stat.
Fast unfolding of community hierarchies in large networks, J. Stat.
Mech., P10008. DOI: 10.1088/1742-5468/2008/10/P10008
Parameters
Expand All @@ -165,19 +165,19 @@ def louvain(
`adata.obs` key under which to add the cluster labels.
adjacency
Sparse adjacency matrix of the graph, defaults to neighbors
Sparse adjacency matrix of the graph, defaults to neighbors
connectivities.
n_iterations
This controls the maximum number of levels/iterations of the
Louvain algorithm. When specified the algorithm will terminate
after no more than the specified number of iterations. No error
This controls the maximum number of levels/iterations of the
Louvain algorithm. When specified the algorithm will terminate
after no more than the specified number of iterations. No error
occurs when the algorithm terminates early in this manner.
Capped at 500 to prevent excessive runtime.
threshold
Modularity gain threshold for each level/iteration. If the gain
of modularity between two levels of the algorithm is less than
of modularity between two levels of the algorithm is less than
the given threshold then the algorithm stops and returns the
resulting communities. Defaults to 1e-7.
Expand All @@ -186,8 +186,8 @@ def louvain(
computation (placing more emphasis on stronger edges).
neighbors_key
If not specified, `louvain` looks at `.obsp['connectivities']`
for neighbors connectivities. If specified, `louvain` looks at
If not specified, `louvain` looks at `.obsp['connectivities']`
for neighbors connectivities. If specified, `louvain` looks at
`.obsp[.uns[neighbors_key]['connectivities_key']]` for neighbors
connectivities.
Expand Down

0 comments on commit d3d1db5

Please sign in to comment.