Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/python-package.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,9 @@ jobs:
python-version: [ "3.12", "3.13", "3.14" ]

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v6
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
Expand Down
9 changes: 9 additions & 0 deletions HISTORY.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,15 @@
History
=======

1.4.0 (2026-05-01)
------------------
* Removed tensorflow and keras and replaced with torch and torchvision.
* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.

API and Bug Fixes:
* Added row and polygon annotations.

1.3.0 (2026-02-24)
------------------
* Removed interactive stLearn/embedded web application.
Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,8 @@ undissociated tissue sample.
Latest Additions
----------------

.. include:: release_notes/1.4.0.rst

.. include:: release_notes/1.3.0.rst

.. include:: release_notes/1.2.2.rst
Expand Down
12 changes: 12 additions & 0 deletions docs/release_notes/1.4.0.rst
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1.4.0 `2026-05-01`
~~~~~~~~~~~~~~~~~~~~~~~~~

.. rubric:: Features

* Removed tensorflow and keras and replaced with torch and torchvision.
* Added row and polygon annotations.

.. rubric:: Bugs

* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.
2 changes: 2 additions & 0 deletions docs/release_notes/index.rst
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
Release Notes
===================================================

.. include:: 1.4.0.rst

.. include:: 1.3.0.rst

.. include:: 1.2.2.rst
Expand Down
23 changes: 13 additions & 10 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "stlearn"
version = "1.3.0"
version = "1.4.0"
authors = [
{ name = "Genomics and Machine Learning Lab", email = "andrew.newman@uq.edu.au" },
]
Expand All@@ -13,24 +13,27 @@ readme = { file = "README.md", content-type = "text/markdown" }
license = { text = "BSD license" }
requires-python = ">=3.12"
dependencies = [
"anndata>=0.10.0,<0.12",
"anndata>=0.12.0",
"bokeh>=3.7.0,<4.0",
"click>=8.2.0,<9.0",
"igraph>=1.0.0",
"leidenalg>=0.11.0",
"numba>=0.58.1",
"numpy>=1.26.0",
"numpy>=2.4.0",
"pillow>=11.0.0,<12.0",
"scanpy>=1.11.0,<2.0",
"scanpy>=1.12.0",
"scikit-image>=0.22.0",
"tensorflow>=2.14.1",
"keras>=2.14.0",
"pandas>=2.3.0",
"imageio>=2.37.0,<3.0",
"scipy>=1.11.0,<2.0",
"scikit-learn>=1.7.0,<2.0",
"spatialdata>=0.2.5,<0.3",
"spatialdata-io>=0.1.5,<0.2",
"scipy>=1.17.0,<2.0",
"scikit-learn>=1.8.0,<2.0",
"zarr>=3.1",
"dask>=2024.11.2",
"spatialdata>=0.7.0",
"spatialdata-io>=0.6.0",
"spatialdata-plot>=0.3.0",
"torch>=2.0",
"torchvision>=0.15",
"geopandas>=1.0.0,<2.0",
"shapely>=2.0.0,<3.0",
]
Expand Down
8 changes: 0 additions & 8 deletions stlearn/__main__.py

This file was deleted.

4 changes: 4 additions & 0 deletions stlearn/add.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
from .adds.labels import labels
from .adds.lr import lr
from .adds.parsing import parsing
from .adds.polygon_annotations import polygon_annotations
from .adds.positions import positions
from .adds.row_annotations import row_annotations

__all__ = [
"image",
Expand All@@ -19,4 +21,6 @@
"add_mask",
"apply_mask",
"add_loupe_clusters",
"row_annotations",
"polygon_annotations",
]
12 changes: 3 additions & 9 deletions stlearn/adds/polygon_annotations.py
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
from pathlib import Path

import geopandas as gpd
import spatialdata.models as models

from stlearn._compat import get_adata, is_spatial_data

Expand DownExpand Up@@ -46,18 +47,11 @@ def polygon_annotations(

# If SpatialData, also store the polygons as a shapes element
if is_spatial_data(data):
import spatialdata.models as models

parsed = models.ShapesModel.parse(annotations)
data.shapes[obs_key] = parsed
data.tables[table_key] = adata

n_annotated = adata.obs[obs_key].notna().sum()
print(
f"Added polygon annotations to adata.obs['{obs_key}']: "
f"{n_annotated}/{adata.n_obs} cells/spots annotated"
)

if is_spatial_data(data):
return data
return adata if copy else None
else:
return adata if copy else None
85 changes: 69 additions & 16 deletions stlearn/adds/row_annotations.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

import pandas as pd
from anndata import AnnData
from pandas import DataFrame


def row_annotations(
Expand DownExpand Up@@ -40,12 +41,78 @@ def row_annotations(
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
merged = annotations.reindex(adata.obs_names)

added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

return adata if copy else None


def row_annotations_proportions(
adata: AnnData,
annotations: pd.DataFrame | str | Path,
proportion_column_name: str = "cell_type",
join_column: str | None = None,
columns: list[str] | None = None,
copy: bool = False,
) -> AnnData | None:
"""\
Add annotations to adata.obs by joining on cell/spot identifiers and then
assuming that the values are cell proportions picking the highest proportion.

Merges a DataFrame (or CSV file) into adata.obs based on a
shared index or column. Useful for adding metadata such as
manual labels, clinical annotations, or external classifications.

Parameters
----------
adata
Annotated data matrix.
annotations
DataFrame or path to a CSV/TSV file containing annotations.
proportion_column_name, default =
The column name to use to add the high proprotion value to
join_column
Column in annotations to join on. If None, uses the
DataFrame index. The join is always against adata.obs_names.
columns
Subset of columns to add. If None, adds all columns
(excluding join_column).
copy
Return a copy instead of writing to adata.

Returns
-------
Depending on `copy`, returns or updates `adata` with new
columns added to `adata.obs`.
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
annotations = annotations.astype("float64")
labels = annotations.idxmax(axis=1)
adata.obs[proportion_column_name] = labels

return adata if copy else None


def _read_annotations(
annotations: DataFrame | str | Path,
columns: list[str] | None,
join_column: str | None,
) -> DataFrame:
if isinstance(annotations, (str, Path)):
path = Path(annotations)
sep = "\t" if path.suffix in (".tsv", ".txt") else ","
annotations = pd.read_csv(path, sep=sep)

if join_column is not None:
if join_column is None:
annotations = annotations.set_index(annotations.columns[0])
else:
if join_column not in annotations.columns:
raise ValueError(
f"Column '{join_column}' not found. "
Expand All@@ -58,18 +125,4 @@ def row_annotations(
if missing:
raise ValueError(f"Columns not found: {missing}")
annotations = annotations[columns]

merged = annotations.reindex(adata.obs_names)

n_matched = merged.notna().any(axis=1).sum()
added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

print(
f"Added {len(added_cols)} column(s) to adata.obs: {added_cols}. "
f"{n_matched}/{adata.n_obs} cells/spots matched."
)

return adata if copy else None
return annotations
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/python-package.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,9 @@ jobs:
python-version: [ "3.12", "3.13", "3.14" ]

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v6
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
Expand Down
9 changes: 9 additions & 0 deletions HISTORY.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,15 @@
History
=======

1.4.0 (2026-05-01)
------------------
* Removed tensorflow and keras and replaced with torch and torchvision.
* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.

API and Bug Fixes:
* Added row and polygon annotations.

1.3.0 (2026-02-24)
------------------
* Removed interactive stLearn/embedded web application.
Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,8 @@ undissociated tissue sample.
Latest Additions
----------------

.. include:: release_notes/1.4.0.rst

.. include:: release_notes/1.3.0.rst

.. include:: release_notes/1.2.2.rst
Expand Down
12 changes: 12 additions & 0 deletions docs/release_notes/1.4.0.rst
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1.4.0 `2026-05-01`
~~~~~~~~~~~~~~~~~~~~~~~~~

.. rubric:: Features

* Removed tensorflow and keras and replaced with torch and torchvision.
* Added row and polygon annotations.

.. rubric:: Bugs

* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.
2 changes: 2 additions & 0 deletions docs/release_notes/index.rst
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
Release Notes
===================================================

.. include:: 1.4.0.rst

.. include:: 1.3.0.rst

.. include:: 1.2.2.rst
Expand Down
23 changes: 13 additions & 10 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "stlearn"
version = "1.3.0"
version = "1.4.0"
authors = [
{ name = "Genomics and Machine Learning Lab", email = "andrew.newman@uq.edu.au" },
]
Expand All@@ -13,24 +13,27 @@ readme = { file = "README.md", content-type = "text/markdown" }
license = { text = "BSD license" }
requires-python = ">=3.12"
dependencies = [
"anndata>=0.10.0,<0.12",
"anndata>=0.12.0",
"bokeh>=3.7.0,<4.0",
"click>=8.2.0,<9.0",
"igraph>=1.0.0",
"leidenalg>=0.11.0",
"numba>=0.58.1",
"numpy>=1.26.0",
"numpy>=2.4.0",
"pillow>=11.0.0,<12.0",
"scanpy>=1.11.0,<2.0",
"scanpy>=1.12.0",
"scikit-image>=0.22.0",
"tensorflow>=2.14.1",
"keras>=2.14.0",
"pandas>=2.3.0",
"imageio>=2.37.0,<3.0",
"scipy>=1.11.0,<2.0",
"scikit-learn>=1.7.0,<2.0",
"spatialdata>=0.2.5,<0.3",
"spatialdata-io>=0.1.5,<0.2",
"scipy>=1.17.0,<2.0",
"scikit-learn>=1.8.0,<2.0",
"zarr>=3.1",
"dask>=2024.11.2",
"spatialdata>=0.7.0",
"spatialdata-io>=0.6.0",
"spatialdata-plot>=0.3.0",
"torch>=2.0",
"torchvision>=0.15",
"geopandas>=1.0.0,<2.0",
"shapely>=2.0.0,<3.0",
]
Expand Down
8 changes: 0 additions & 8 deletions stlearn/__main__.py

This file was deleted.

4 changes: 4 additions & 0 deletions stlearn/add.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
from .adds.labels import labels
from .adds.lr import lr
from .adds.parsing import parsing
from .adds.polygon_annotations import polygon_annotations
from .adds.positions import positions
from .adds.row_annotations import row_annotations

__all__ = [
"image",
Expand All@@ -19,4 +21,6 @@
"add_mask",
"apply_mask",
"add_loupe_clusters",
"row_annotations",
"polygon_annotations",
]
12 changes: 3 additions & 9 deletions stlearn/adds/polygon_annotations.py
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
from pathlib import Path

import geopandas as gpd
import spatialdata.models as models

from stlearn._compat import get_adata, is_spatial_data

Expand DownExpand Up@@ -46,18 +47,11 @@ def polygon_annotations(

# If SpatialData, also store the polygons as a shapes element
if is_spatial_data(data):
import spatialdata.models as models

parsed = models.ShapesModel.parse(annotations)
data.shapes[obs_key] = parsed
data.tables[table_key] = adata

n_annotated = adata.obs[obs_key].notna().sum()
print(
f"Added polygon annotations to adata.obs['{obs_key}']: "
f"{n_annotated}/{adata.n_obs} cells/spots annotated"
)

if is_spatial_data(data):
return data
return adata if copy else None
else:
return adata if copy else None
85 changes: 69 additions & 16 deletions stlearn/adds/row_annotations.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

import pandas as pd
from anndata import AnnData
from pandas import DataFrame


def row_annotations(
Expand DownExpand Up@@ -40,12 +41,78 @@ def row_annotations(
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
merged = annotations.reindex(adata.obs_names)

added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

return adata if copy else None


def row_annotations_proportions(
adata: AnnData,
annotations: pd.DataFrame | str | Path,
proportion_column_name: str = "cell_type",
join_column: str | None = None,
columns: list[str] | None = None,
copy: bool = False,
) -> AnnData | None:
"""\
Add annotations to adata.obs by joining on cell/spot identifiers and then
assuming that the values are cell proportions picking the highest proportion.

Merges a DataFrame (or CSV file) into adata.obs based on a
shared index or column. Useful for adding metadata such as
manual labels, clinical annotations, or external classifications.

Parameters
----------
adata
Annotated data matrix.
annotations
DataFrame or path to a CSV/TSV file containing annotations.
proportion_column_name, default =
The column name to use to add the high proprotion value to
join_column
Column in annotations to join on. If None, uses the
DataFrame index. The join is always against adata.obs_names.
columns
Subset of columns to add. If None, adds all columns
(excluding join_column).
copy
Return a copy instead of writing to adata.

Returns
-------
Depending on `copy`, returns or updates `adata` with new
columns added to `adata.obs`.
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
annotations = annotations.astype("float64")
labels = annotations.idxmax(axis=1)
adata.obs[proportion_column_name] = labels

return adata if copy else None


def _read_annotations(
annotations: DataFrame | str | Path,
columns: list[str] | None,
join_column: str | None,
) -> DataFrame:
if isinstance(annotations, (str, Path)):
path = Path(annotations)
sep = "\t" if path.suffix in (".tsv", ".txt") else ","
annotations = pd.read_csv(path, sep=sep)

if join_column is not None:
if join_column is None:
annotations = annotations.set_index(annotations.columns[0])
else:
if join_column not in annotations.columns:
raise ValueError(
f"Column '{join_column}' not found. "
Expand All@@ -58,18 +125,4 @@ def row_annotations(
if missing:
raise ValueError(f"Columns not found: {missing}")
annotations = annotations[columns]

merged = annotations.reindex(adata.obs_names)

n_matched = merged.notna().any(axis=1).sum()
added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

print(
f"Added {len(added_cols)} column(s) to adata.obs: {added_cols}. "
f"{n_matched}/{adata.n_obs} cells/spots matched."
)

return adata if copy else None
return annotations
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/python-package.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,9 @@ jobs:
python-version: [ "3.12", "3.13", "3.14" ]

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v6
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
Expand Down
9 changes: 9 additions & 0 deletions HISTORY.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,15 @@
History
=======

1.4.0 (2026-05-01)
------------------
* Removed tensorflow and keras and replaced with torch and torchvision.
* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.

API and Bug Fixes:
* Added row and polygon annotations.

1.3.0 (2026-02-24)
------------------
* Removed interactive stLearn/embedded web application.
Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,8 @@ undissociated tissue sample.
Latest Additions
----------------

.. include:: release_notes/1.4.0.rst

.. include:: release_notes/1.3.0.rst

.. include:: release_notes/1.2.2.rst
Expand Down
12 changes: 12 additions & 0 deletions docs/release_notes/1.4.0.rst
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1.4.0 `2026-05-01`
~~~~~~~~~~~~~~~~~~~~~~~~~

.. rubric:: Features

* Removed tensorflow and keras and replaced with torch and torchvision.
* Added row and polygon annotations.

.. rubric:: Bugs

* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.
2 changes: 2 additions & 0 deletions docs/release_notes/index.rst
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
Release Notes
===================================================

.. include:: 1.4.0.rst

.. include:: 1.3.0.rst

.. include:: 1.2.2.rst
Expand Down
23 changes: 13 additions & 10 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "stlearn"
version = "1.3.0"
version = "1.4.0"
authors = [
{ name = "Genomics and Machine Learning Lab", email = "andrew.newman@uq.edu.au" },
]
Expand All@@ -13,24 +13,27 @@ readme = { file = "README.md", content-type = "text/markdown" }
license = { text = "BSD license" }
requires-python = ">=3.12"
dependencies = [
"anndata>=0.10.0,<0.12",
"anndata>=0.12.0",
"bokeh>=3.7.0,<4.0",
"click>=8.2.0,<9.0",
"igraph>=1.0.0",
"leidenalg>=0.11.0",
"numba>=0.58.1",
"numpy>=1.26.0",
"numpy>=2.4.0",
"pillow>=11.0.0,<12.0",
"scanpy>=1.11.0,<2.0",
"scanpy>=1.12.0",
"scikit-image>=0.22.0",
"tensorflow>=2.14.1",
"keras>=2.14.0",
"pandas>=2.3.0",
"imageio>=2.37.0,<3.0",
"scipy>=1.11.0,<2.0",
"scikit-learn>=1.7.0,<2.0",
"spatialdata>=0.2.5,<0.3",
"spatialdata-io>=0.1.5,<0.2",
"scipy>=1.17.0,<2.0",
"scikit-learn>=1.8.0,<2.0",
"zarr>=3.1",
"dask>=2024.11.2",
"spatialdata>=0.7.0",
"spatialdata-io>=0.6.0",
"spatialdata-plot>=0.3.0",
"torch>=2.0",
"torchvision>=0.15",
"geopandas>=1.0.0,<2.0",
"shapely>=2.0.0,<3.0",
]
Expand Down
8 changes: 0 additions & 8 deletions stlearn/__main__.py

This file was deleted.

4 changes: 4 additions & 0 deletions stlearn/add.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
from .adds.labels import labels
from .adds.lr import lr
from .adds.parsing import parsing
from .adds.polygon_annotations import polygon_annotations
from .adds.positions import positions
from .adds.row_annotations import row_annotations

__all__ = [
"image",
Expand All@@ -19,4 +21,6 @@
"add_mask",
"apply_mask",
"add_loupe_clusters",
"row_annotations",
"polygon_annotations",
]
12 changes: 3 additions & 9 deletions stlearn/adds/polygon_annotations.py
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
from pathlib import Path

import geopandas as gpd
import spatialdata.models as models

from stlearn._compat import get_adata, is_spatial_data

Expand DownExpand Up@@ -46,18 +47,11 @@ def polygon_annotations(

# If SpatialData, also store the polygons as a shapes element
if is_spatial_data(data):
import spatialdata.models as models

parsed = models.ShapesModel.parse(annotations)
data.shapes[obs_key] = parsed
data.tables[table_key] = adata

n_annotated = adata.obs[obs_key].notna().sum()
print(
f"Added polygon annotations to adata.obs['{obs_key}']: "
f"{n_annotated}/{adata.n_obs} cells/spots annotated"
)

if is_spatial_data(data):
return data
return adata if copy else None
else:
return adata if copy else None
85 changes: 69 additions & 16 deletions stlearn/adds/row_annotations.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

import pandas as pd
from anndata import AnnData
from pandas import DataFrame


def row_annotations(
Expand DownExpand Up@@ -40,12 +41,78 @@ def row_annotations(
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
merged = annotations.reindex(adata.obs_names)

added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

return adata if copy else None


def row_annotations_proportions(
adata: AnnData,
annotations: pd.DataFrame | str | Path,
proportion_column_name: str = "cell_type",
join_column: str | None = None,
columns: list[str] | None = None,
copy: bool = False,
) -> AnnData | None:
"""\
Add annotations to adata.obs by joining on cell/spot identifiers and then
assuming that the values are cell proportions picking the highest proportion.

Merges a DataFrame (or CSV file) into adata.obs based on a
shared index or column. Useful for adding metadata such as
manual labels, clinical annotations, or external classifications.

Parameters
----------
adata
Annotated data matrix.
annotations
DataFrame or path to a CSV/TSV file containing annotations.
proportion_column_name, default =
The column name to use to add the high proprotion value to
join_column
Column in annotations to join on. If None, uses the
DataFrame index. The join is always against adata.obs_names.
columns
Subset of columns to add. If None, adds all columns
(excluding join_column).
copy
Return a copy instead of writing to adata.

Returns
-------
Depending on `copy`, returns or updates `adata` with new
columns added to `adata.obs`.
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
annotations = annotations.astype("float64")
labels = annotations.idxmax(axis=1)
adata.obs[proportion_column_name] = labels

return adata if copy else None


def _read_annotations(
annotations: DataFrame | str | Path,
columns: list[str] | None,
join_column: str | None,
) -> DataFrame:
if isinstance(annotations, (str, Path)):
path = Path(annotations)
sep = "\t" if path.suffix in (".tsv", ".txt") else ","
annotations = pd.read_csv(path, sep=sep)

if join_column is not None:
if join_column is None:
annotations = annotations.set_index(annotations.columns[0])
else:
if join_column not in annotations.columns:
raise ValueError(
f"Column '{join_column}' not found. "
Expand All@@ -58,18 +125,4 @@ def row_annotations(
if missing:
raise ValueError(f"Columns not found: {missing}")
annotations = annotations[columns]

merged = annotations.reindex(adata.obs_names)

n_matched = merged.notna().any(axis=1).sum()
added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

print(
f"Added {len(added_cols)} column(s) to adata.obs: {added_cols}. "
f"{n_matched}/{adata.n_obs} cells/spots matched."
)

return adata if copy else None
return annotations
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/python-package.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,9 @@ jobs:
python-version: [ "3.12", "3.13", "3.14" ]

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v6
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
Expand Down
9 changes: 9 additions & 0 deletions HISTORY.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,15 @@
History
=======

1.4.0 (2026-05-01)
------------------
* Removed tensorflow and keras and replaced with torch and torchvision.
* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.

API and Bug Fixes:
* Added row and polygon annotations.

1.3.0 (2026-02-24)
------------------
* Removed interactive stLearn/embedded web application.
Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,8 @@ undissociated tissue sample.
Latest Additions
----------------

.. include:: release_notes/1.4.0.rst

.. include:: release_notes/1.3.0.rst

.. include:: release_notes/1.2.2.rst
Expand Down
12 changes: 12 additions & 0 deletions docs/release_notes/1.4.0.rst
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1.4.0 `2026-05-01`
~~~~~~~~~~~~~~~~~~~~~~~~~

.. rubric:: Features

* Removed tensorflow and keras and replaced with torch and torchvision.
* Added row and polygon annotations.

.. rubric:: Bugs

* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.
2 changes: 2 additions & 0 deletions docs/release_notes/index.rst
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
Release Notes
===================================================

.. include:: 1.4.0.rst

.. include:: 1.3.0.rst

.. include:: 1.2.2.rst
Expand Down
23 changes: 13 additions & 10 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "stlearn"
version = "1.3.0"
version = "1.4.0"
authors = [
{ name = "Genomics and Machine Learning Lab", email = "andrew.newman@uq.edu.au" },
]
Expand All@@ -13,24 +13,27 @@ readme = { file = "README.md", content-type = "text/markdown" }
license = { text = "BSD license" }
requires-python = ">=3.12"
dependencies = [
"anndata>=0.10.0,<0.12",
"anndata>=0.12.0",
"bokeh>=3.7.0,<4.0",
"click>=8.2.0,<9.0",
"igraph>=1.0.0",
"leidenalg>=0.11.0",
"numba>=0.58.1",
"numpy>=1.26.0",
"numpy>=2.4.0",
"pillow>=11.0.0,<12.0",
"scanpy>=1.11.0,<2.0",
"scanpy>=1.12.0",
"scikit-image>=0.22.0",
"tensorflow>=2.14.1",
"keras>=2.14.0",
"pandas>=2.3.0",
"imageio>=2.37.0,<3.0",
"scipy>=1.11.0,<2.0",
"scikit-learn>=1.7.0,<2.0",
"spatialdata>=0.2.5,<0.3",
"spatialdata-io>=0.1.5,<0.2",
"scipy>=1.17.0,<2.0",
"scikit-learn>=1.8.0,<2.0",
"zarr>=3.1",
"dask>=2024.11.2",
"spatialdata>=0.7.0",
"spatialdata-io>=0.6.0",
"spatialdata-plot>=0.3.0",
"torch>=2.0",
"torchvision>=0.15",
"geopandas>=1.0.0,<2.0",
"shapely>=2.0.0,<3.0",
]
Expand Down
8 changes: 0 additions & 8 deletions stlearn/__main__.py

This file was deleted.

4 changes: 4 additions & 0 deletions stlearn/add.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
from .adds.labels import labels
from .adds.lr import lr
from .adds.parsing import parsing
from .adds.polygon_annotations import polygon_annotations
from .adds.positions import positions
from .adds.row_annotations import row_annotations

__all__ = [
"image",
Expand All@@ -19,4 +21,6 @@
"add_mask",
"apply_mask",
"add_loupe_clusters",
"row_annotations",
"polygon_annotations",
]
12 changes: 3 additions & 9 deletions stlearn/adds/polygon_annotations.py
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
from pathlib import Path

import geopandas as gpd
import spatialdata.models as models

from stlearn._compat import get_adata, is_spatial_data

Expand DownExpand Up@@ -46,18 +47,11 @@ def polygon_annotations(

# If SpatialData, also store the polygons as a shapes element
if is_spatial_data(data):
import spatialdata.models as models

parsed = models.ShapesModel.parse(annotations)
data.shapes[obs_key] = parsed
data.tables[table_key] = adata

n_annotated = adata.obs[obs_key].notna().sum()
print(
f"Added polygon annotations to adata.obs['{obs_key}']: "
f"{n_annotated}/{adata.n_obs} cells/spots annotated"
)

if is_spatial_data(data):
return data
return adata if copy else None
else:
return adata if copy else None
85 changes: 69 additions & 16 deletions stlearn/adds/row_annotations.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

import pandas as pd
from anndata import AnnData
from pandas import DataFrame


def row_annotations(
Expand DownExpand Up@@ -40,12 +41,78 @@ def row_annotations(
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
merged = annotations.reindex(adata.obs_names)

added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

return adata if copy else None


def row_annotations_proportions(
adata: AnnData,
annotations: pd.DataFrame | str | Path,
proportion_column_name: str = "cell_type",
join_column: str | None = None,
columns: list[str] | None = None,
copy: bool = False,
) -> AnnData | None:
"""\
Add annotations to adata.obs by joining on cell/spot identifiers and then
assuming that the values are cell proportions picking the highest proportion.

Merges a DataFrame (or CSV file) into adata.obs based on a
shared index or column. Useful for adding metadata such as
manual labels, clinical annotations, or external classifications.

Parameters
----------
adata
Annotated data matrix.
annotations
DataFrame or path to a CSV/TSV file containing annotations.
proportion_column_name, default =
The column name to use to add the high proprotion value to
join_column
Column in annotations to join on. If None, uses the
DataFrame index. The join is always against adata.obs_names.
columns
Subset of columns to add. If None, adds all columns
(excluding join_column).
copy
Return a copy instead of writing to adata.

Returns
-------
Depending on `copy`, returns or updates `adata` with new
columns added to `adata.obs`.
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
annotations = annotations.astype("float64")
labels = annotations.idxmax(axis=1)
adata.obs[proportion_column_name] = labels

return adata if copy else None


def _read_annotations(
annotations: DataFrame | str | Path,
columns: list[str] | None,
join_column: str | None,
) -> DataFrame:
if isinstance(annotations, (str, Path)):
path = Path(annotations)
sep = "\t" if path.suffix in (".tsv", ".txt") else ","
annotations = pd.read_csv(path, sep=sep)

if join_column is not None:
if join_column is None:
annotations = annotations.set_index(annotations.columns[0])
else:
if join_column not in annotations.columns:
raise ValueError(
f"Column '{join_column}' not found. "
Expand All@@ -58,18 +125,4 @@ def row_annotations(
if missing:
raise ValueError(f"Columns not found: {missing}")
annotations = annotations[columns]

merged = annotations.reindex(adata.obs_names)

n_matched = merged.notna().any(axis=1).sum()
added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

print(
f"Added {len(added_cols)} column(s) to adata.obs: {added_cols}. "
f"{n_matched}/{adata.n_obs} cells/spots matched."
)

return adata if copy else None
return annotations
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/python-package.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,9 @@ jobs:
python-version: [ "3.12", "3.13", "3.14" ]

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v6
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
Expand Down
9 changes: 9 additions & 0 deletions HISTORY.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,15 @@
History
=======

1.4.0 (2026-05-01)
------------------
* Removed tensorflow and keras and replaced with torch and torchvision.
* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.

API and Bug Fixes:
* Added row and polygon annotations.

1.3.0 (2026-02-24)
------------------
* Removed interactive stLearn/embedded web application.
Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,8 @@ undissociated tissue sample.
Latest Additions
----------------

.. include:: release_notes/1.4.0.rst

.. include:: release_notes/1.3.0.rst

.. include:: release_notes/1.2.2.rst
Expand Down
12 changes: 12 additions & 0 deletions docs/release_notes/1.4.0.rst
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1.4.0 `2026-05-01`
~~~~~~~~~~~~~~~~~~~~~~~~~

.. rubric:: Features

* Removed tensorflow and keras and replaced with torch and torchvision.
* Added row and polygon annotations.

.. rubric:: Bugs

* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.
2 changes: 2 additions & 0 deletions docs/release_notes/index.rst
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
Release Notes
===================================================

.. include:: 1.4.0.rst

.. include:: 1.3.0.rst

.. include:: 1.2.2.rst
Expand Down
23 changes: 13 additions & 10 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "stlearn"
version = "1.3.0"
version = "1.4.0"
authors = [
{ name = "Genomics and Machine Learning Lab", email = "andrew.newman@uq.edu.au" },
]
Expand All@@ -13,24 +13,27 @@ readme = { file = "README.md", content-type = "text/markdown" }
license = { text = "BSD license" }
requires-python = ">=3.12"
dependencies = [
"anndata>=0.10.0,<0.12",
"anndata>=0.12.0",
"bokeh>=3.7.0,<4.0",
"click>=8.2.0,<9.0",
"igraph>=1.0.0",
"leidenalg>=0.11.0",
"numba>=0.58.1",
"numpy>=1.26.0",
"numpy>=2.4.0",
"pillow>=11.0.0,<12.0",
"scanpy>=1.11.0,<2.0",
"scanpy>=1.12.0",
"scikit-image>=0.22.0",
"tensorflow>=2.14.1",
"keras>=2.14.0",
"pandas>=2.3.0",
"imageio>=2.37.0,<3.0",
"scipy>=1.11.0,<2.0",
"scikit-learn>=1.7.0,<2.0",
"spatialdata>=0.2.5,<0.3",
"spatialdata-io>=0.1.5,<0.2",
"scipy>=1.17.0,<2.0",
"scikit-learn>=1.8.0,<2.0",
"zarr>=3.1",
"dask>=2024.11.2",
"spatialdata>=0.7.0",
"spatialdata-io>=0.6.0",
"spatialdata-plot>=0.3.0",
"torch>=2.0",
"torchvision>=0.15",
"geopandas>=1.0.0,<2.0",
"shapely>=2.0.0,<3.0",
]
Expand Down
8 changes: 0 additions & 8 deletions stlearn/__main__.py

This file was deleted.

4 changes: 4 additions & 0 deletions stlearn/add.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
from .adds.labels import labels
from .adds.lr import lr
from .adds.parsing import parsing
from .adds.polygon_annotations import polygon_annotations
from .adds.positions import positions
from .adds.row_annotations import row_annotations

__all__ = [
"image",
Expand All@@ -19,4 +21,6 @@
"add_mask",
"apply_mask",
"add_loupe_clusters",
"row_annotations",
"polygon_annotations",
]
12 changes: 3 additions & 9 deletions stlearn/adds/polygon_annotations.py
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
from pathlib import Path

import geopandas as gpd
import spatialdata.models as models

from stlearn._compat import get_adata, is_spatial_data

Expand DownExpand Up@@ -46,18 +47,11 @@ def polygon_annotations(

# If SpatialData, also store the polygons as a shapes element
if is_spatial_data(data):
import spatialdata.models as models

parsed = models.ShapesModel.parse(annotations)
data.shapes[obs_key] = parsed
data.tables[table_key] = adata

n_annotated = adata.obs[obs_key].notna().sum()
print(
f"Added polygon annotations to adata.obs['{obs_key}']: "
f"{n_annotated}/{adata.n_obs} cells/spots annotated"
)

if is_spatial_data(data):
return data
return adata if copy else None
else:
return adata if copy else None
85 changes: 69 additions & 16 deletions stlearn/adds/row_annotations.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

import pandas as pd
from anndata import AnnData
from pandas import DataFrame


def row_annotations(
Expand DownExpand Up@@ -40,12 +41,78 @@ def row_annotations(
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
merged = annotations.reindex(adata.obs_names)

added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

return adata if copy else None


def row_annotations_proportions(
adata: AnnData,
annotations: pd.DataFrame | str | Path,
proportion_column_name: str = "cell_type",
join_column: str | None = None,
columns: list[str] | None = None,
copy: bool = False,
) -> AnnData | None:
"""\
Add annotations to adata.obs by joining on cell/spot identifiers and then
assuming that the values are cell proportions picking the highest proportion.

Merges a DataFrame (or CSV file) into adata.obs based on a
shared index or column. Useful for adding metadata such as
manual labels, clinical annotations, or external classifications.

Parameters
----------
adata
Annotated data matrix.
annotations
DataFrame or path to a CSV/TSV file containing annotations.
proportion_column_name, default =
The column name to use to add the high proprotion value to
join_column
Column in annotations to join on. If None, uses the
DataFrame index. The join is always against adata.obs_names.
columns
Subset of columns to add. If None, adds all columns
(excluding join_column).
copy
Return a copy instead of writing to adata.

Returns
-------
Depending on `copy`, returns or updates `adata` with new
columns added to `adata.obs`.
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
annotations = annotations.astype("float64")
labels = annotations.idxmax(axis=1)
adata.obs[proportion_column_name] = labels

return adata if copy else None


def _read_annotations(
annotations: DataFrame | str | Path,
columns: list[str] | None,
join_column: str | None,
) -> DataFrame:
if isinstance(annotations, (str, Path)):
path = Path(annotations)
sep = "\t" if path.suffix in (".tsv", ".txt") else ","
annotations = pd.read_csv(path, sep=sep)

if join_column is not None:
if join_column is None:
annotations = annotations.set_index(annotations.columns[0])
else:
if join_column not in annotations.columns:
raise ValueError(
f"Column '{join_column}' not found. "
Expand All@@ -58,18 +125,4 @@ def row_annotations(
if missing:
raise ValueError(f"Columns not found: {missing}")
annotations = annotations[columns]

merged = annotations.reindex(adata.obs_names)

n_matched = merged.notna().any(axis=1).sum()
added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

print(
f"Added {len(added_cols)} column(s) to adata.obs: {added_cols}. "
f"{n_matched}/{adata.n_obs} cells/spots matched."
)

return adata if copy else None
return annotations
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/python-package.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,9 @@ jobs:
python-version: [ "3.12", "3.13", "3.14" ]

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v6
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
Expand Down
9 changes: 9 additions & 0 deletions HISTORY.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,15 @@
History
=======

1.4.0 (2026-05-01)
------------------
* Removed tensorflow and keras and replaced with torch and torchvision.
* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.

API and Bug Fixes:
* Added row and polygon annotations.

1.3.0 (2026-02-24)
------------------
* Removed interactive stLearn/embedded web application.
Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,8 @@ undissociated tissue sample.
Latest Additions
----------------

.. include:: release_notes/1.4.0.rst

.. include:: release_notes/1.3.0.rst

.. include:: release_notes/1.2.2.rst
Expand Down
12 changes: 12 additions & 0 deletions docs/release_notes/1.4.0.rst
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1.4.0 `2026-05-01`
~~~~~~~~~~~~~~~~~~~~~~~~~

.. rubric:: Features

* Removed tensorflow and keras and replaced with torch and torchvision.
* Added row and polygon annotations.

.. rubric:: Bugs

* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.
2 changes: 2 additions & 0 deletions docs/release_notes/index.rst
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
Release Notes
===================================================

.. include:: 1.4.0.rst

.. include:: 1.3.0.rst

.. include:: 1.2.2.rst
Expand Down
23 changes: 13 additions & 10 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "stlearn"
version = "1.3.0"
version = "1.4.0"
authors = [
{ name = "Genomics and Machine Learning Lab", email = "andrew.newman@uq.edu.au" },
]
Expand All@@ -13,24 +13,27 @@ readme = { file = "README.md", content-type = "text/markdown" }
license = { text = "BSD license" }
requires-python = ">=3.12"
dependencies = [
"anndata>=0.10.0,<0.12",
"anndata>=0.12.0",
"bokeh>=3.7.0,<4.0",
"click>=8.2.0,<9.0",
"igraph>=1.0.0",
"leidenalg>=0.11.0",
"numba>=0.58.1",
"numpy>=1.26.0",
"numpy>=2.4.0",
"pillow>=11.0.0,<12.0",
"scanpy>=1.11.0,<2.0",
"scanpy>=1.12.0",
"scikit-image>=0.22.0",
"tensorflow>=2.14.1",
"keras>=2.14.0",
"pandas>=2.3.0",
"imageio>=2.37.0,<3.0",
"scipy>=1.11.0,<2.0",
"scikit-learn>=1.7.0,<2.0",
"spatialdata>=0.2.5,<0.3",
"spatialdata-io>=0.1.5,<0.2",
"scipy>=1.17.0,<2.0",
"scikit-learn>=1.8.0,<2.0",
"zarr>=3.1",
"dask>=2024.11.2",
"spatialdata>=0.7.0",
"spatialdata-io>=0.6.0",
"spatialdata-plot>=0.3.0",
"torch>=2.0",
"torchvision>=0.15",
"geopandas>=1.0.0,<2.0",
"shapely>=2.0.0,<3.0",
]
Expand Down
8 changes: 0 additions & 8 deletions stlearn/__main__.py

This file was deleted.

4 changes: 4 additions & 0 deletions stlearn/add.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
from .adds.labels import labels
from .adds.lr import lr
from .adds.parsing import parsing
from .adds.polygon_annotations import polygon_annotations
from .adds.positions import positions
from .adds.row_annotations import row_annotations

__all__ = [
"image",
Expand All@@ -19,4 +21,6 @@
"add_mask",
"apply_mask",
"add_loupe_clusters",
"row_annotations",
"polygon_annotations",
]
12 changes: 3 additions & 9 deletions stlearn/adds/polygon_annotations.py
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
from pathlib import Path

import geopandas as gpd
import spatialdata.models as models

from stlearn._compat import get_adata, is_spatial_data

Expand DownExpand Up@@ -46,18 +47,11 @@ def polygon_annotations(

# If SpatialData, also store the polygons as a shapes element
if is_spatial_data(data):
import spatialdata.models as models

parsed = models.ShapesModel.parse(annotations)
data.shapes[obs_key] = parsed
data.tables[table_key] = adata

n_annotated = adata.obs[obs_key].notna().sum()
print(
f"Added polygon annotations to adata.obs['{obs_key}']: "
f"{n_annotated}/{adata.n_obs} cells/spots annotated"
)

if is_spatial_data(data):
return data
return adata if copy else None
else:
return adata if copy else None
85 changes: 69 additions & 16 deletions stlearn/adds/row_annotations.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

import pandas as pd
from anndata import AnnData
from pandas import DataFrame


def row_annotations(
Expand DownExpand Up@@ -40,12 +41,78 @@ def row_annotations(
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
merged = annotations.reindex(adata.obs_names)

added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

return adata if copy else None


def row_annotations_proportions(
adata: AnnData,
annotations: pd.DataFrame | str | Path,
proportion_column_name: str = "cell_type",
join_column: str | None = None,
columns: list[str] | None = None,
copy: bool = False,
) -> AnnData | None:
"""\
Add annotations to adata.obs by joining on cell/spot identifiers and then
assuming that the values are cell proportions picking the highest proportion.

Merges a DataFrame (or CSV file) into adata.obs based on a
shared index or column. Useful for adding metadata such as
manual labels, clinical annotations, or external classifications.

Parameters
----------
adata
Annotated data matrix.
annotations
DataFrame or path to a CSV/TSV file containing annotations.
proportion_column_name, default =
The column name to use to add the high proprotion value to
join_column
Column in annotations to join on. If None, uses the
DataFrame index. The join is always against adata.obs_names.
columns
Subset of columns to add. If None, adds all columns
(excluding join_column).
copy
Return a copy instead of writing to adata.

Returns
-------
Depending on `copy`, returns or updates `adata` with new
columns added to `adata.obs`.
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
annotations = annotations.astype("float64")
labels = annotations.idxmax(axis=1)
adata.obs[proportion_column_name] = labels

return adata if copy else None


def _read_annotations(
annotations: DataFrame | str | Path,
columns: list[str] | None,
join_column: str | None,
) -> DataFrame:
if isinstance(annotations, (str, Path)):
path = Path(annotations)
sep = "\t" if path.suffix in (".tsv", ".txt") else ","
annotations = pd.read_csv(path, sep=sep)

if join_column is not None:
if join_column is None:
annotations = annotations.set_index(annotations.columns[0])
else:
if join_column not in annotations.columns:
raise ValueError(
f"Column '{join_column}' not found. "
Expand All@@ -58,18 +125,4 @@ def row_annotations(
if missing:
raise ValueError(f"Columns not found: {missing}")
annotations = annotations[columns]

merged = annotations.reindex(adata.obs_names)

n_matched = merged.notna().any(axis=1).sum()
added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

print(
f"Added {len(added_cols)} column(s) to adata.obs: {added_cols}. "
f"{n_matched}/{adata.n_obs} cells/spots matched."
)

return adata if copy else None
return annotations
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/python-package.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,9 @@ jobs:
python-version: [ "3.12", "3.13", "3.14" ]

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v6
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
Expand Down
9 changes: 9 additions & 0 deletions HISTORY.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,15 @@
History
=======

1.4.0 (2026-05-01)
------------------
* Removed tensorflow and keras and replaced with torch and torchvision.
* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.

API and Bug Fixes:
* Added row and polygon annotations.

1.3.0 (2026-02-24)
------------------
* Removed interactive stLearn/embedded web application.
Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,8 @@ undissociated tissue sample.
Latest Additions
----------------

.. include:: release_notes/1.4.0.rst

.. include:: release_notes/1.3.0.rst

.. include:: release_notes/1.2.2.rst
Expand Down
12 changes: 12 additions & 0 deletions docs/release_notes/1.4.0.rst
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1.4.0 `2026-05-01`
~~~~~~~~~~~~~~~~~~~~~~~~~

.. rubric:: Features

* Removed tensorflow and keras and replaced with torch and torchvision.
* Added row and polygon annotations.

.. rubric:: Bugs

* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.
2 changes: 2 additions & 0 deletions docs/release_notes/index.rst
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
Release Notes
===================================================

.. include:: 1.4.0.rst

.. include:: 1.3.0.rst

.. include:: 1.2.2.rst
Expand Down
23 changes: 13 additions & 10 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "stlearn"
version = "1.3.0"
version = "1.4.0"
authors = [
{ name = "Genomics and Machine Learning Lab", email = "andrew.newman@uq.edu.au" },
]
Expand All@@ -13,24 +13,27 @@ readme = { file = "README.md", content-type = "text/markdown" }
license = { text = "BSD license" }
requires-python = ">=3.12"
dependencies = [
"anndata>=0.10.0,<0.12",
"anndata>=0.12.0",
"bokeh>=3.7.0,<4.0",
"click>=8.2.0,<9.0",
"igraph>=1.0.0",
"leidenalg>=0.11.0",
"numba>=0.58.1",
"numpy>=1.26.0",
"numpy>=2.4.0",
"pillow>=11.0.0,<12.0",
"scanpy>=1.11.0,<2.0",
"scanpy>=1.12.0",
"scikit-image>=0.22.0",
"tensorflow>=2.14.1",
"keras>=2.14.0",
"pandas>=2.3.0",
"imageio>=2.37.0,<3.0",
"scipy>=1.11.0,<2.0",
"scikit-learn>=1.7.0,<2.0",
"spatialdata>=0.2.5,<0.3",
"spatialdata-io>=0.1.5,<0.2",
"scipy>=1.17.0,<2.0",
"scikit-learn>=1.8.0,<2.0",
"zarr>=3.1",
"dask>=2024.11.2",
"spatialdata>=0.7.0",
"spatialdata-io>=0.6.0",
"spatialdata-plot>=0.3.0",
"torch>=2.0",
"torchvision>=0.15",
"geopandas>=1.0.0,<2.0",
"shapely>=2.0.0,<3.0",
]
Expand Down
8 changes: 0 additions & 8 deletions stlearn/__main__.py

This file was deleted.

4 changes: 4 additions & 0 deletions stlearn/add.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
from .adds.labels import labels
from .adds.lr import lr
from .adds.parsing import parsing
from .adds.polygon_annotations import polygon_annotations
from .adds.positions import positions
from .adds.row_annotations import row_annotations

__all__ = [
"image",
Expand All@@ -19,4 +21,6 @@
"add_mask",
"apply_mask",
"add_loupe_clusters",
"row_annotations",
"polygon_annotations",
]
12 changes: 3 additions & 9 deletions stlearn/adds/polygon_annotations.py
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
from pathlib import Path

import geopandas as gpd
import spatialdata.models as models

from stlearn._compat import get_adata, is_spatial_data

Expand DownExpand Up@@ -46,18 +47,11 @@ def polygon_annotations(

# If SpatialData, also store the polygons as a shapes element
if is_spatial_data(data):
import spatialdata.models as models

parsed = models.ShapesModel.parse(annotations)
data.shapes[obs_key] = parsed
data.tables[table_key] = adata

n_annotated = adata.obs[obs_key].notna().sum()
print(
f"Added polygon annotations to adata.obs['{obs_key}']: "
f"{n_annotated}/{adata.n_obs} cells/spots annotated"
)

if is_spatial_data(data):
return data
return adata if copy else None
else:
return adata if copy else None
85 changes: 69 additions & 16 deletions stlearn/adds/row_annotations.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

import pandas as pd
from anndata import AnnData
from pandas import DataFrame


def row_annotations(
Expand DownExpand Up@@ -40,12 +41,78 @@ def row_annotations(
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
merged = annotations.reindex(adata.obs_names)

added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

return adata if copy else None


def row_annotations_proportions(
adata: AnnData,
annotations: pd.DataFrame | str | Path,
proportion_column_name: str = "cell_type",
join_column: str | None = None,
columns: list[str] | None = None,
copy: bool = False,
) -> AnnData | None:
"""\
Add annotations to adata.obs by joining on cell/spot identifiers and then
assuming that the values are cell proportions picking the highest proportion.

Merges a DataFrame (or CSV file) into adata.obs based on a
shared index or column. Useful for adding metadata such as
manual labels, clinical annotations, or external classifications.

Parameters
----------
adata
Annotated data matrix.
annotations
DataFrame or path to a CSV/TSV file containing annotations.
proportion_column_name, default =
The column name to use to add the high proprotion value to
join_column
Column in annotations to join on. If None, uses the
DataFrame index. The join is always against adata.obs_names.
columns
Subset of columns to add. If None, adds all columns
(excluding join_column).
copy
Return a copy instead of writing to adata.

Returns
-------
Depending on `copy`, returns or updates `adata` with new
columns added to `adata.obs`.
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
annotations = annotations.astype("float64")
labels = annotations.idxmax(axis=1)
adata.obs[proportion_column_name] = labels

return adata if copy else None


def _read_annotations(
annotations: DataFrame | str | Path,
columns: list[str] | None,
join_column: str | None,
) -> DataFrame:
if isinstance(annotations, (str, Path)):
path = Path(annotations)
sep = "\t" if path.suffix in (".tsv", ".txt") else ","
annotations = pd.read_csv(path, sep=sep)

if join_column is not None:
if join_column is None:
annotations = annotations.set_index(annotations.columns[0])
else:
if join_column not in annotations.columns:
raise ValueError(
f"Column '{join_column}' not found. "
Expand All@@ -58,18 +125,4 @@ def row_annotations(
if missing:
raise ValueError(f"Columns not found: {missing}")
annotations = annotations[columns]

merged = annotations.reindex(adata.obs_names)

n_matched = merged.notna().any(axis=1).sum()
added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

print(
f"Added {len(added_cols)} column(s) to adata.obs: {added_cols}. "
f"{n_matched}/{adata.n_obs} cells/spots matched."
)

return adata if copy else None
return annotations
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/python-package.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,9 +19,9 @@ jobs:
python-version: [ "3.12", "3.13", "3.14" ]

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v6
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
Expand Down
9 changes: 9 additions & 0 deletions HISTORY.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,15 @@
History
=======

1.4.0 (2026-05-01)
------------------
* Removed tensorflow and keras and replaced with torch and torchvision.
* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.

API and Bug Fixes:
* Added row and polygon annotations.

1.3.0 (2026-02-24)
------------------
* Removed interactive stLearn/embedded web application.
Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,8 @@ undissociated tissue sample.
Latest Additions
----------------

.. include:: release_notes/1.4.0.rst

.. include:: release_notes/1.3.0.rst

.. include:: release_notes/1.2.2.rst
Expand Down
12 changes: 12 additions & 0 deletions docs/release_notes/1.4.0.rst
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1.4.0 `2026-05-01`
~~~~~~~~~~~~~~~~~~~~~~~~~

.. rubric:: Features

* Removed tensorflow and keras and replaced with torch and torchvision.
* Added row and polygon annotations.

.. rubric:: Bugs

* Refactor of CCI implementation to removed string comparison for LR pairs lists and replaced with one set of two
packed 32 bit integers. Removed deduplication pass m^2 pass with a hash lookup.
2 changes: 2 additions & 0 deletions docs/release_notes/index.rst
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
Release Notes
===================================================

.. include:: 1.4.0.rst

.. include:: 1.3.0.rst

.. include:: 1.2.2.rst
Expand Down
23 changes: 13 additions & 10 deletions pyproject.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "stlearn"
version = "1.3.0"
version = "1.4.0"
authors = [
{ name = "Genomics and Machine Learning Lab", email = "andrew.newman@uq.edu.au" },
]
Expand All@@ -13,24 +13,27 @@ readme = { file = "README.md", content-type = "text/markdown" }
license = { text = "BSD license" }
requires-python = ">=3.12"
dependencies = [
"anndata>=0.10.0,<0.12",
"anndata>=0.12.0",
"bokeh>=3.7.0,<4.0",
"click>=8.2.0,<9.0",
"igraph>=1.0.0",
"leidenalg>=0.11.0",
"numba>=0.58.1",
"numpy>=1.26.0",
"numpy>=2.4.0",
"pillow>=11.0.0,<12.0",
"scanpy>=1.11.0,<2.0",
"scanpy>=1.12.0",
"scikit-image>=0.22.0",
"tensorflow>=2.14.1",
"keras>=2.14.0",
"pandas>=2.3.0",
"imageio>=2.37.0,<3.0",
"scipy>=1.11.0,<2.0",
"scikit-learn>=1.7.0,<2.0",
"spatialdata>=0.2.5,<0.3",
"spatialdata-io>=0.1.5,<0.2",
"scipy>=1.17.0,<2.0",
"scikit-learn>=1.8.0,<2.0",
"zarr>=3.1",
"dask>=2024.11.2",
"spatialdata>=0.7.0",
"spatialdata-io>=0.6.0",
"spatialdata-plot>=0.3.0",
"torch>=2.0",
"torchvision>=0.15",
"geopandas>=1.0.0,<2.0",
"shapely>=2.0.0,<3.0",
]
Expand Down
8 changes: 0 additions & 8 deletions stlearn/__main__.py

This file was deleted.

4 changes: 4 additions & 0 deletions stlearn/add.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
from .adds.labels import labels
from .adds.lr import lr
from .adds.parsing import parsing
from .adds.polygon_annotations import polygon_annotations
from .adds.positions import positions
from .adds.row_annotations import row_annotations

__all__ = [
"image",
Expand All@@ -19,4 +21,6 @@
"add_mask",
"apply_mask",
"add_loupe_clusters",
"row_annotations",
"polygon_annotations",
]
12 changes: 3 additions & 9 deletions stlearn/adds/polygon_annotations.py
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
from pathlib import Path

import geopandas as gpd
import spatialdata.models as models

from stlearn._compat import get_adata, is_spatial_data

Expand DownExpand Up@@ -46,18 +47,11 @@ def polygon_annotations(

# If SpatialData, also store the polygons as a shapes element
if is_spatial_data(data):
import spatialdata.models as models

parsed = models.ShapesModel.parse(annotations)
data.shapes[obs_key] = parsed
data.tables[table_key] = adata

n_annotated = adata.obs[obs_key].notna().sum()
print(
f"Added polygon annotations to adata.obs['{obs_key}']: "
f"{n_annotated}/{adata.n_obs} cells/spots annotated"
)

if is_spatial_data(data):
return data
return adata if copy else None
else:
return adata if copy else None
85 changes: 69 additions & 16 deletions stlearn/adds/row_annotations.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

import pandas as pd
from anndata import AnnData
from pandas import DataFrame


def row_annotations(
Expand DownExpand Up@@ -40,12 +41,78 @@ def row_annotations(
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
merged = annotations.reindex(adata.obs_names)

added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

return adata if copy else None


def row_annotations_proportions(
adata: AnnData,
annotations: pd.DataFrame | str | Path,
proportion_column_name: str = "cell_type",
join_column: str | None = None,
columns: list[str] | None = None,
copy: bool = False,
) -> AnnData | None:
"""\
Add annotations to adata.obs by joining on cell/spot identifiers and then
assuming that the values are cell proportions picking the highest proportion.

Merges a DataFrame (or CSV file) into adata.obs based on a
shared index or column. Useful for adding metadata such as
manual labels, clinical annotations, or external classifications.

Parameters
----------
adata
Annotated data matrix.
annotations
DataFrame or path to a CSV/TSV file containing annotations.
proportion_column_name, default =
The column name to use to add the high proprotion value to
join_column
Column in annotations to join on. If None, uses the
DataFrame index. The join is always against adata.obs_names.
columns
Subset of columns to add. If None, adds all columns
(excluding join_column).
copy
Return a copy instead of writing to adata.

Returns
-------
Depending on `copy`, returns or updates `adata` with new
columns added to `adata.obs`.
"""
adata = adata.copy() if copy else adata

annotations = _read_annotations(annotations, columns, join_column)
annotations = annotations.astype("float64")
labels = annotations.idxmax(axis=1)
adata.obs[proportion_column_name] = labels

return adata if copy else None


def _read_annotations(
annotations: DataFrame | str | Path,
columns: list[str] | None,
join_column: str | None,
) -> DataFrame:
if isinstance(annotations, (str, Path)):
path = Path(annotations)
sep = "\t" if path.suffix in (".tsv", ".txt") else ","
annotations = pd.read_csv(path, sep=sep)

if join_column is not None:
if join_column is None:
annotations = annotations.set_index(annotations.columns[0])
else:
if join_column not in annotations.columns:
raise ValueError(
f"Column '{join_column}' not found. "
Expand All@@ -58,18 +125,4 @@ def row_annotations(
if missing:
raise ValueError(f"Columns not found: {missing}")
annotations = annotations[columns]

merged = annotations.reindex(adata.obs_names)

n_matched = merged.notna().any(axis=1).sum()
added_cols = list(merged.columns)

for col in added_cols:
adata.obs[col] = merged[col].values

print(
f"Added {len(added_cols)} column(s) to adata.obs: {added_cols}. "
f"{n_matched}/{adata.n_obs} cells/spots matched."
)

return adata if copy else None
return annotations
Loading