Spaces:
Sleeping
Sleeping
Dylan Mann-Krzisnik commited on
Commit Β·
dee34fb
1
Parent(s): 8e2b525
Add GLUE remote MCP server
Browse files- Dockerfile +30 -0
- GLUE_Agent_mcp.py +40 -0
- requirements.txt +32 -0
- tools/__pycache__/preprocessing.cpython-310.pyc +0 -0
- tools/__pycache__/preprocessing.cpython-311.pyc +0 -0
- tools/__pycache__/training.cpython-310.pyc +0 -0
- tools/preprocessing.py +280 -0
- tools/preprocessing_implementation_log.md +209 -0
- tools/training.py +525 -0
- tools/training_summary.md +133 -0
Dockerfile
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
FROM python:3.12-slim
|
| 2 |
+
|
| 3 |
+
WORKDIR /app
|
| 4 |
+
|
| 5 |
+
# bedtools is required by pybedtools (used in scglue genomics)
|
| 6 |
+
RUN apt-get update && apt-get install -y --no-install-recommends \
|
| 7 |
+
bedtools \
|
| 8 |
+
build-essential \
|
| 9 |
+
git \
|
| 10 |
+
&& rm -rf /var/lib/apt/lists/*
|
| 11 |
+
|
| 12 |
+
COPY requirements.txt .
|
| 13 |
+
RUN pip install --no-cache-dir -r requirements.txt
|
| 14 |
+
|
| 15 |
+
# Copy server entry-point and tool modules from src/
|
| 16 |
+
COPY src/GLUE_Agent_mcp.py .
|
| 17 |
+
COPY src/tools/ tools/
|
| 18 |
+
|
| 19 |
+
# Redirect I/O to /data so outputs survive across requests and can use
|
| 20 |
+
# HF Spaces persistent storage if enabled
|
| 21 |
+
ENV PREPROCESSING_INPUT_DIR=/data/inputs
|
| 22 |
+
ENV PREPROCESSING_OUTPUT_DIR=/data/outputs
|
| 23 |
+
ENV TRAINING_INPUT_DIR=/data/inputs
|
| 24 |
+
ENV TRAINING_OUTPUT_DIR=/data/outputs
|
| 25 |
+
|
| 26 |
+
RUN mkdir -p /data/inputs /data/outputs
|
| 27 |
+
|
| 28 |
+
EXPOSE 7860
|
| 29 |
+
|
| 30 |
+
CMD ["uvicorn", "GLUE_Agent_mcp:app", "--host", "0.0.0.0", "--port", "7860"]
|
GLUE_Agent_mcp.py
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
"""
|
| 2 |
+
Model Context Protocol (MCP) for GLUE_Agent
|
| 3 |
+
|
| 4 |
+
GLUE_Agent provides comprehensive multi-omics data integration tools for single-cell RNA-seq and ATAC-seq analysis. This framework enables preprocessing, model training, and visualization of integrated multi-modal datasets.
|
| 5 |
+
|
| 6 |
+
This MCP Server contains tools extracted from the following tutorial files:
|
| 7 |
+
1. preprocessing
|
| 8 |
+
- glue_preprocess_scrna: Preprocess scRNA-seq data with HVG selection, normalization, and PCA
|
| 9 |
+
- glue_preprocess_scatac: Preprocess scATAC-seq data with LSI dimension reduction
|
| 10 |
+
- glue_construct_regulatory_graph: Construct prior regulatory graph linking RNA and ATAC features
|
| 11 |
+
2. training
|
| 12 |
+
- glue_configure_datasets: Configure RNA-seq and ATAC-seq datasets for GLUE model training
|
| 13 |
+
- glue_train_model: Train GLUE model for multi-omics integration
|
| 14 |
+
- glue_check_integration_consistency: Evaluate integration quality with consistency scores
|
| 15 |
+
- glue_generate_embeddings: Generate cell and feature embeddings from trained GLUE model
|
| 16 |
+
"""
|
| 17 |
+
|
| 18 |
+
import os
|
| 19 |
+
|
| 20 |
+
from fastmcp import FastMCP
|
| 21 |
+
|
| 22 |
+
# Import statements (alphabetical order)
|
| 23 |
+
from tools.preprocessing import preprocessing_mcp
|
| 24 |
+
from tools.training import training_mcp
|
| 25 |
+
|
| 26 |
+
# Server definition and mounting
|
| 27 |
+
mcp = FastMCP(name="GLUE_Agent")
|
| 28 |
+
mcp.mount(preprocessing_mcp)
|
| 29 |
+
mcp.mount(training_mcp)
|
| 30 |
+
|
| 31 |
+
# ASGI app for uvicorn (used when deployed as a remote HTTP server)
|
| 32 |
+
app = mcp.http_app(path="/mcp")
|
| 33 |
+
|
| 34 |
+
if __name__ == "__main__":
|
| 35 |
+
mcp.run(
|
| 36 |
+
transport="http",
|
| 37 |
+
host="0.0.0.0",
|
| 38 |
+
port=int(os.getenv("PORT", 7860)),
|
| 39 |
+
path="/mcp",
|
| 40 |
+
)
|
requirements.txt
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# MCP server & HTTP transport
|
| 2 |
+
fastmcp==2.14.5
|
| 3 |
+
uvicorn==0.40.0
|
| 4 |
+
fastapi
|
| 5 |
+
starlette==0.52.1
|
| 6 |
+
|
| 7 |
+
# Bioinformatics core
|
| 8 |
+
anndata==0.11.4
|
| 9 |
+
scanpy==1.11.5
|
| 10 |
+
scglue==0.4.0
|
| 11 |
+
|
| 12 |
+
# Graph / numerics
|
| 13 |
+
networkx==3.4.2
|
| 14 |
+
numpy==2.2.6
|
| 15 |
+
pandas==2.3.3
|
| 16 |
+
scipy==1.15.3
|
| 17 |
+
scikit-learn==1.7.2
|
| 18 |
+
|
| 19 |
+
# Plotting
|
| 20 |
+
matplotlib==3.10.8
|
| 21 |
+
seaborn==0.13.2
|
| 22 |
+
|
| 23 |
+
# scglue deep-learning backend
|
| 24 |
+
torch==2.10.0
|
| 25 |
+
pyro-ppl==1.9.1
|
| 26 |
+
|
| 27 |
+
# scglue genomics (requires bedtools system package)
|
| 28 |
+
pybedtools==0.12.0
|
| 29 |
+
|
| 30 |
+
# Utilities
|
| 31 |
+
tqdm==4.67.3
|
| 32 |
+
dill==0.4.1
|
tools/__pycache__/preprocessing.cpython-310.pyc
ADDED
|
Binary file (7.61 kB). View file
|
|
|
tools/__pycache__/preprocessing.cpython-311.pyc
ADDED
|
Binary file (13.6 kB). View file
|
|
|
tools/__pycache__/training.cpython-310.pyc
ADDED
|
Binary file (10.7 kB). View file
|
|
|
tools/preprocessing.py
ADDED
|
@@ -0,0 +1,280 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
"""
|
| 2 |
+
GLUE preprocessing tutorial for scRNA-seq and scATAC-seq data integration.
|
| 3 |
+
|
| 4 |
+
This MCP Server provides 3 tools:
|
| 5 |
+
1. glue_preprocess_scrna: Preprocess scRNA-seq data with HVG selection, normalization, and PCA
|
| 6 |
+
2. glue_preprocess_scatac: Preprocess scATAC-seq data with LSI dimension reduction
|
| 7 |
+
3. glue_construct_regulatory_graph: Construct prior regulatory graph linking RNA and ATAC features
|
| 8 |
+
|
| 9 |
+
All tools extracted from `gao-lab/GLUE/blob/master/docs/preprocessing.ipynb`.
|
| 10 |
+
"""
|
| 11 |
+
|
| 12 |
+
import os
|
| 13 |
+
from datetime import datetime
|
| 14 |
+
from pathlib import Path
|
| 15 |
+
# Standard imports
|
| 16 |
+
from typing import Annotated, Any, Literal
|
| 17 |
+
|
| 18 |
+
import anndata as ad
|
| 19 |
+
# Domain-specific imports
|
| 20 |
+
import matplotlib.pyplot as plt
|
| 21 |
+
import networkx as nx
|
| 22 |
+
import numpy as np
|
| 23 |
+
import pandas as pd
|
| 24 |
+
import scanpy as sc
|
| 25 |
+
import scglue
|
| 26 |
+
from fastmcp import FastMCP
|
| 27 |
+
from matplotlib import rcParams
|
| 28 |
+
|
| 29 |
+
# Project structure
|
| 30 |
+
PROJECT_ROOT = Path(__file__).parent.parent.parent.resolve()
|
| 31 |
+
DEFAULT_INPUT_DIR = PROJECT_ROOT / "tmp" / "inputs"
|
| 32 |
+
DEFAULT_OUTPUT_DIR = PROJECT_ROOT / "tmp" / "outputs"
|
| 33 |
+
|
| 34 |
+
INPUT_DIR = Path(os.environ.get("PREPROCESSING_INPUT_DIR", DEFAULT_INPUT_DIR))
|
| 35 |
+
OUTPUT_DIR = Path(os.environ.get("PREPROCESSING_OUTPUT_DIR", DEFAULT_OUTPUT_DIR))
|
| 36 |
+
|
| 37 |
+
# Ensure directories exist
|
| 38 |
+
INPUT_DIR.mkdir(parents=True, exist_ok=True)
|
| 39 |
+
OUTPUT_DIR.mkdir(parents=True, exist_ok=True)
|
| 40 |
+
|
| 41 |
+
# Timestamp for unique outputs
|
| 42 |
+
timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
|
| 43 |
+
|
| 44 |
+
# Set plotting parameters
|
| 45 |
+
plt.rcParams["figure.dpi"] = 300
|
| 46 |
+
plt.rcParams["savefig.dpi"] = 300
|
| 47 |
+
scglue.plot.set_publication_params()
|
| 48 |
+
rcParams["figure.figsize"] = (4, 4)
|
| 49 |
+
|
| 50 |
+
# MCP server instance
|
| 51 |
+
preprocessing_mcp = FastMCP(name="preprocessing")
|
| 52 |
+
|
| 53 |
+
|
| 54 |
+
@preprocessing_mcp.tool
|
| 55 |
+
def glue_preprocess_scrna(
|
| 56 |
+
rna_path: Annotated[
|
| 57 |
+
str | None, "Path to scRNA-seq data file in h5ad format"
|
| 58 |
+
] = None,
|
| 59 |
+
n_top_genes: Annotated[int, "Number of highly variable genes to select"] = 2000,
|
| 60 |
+
flavor: Annotated[
|
| 61 |
+
Literal["seurat", "cell_ranger", "seurat_v3"], "Method for HVG selection"
|
| 62 |
+
] = "seurat_v3",
|
| 63 |
+
n_comps: Annotated[int, "Number of principal components"] = 100,
|
| 64 |
+
svd_solver: Annotated[
|
| 65 |
+
Literal["auto", "arpack", "randomized"], "SVD solver for PCA"
|
| 66 |
+
] = "auto",
|
| 67 |
+
color_var: Annotated[str, "Variable name for UMAP coloring"] = "cell_type",
|
| 68 |
+
out_prefix: Annotated[str | None, "Output file prefix"] = None,
|
| 69 |
+
) -> dict:
|
| 70 |
+
"""
|
| 71 |
+
Preprocess scRNA-seq data with highly variable gene selection, normalization, scaling, and PCA.
|
| 72 |
+
Input is scRNA-seq data in h5ad format and output is preprocessed data with PCA embedding and UMAP visualization.
|
| 73 |
+
"""
|
| 74 |
+
# Input validation
|
| 75 |
+
if rna_path is None:
|
| 76 |
+
raise ValueError("Path to scRNA-seq data file must be provided")
|
| 77 |
+
|
| 78 |
+
# File existence validation
|
| 79 |
+
rna_file = Path(rna_path)
|
| 80 |
+
if not rna_file.exists():
|
| 81 |
+
raise FileNotFoundError(f"RNA data file not found: {rna_path}")
|
| 82 |
+
|
| 83 |
+
# Set output prefix
|
| 84 |
+
if out_prefix is None:
|
| 85 |
+
out_prefix = "glue_rna"
|
| 86 |
+
|
| 87 |
+
# Load data
|
| 88 |
+
rna = ad.read_h5ad(rna_path)
|
| 89 |
+
|
| 90 |
+
# Backup raw counts to "counts" layer
|
| 91 |
+
rna.layers["counts"] = rna.X.copy()
|
| 92 |
+
|
| 93 |
+
# Select highly variable genes
|
| 94 |
+
sc.pp.highly_variable_genes(rna, n_top_genes=n_top_genes, flavor=flavor)
|
| 95 |
+
|
| 96 |
+
# Normalize, log-transform, and scale
|
| 97 |
+
sc.pp.normalize_total(rna)
|
| 98 |
+
sc.pp.log1p(rna)
|
| 99 |
+
sc.pp.scale(rna)
|
| 100 |
+
|
| 101 |
+
# Perform PCA
|
| 102 |
+
sc.tl.pca(rna, n_comps=n_comps, svd_solver=svd_solver)
|
| 103 |
+
|
| 104 |
+
# Generate UMAP visualization
|
| 105 |
+
sc.pp.neighbors(rna, metric="cosine")
|
| 106 |
+
sc.tl.umap(rna)
|
| 107 |
+
|
| 108 |
+
# Save UMAP plot
|
| 109 |
+
fig_output = OUTPUT_DIR / f"{out_prefix}_umap_{timestamp}.png"
|
| 110 |
+
sc.pl.umap(rna, color=color_var, show=False)
|
| 111 |
+
plt.savefig(fig_output, dpi=300, bbox_inches="tight")
|
| 112 |
+
plt.close()
|
| 113 |
+
|
| 114 |
+
# Save preprocessed data
|
| 115 |
+
rna_output = OUTPUT_DIR / f"{out_prefix}_preprocessed_{timestamp}.h5ad"
|
| 116 |
+
rna.write(str(rna_output), compression="gzip")
|
| 117 |
+
|
| 118 |
+
return {
|
| 119 |
+
"message": f"Preprocessed RNA data: {n_top_genes} HVGs, {n_comps} PCs, UMAP generated",
|
| 120 |
+
"reference": "https://github.com/gao-lab/GLUE/blob/master/docs/preprocessing.ipynb",
|
| 121 |
+
"artifacts": [
|
| 122 |
+
{"description": "Preprocessed RNA data", "path": str(rna_output.resolve())},
|
| 123 |
+
{
|
| 124 |
+
"description": "RNA UMAP visualization",
|
| 125 |
+
"path": str(fig_output.resolve()),
|
| 126 |
+
},
|
| 127 |
+
],
|
| 128 |
+
}
|
| 129 |
+
|
| 130 |
+
|
| 131 |
+
@preprocessing_mcp.tool
|
| 132 |
+
def glue_preprocess_scatac(
|
| 133 |
+
atac_path: Annotated[
|
| 134 |
+
str | None, "Path to scATAC-seq data file in h5ad format"
|
| 135 |
+
] = None,
|
| 136 |
+
n_components: Annotated[int, "Number of LSI components"] = 100,
|
| 137 |
+
n_iter: Annotated[int, "Number of iterations for randomized SVD in LSI"] = 15,
|
| 138 |
+
color_var: Annotated[str, "Variable name for UMAP coloring"] = "cell_type",
|
| 139 |
+
out_prefix: Annotated[str | None, "Output file prefix"] = None,
|
| 140 |
+
) -> dict:
|
| 141 |
+
"""
|
| 142 |
+
Preprocess scATAC-seq data with latent semantic indexing (LSI) dimension reduction.
|
| 143 |
+
Input is scATAC-seq data in h5ad format and output is preprocessed data with LSI embedding and UMAP visualization.
|
| 144 |
+
"""
|
| 145 |
+
# Input validation
|
| 146 |
+
if atac_path is None:
|
| 147 |
+
raise ValueError("Path to scATAC-seq data file must be provided")
|
| 148 |
+
|
| 149 |
+
# File existence validation
|
| 150 |
+
atac_file = Path(atac_path)
|
| 151 |
+
if not atac_file.exists():
|
| 152 |
+
raise FileNotFoundError(f"ATAC data file not found: {atac_path}")
|
| 153 |
+
|
| 154 |
+
# Set output prefix
|
| 155 |
+
if out_prefix is None:
|
| 156 |
+
out_prefix = "glue_atac"
|
| 157 |
+
|
| 158 |
+
# Load data
|
| 159 |
+
atac = ad.read_h5ad(atac_path)
|
| 160 |
+
|
| 161 |
+
# Perform LSI dimension reduction
|
| 162 |
+
scglue.data.lsi(atac, n_components=n_components, n_iter=n_iter)
|
| 163 |
+
|
| 164 |
+
# Generate UMAP visualization
|
| 165 |
+
sc.pp.neighbors(atac, use_rep="X_lsi", metric="cosine")
|
| 166 |
+
sc.tl.umap(atac)
|
| 167 |
+
|
| 168 |
+
# Save UMAP plot
|
| 169 |
+
fig_output = OUTPUT_DIR / f"{out_prefix}_umap_{timestamp}.png"
|
| 170 |
+
sc.pl.umap(atac, color=color_var, show=False)
|
| 171 |
+
plt.savefig(fig_output, dpi=300, bbox_inches="tight")
|
| 172 |
+
plt.close()
|
| 173 |
+
|
| 174 |
+
# Save preprocessed data
|
| 175 |
+
atac_output = OUTPUT_DIR / f"{out_prefix}_preprocessed_{timestamp}.h5ad"
|
| 176 |
+
atac.write(str(atac_output), compression="gzip")
|
| 177 |
+
|
| 178 |
+
return {
|
| 179 |
+
"message": f"Preprocessed ATAC data: {n_components} LSI components, UMAP generated",
|
| 180 |
+
"reference": "https://github.com/gao-lab/GLUE/blob/master/docs/preprocessing.ipynb",
|
| 181 |
+
"artifacts": [
|
| 182 |
+
{
|
| 183 |
+
"description": "Preprocessed ATAC data",
|
| 184 |
+
"path": str(atac_output.resolve()),
|
| 185 |
+
},
|
| 186 |
+
{
|
| 187 |
+
"description": "ATAC UMAP visualization",
|
| 188 |
+
"path": str(fig_output.resolve()),
|
| 189 |
+
},
|
| 190 |
+
],
|
| 191 |
+
}
|
| 192 |
+
|
| 193 |
+
|
| 194 |
+
@preprocessing_mcp.tool
|
| 195 |
+
def glue_construct_regulatory_graph(
|
| 196 |
+
rna_path: Annotated[
|
| 197 |
+
str | None, "Path to preprocessed scRNA-seq data file in h5ad format"
|
| 198 |
+
] = None,
|
| 199 |
+
atac_path: Annotated[
|
| 200 |
+
str | None, "Path to preprocessed scATAC-seq data file in h5ad format"
|
| 201 |
+
] = None,
|
| 202 |
+
gtf_path: Annotated[
|
| 203 |
+
str | None, "Path to GTF annotation file for gene coordinates"
|
| 204 |
+
] = None,
|
| 205 |
+
gtf_by: Annotated[str, "GTF attribute to match gene names"] = "gene_name",
|
| 206 |
+
out_prefix: Annotated[str | None, "Output file prefix"] = None,
|
| 207 |
+
) -> dict:
|
| 208 |
+
"""
|
| 209 |
+
Construct prior regulatory graph linking RNA genes and ATAC peaks via genomic proximity.
|
| 210 |
+
Input is preprocessed RNA and ATAC data with GTF annotation and output is NetworkX guidance graph.
|
| 211 |
+
"""
|
| 212 |
+
# Input validation
|
| 213 |
+
if rna_path is None:
|
| 214 |
+
raise ValueError("Path to preprocessed scRNA-seq data file must be provided")
|
| 215 |
+
if atac_path is None:
|
| 216 |
+
raise ValueError("Path to preprocessed scATAC-seq data file must be provided")
|
| 217 |
+
if gtf_path is None:
|
| 218 |
+
raise ValueError("Path to GTF annotation file must be provided")
|
| 219 |
+
|
| 220 |
+
# File existence validation
|
| 221 |
+
rna_file = Path(rna_path)
|
| 222 |
+
if not rna_file.exists():
|
| 223 |
+
raise FileNotFoundError(f"RNA data file not found: {rna_path}")
|
| 224 |
+
|
| 225 |
+
atac_file = Path(atac_path)
|
| 226 |
+
if not atac_file.exists():
|
| 227 |
+
raise FileNotFoundError(f"ATAC data file not found: {atac_path}")
|
| 228 |
+
|
| 229 |
+
gtf_file = Path(gtf_path)
|
| 230 |
+
if not gtf_file.exists():
|
| 231 |
+
raise FileNotFoundError(f"GTF annotation file not found: {gtf_path}")
|
| 232 |
+
|
| 233 |
+
# Set output prefix
|
| 234 |
+
if out_prefix is None:
|
| 235 |
+
out_prefix = "glue_guidance"
|
| 236 |
+
|
| 237 |
+
# Load data
|
| 238 |
+
rna = ad.read_h5ad(rna_path)
|
| 239 |
+
atac = ad.read_h5ad(atac_path)
|
| 240 |
+
|
| 241 |
+
# Get gene annotation from GTF
|
| 242 |
+
scglue.data.get_gene_annotation(rna, gtf=gtf_path, gtf_by=gtf_by)
|
| 243 |
+
|
| 244 |
+
# Extract ATAC peak coordinates from var_names
|
| 245 |
+
split = atac.var_names.str.split(r"[:-]")
|
| 246 |
+
atac.var["chrom"] = split.map(lambda x: x[0])
|
| 247 |
+
atac.var["chromStart"] = split.map(lambda x: x[1]).astype(int)
|
| 248 |
+
atac.var["chromEnd"] = split.map(lambda x: x[2]).astype(int)
|
| 249 |
+
|
| 250 |
+
# Construct guidance graph
|
| 251 |
+
guidance = scglue.genomics.rna_anchored_guidance_graph(rna, atac)
|
| 252 |
+
|
| 253 |
+
# Verify graph compliance
|
| 254 |
+
scglue.graph.check_graph(guidance, [rna, atac])
|
| 255 |
+
|
| 256 |
+
# Save guidance graph
|
| 257 |
+
graph_output = OUTPUT_DIR / f"{out_prefix}_graph_{timestamp}.graphml.gz"
|
| 258 |
+
nx.write_graphml(guidance, str(graph_output))
|
| 259 |
+
|
| 260 |
+
# Save updated data with coordinates
|
| 261 |
+
rna_output = OUTPUT_DIR / f"{out_prefix}_rna_annotated_{timestamp}.h5ad"
|
| 262 |
+
atac_output = OUTPUT_DIR / f"{out_prefix}_atac_annotated_{timestamp}.h5ad"
|
| 263 |
+
rna.write(str(rna_output), compression="gzip")
|
| 264 |
+
atac.write(str(atac_output), compression="gzip")
|
| 265 |
+
|
| 266 |
+
return {
|
| 267 |
+
"message": f"Constructed guidance graph with {guidance.number_of_nodes()} nodes and {guidance.number_of_edges()} edges",
|
| 268 |
+
"reference": "https://github.com/gao-lab/GLUE/blob/master/docs/preprocessing.ipynb",
|
| 269 |
+
"artifacts": [
|
| 270 |
+
{"description": "Guidance graph", "path": str(graph_output.resolve())},
|
| 271 |
+
{
|
| 272 |
+
"description": "RNA data with coordinates",
|
| 273 |
+
"path": str(rna_output.resolve()),
|
| 274 |
+
},
|
| 275 |
+
{
|
| 276 |
+
"description": "ATAC data with coordinates",
|
| 277 |
+
"path": str(atac_output.resolve()),
|
| 278 |
+
},
|
| 279 |
+
],
|
| 280 |
+
}
|
tools/preprocessing_implementation_log.md
ADDED
|
@@ -0,0 +1,209 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Implementation Log: GLUE Preprocessing Tools
|
| 2 |
+
|
| 3 |
+
**Tutorial Source**: `gao-lab/GLUE/blob/master/docs/preprocessing.ipynb`
|
| 4 |
+
**Implementation Date**: 2026-02-14
|
| 5 |
+
**Output File**: `src/tools/preprocessing.py`
|
| 6 |
+
|
| 7 |
+
## Tool Design Decisions
|
| 8 |
+
|
| 9 |
+
### Tools Extracted (3 tools)
|
| 10 |
+
|
| 11 |
+
1. **glue_preprocess_scrna**
|
| 12 |
+
- **Section**: "Preprocess scRNA-seq data"
|
| 13 |
+
- **Rationale**: Complete preprocessing workflow for scRNA-seq data including HVG selection, normalization, scaling, PCA, and UMAP visualization
|
| 14 |
+
- **Classification**: Applicable to New Data - performs standard scRNA-seq preprocessing on any raw count matrix
|
| 15 |
+
- **Parameters Preserved**: `n_top_genes=2000`, `flavor="seurat_v3"`, `n_comps=100`, `svd_solver="auto"` all explicitly set in tutorial
|
| 16 |
+
- **Parameters Parameterized**: `color_var="cell_type"` is tutorial-specific and must be configurable for user datasets
|
| 17 |
+
|
| 18 |
+
2. **glue_preprocess_scatac**
|
| 19 |
+
- **Section**: "Preprocess scATAC-seq data"
|
| 20 |
+
- **Rationale**: Complete preprocessing workflow for scATAC-seq data using LSI dimension reduction and UMAP visualization
|
| 21 |
+
- **Classification**: Applicable to New Data - performs standard scATAC-seq preprocessing on any raw accessibility matrix
|
| 22 |
+
- **Parameters Preserved**: `n_components=100`, `n_iter=15` explicitly set in tutorial
|
| 23 |
+
- **Parameters Parameterized**: `color_var="cell_type"` is tutorial-specific and must be configurable for user datasets
|
| 24 |
+
|
| 25 |
+
3. **glue_construct_regulatory_graph**
|
| 26 |
+
- **Section**: "Construct prior regulatory graph"
|
| 27 |
+
- **Rationale**: Constructs prior regulatory graph linking RNA and ATAC features via genomic proximity
|
| 28 |
+
- **Classification**: Applicable to New Data - essential for GLUE model training with any paired RNA-ATAC datasets
|
| 29 |
+
- **Parameters Preserved**: `gtf_by="gene_name"` as tutorial default
|
| 30 |
+
- **Input Requirements**: Requires GTF annotation file which users must provide for their organism
|
| 31 |
+
|
| 32 |
+
### Tools Excluded (1 tool)
|
| 33 |
+
|
| 34 |
+
1. **glue_read_paired_data** (initially present, removed in revision)
|
| 35 |
+
- **Section**: "Read data"
|
| 36 |
+
- **Rationale for Exclusion**: Only loads tutorial example data with no analytical transformation
|
| 37 |
+
- **Classification**: NOT Applicable to New Data - data loading is trivial and should be handled by users
|
| 38 |
+
|
| 39 |
+
## Parameter Design Rationale
|
| 40 |
+
|
| 41 |
+
### Primary Data Inputs
|
| 42 |
+
- All tools use **file paths** as primary inputs (h5ad format for AnnData objects)
|
| 43 |
+
- No data object parameters (e.g., `adata: AnnData`) to enforce file-based workflow
|
| 44 |
+
- All data paths default to `None` with validation in function body for clear error messages
|
| 45 |
+
|
| 46 |
+
### Analysis Parameters
|
| 47 |
+
**Parameters Explicitly Set in Tutorial (Parameterized)**:
|
| 48 |
+
- `n_top_genes=2000`, `flavor="seurat_v3"` - Tutorial shows explicit values for HVG selection
|
| 49 |
+
- `n_comps=100`, `svd_solver="auto"` - Tutorial shows explicit values for PCA
|
| 50 |
+
- `n_components=100`, `n_iter=15` - Tutorial shows explicit values for LSI
|
| 51 |
+
- `gtf_by="gene_name"` - Tutorial shows explicit attribute for GTF parsing
|
| 52 |
+
|
| 53 |
+
**Tutorial-Specific Values (Parameterized)**:
|
| 54 |
+
- `color_var="cell_type"` - Column name specific to tutorial dataset, must be configurable for user data
|
| 55 |
+
|
| 56 |
+
**Library Defaults (Preserved)**:
|
| 57 |
+
- `sc.pp.neighbors(rna, metric="cosine")` - Tutorial shows this exact call, preserved as-is
|
| 58 |
+
- `sc.pp.normalize_total(rna)` - No parameters in tutorial, using library defaults
|
| 59 |
+
- `sc.pp.log1p(rna)` - No parameters in tutorial, using library defaults
|
| 60 |
+
- `sc.pp.scale(rna)` - No parameters in tutorial, using library defaults
|
| 61 |
+
|
| 62 |
+
### Critical Rule Adherence
|
| 63 |
+
**NEVER ADD PARAMETERS NOT IN TUTORIAL**: All function parameters correspond to explicit values in the tutorial code. No parameters were added that weren't shown in the original tutorial.
|
| 64 |
+
|
| 65 |
+
**PRESERVE EXACT TUTORIAL STRUCTURE**: All function calls preserve the exact structure from the tutorial:
|
| 66 |
+
- `sc.pp.highly_variable_genes(rna, n_top_genes=2000, flavor="seurat_v3")` β parameterized as shown
|
| 67 |
+
- `sc.tl.pca(rna, n_comps=100, svd_solver="auto")` β parameterized as shown
|
| 68 |
+
- `scglue.data.lsi(atac, n_components=100, n_iter=15)` β parameterized as shown
|
| 69 |
+
- `sc.pp.neighbors(rna, metric="cosine")` β preserved exactly as shown
|
| 70 |
+
|
| 71 |
+
## Output Requirements
|
| 72 |
+
|
| 73 |
+
### Visualization Outputs
|
| 74 |
+
**Code-Generated Figures Only**:
|
| 75 |
+
- `glue_preprocess_scrna`: UMAP visualization of RNA data (from tutorial section "Optionally, we can visualize...")
|
| 76 |
+
- `glue_preprocess_scatac`: UMAP visualization of ATAC data (from tutorial section "Optionally, we may also visualize...")
|
| 77 |
+
- No static figures or diagrams included (tutorial has none)
|
| 78 |
+
|
| 79 |
+
**Figure Specifications**:
|
| 80 |
+
- Format: PNG with `dpi=300`, `bbox_inches='tight'`
|
| 81 |
+
- Naming: `{out_prefix}_umap_{timestamp}.png`
|
| 82 |
+
- Always generated (no user control parameter)
|
| 83 |
+
|
| 84 |
+
### Data Outputs
|
| 85 |
+
**Essential Results Saved**:
|
| 86 |
+
- Preprocessed AnnData objects with all transformations applied
|
| 87 |
+
- Guidance graph in NetworkX GraphML format
|
| 88 |
+
- Annotated data with genomic coordinates
|
| 89 |
+
|
| 90 |
+
**File Formats**:
|
| 91 |
+
- AnnData: h5ad with gzip compression (standard for single-cell data)
|
| 92 |
+
- Graph: graphml.gz (standard for NetworkX graphs)
|
| 93 |
+
|
| 94 |
+
**Naming Convention**:
|
| 95 |
+
- `{out_prefix}_preprocessed_{timestamp}.h5ad`
|
| 96 |
+
- `{out_prefix}_graph_{timestamp}.graphml.gz`
|
| 97 |
+
- `{out_prefix}_rna_annotated_{timestamp}.h5ad`
|
| 98 |
+
|
| 99 |
+
### Return Format
|
| 100 |
+
All tools return standardized dict:
|
| 101 |
+
```python
|
| 102 |
+
{
|
| 103 |
+
"message": "<concise status β€120 chars>",
|
| 104 |
+
"reference": "https://github.com/gao-lab/GLUE/blob/master/docs/preprocessing.ipynb",
|
| 105 |
+
"artifacts": [
|
| 106 |
+
{
|
| 107 |
+
"description": "<description β€50 chars>",
|
| 108 |
+
"path": "/absolute/path/to/file"
|
| 109 |
+
}
|
| 110 |
+
]
|
| 111 |
+
}
|
| 112 |
+
```
|
| 113 |
+
|
| 114 |
+
## Quality Review Results
|
| 115 |
+
|
| 116 |
+
### Iteration 1 (Final)
|
| 117 |
+
**Date**: 2026-02-14
|
| 118 |
+
**Status**: All checks passed
|
| 119 |
+
|
| 120 |
+
**Tool Design Validation**: [β] All 7 checks passed
|
| 121 |
+
- Tool definition, naming, description, classification, order, boundaries, independence all correct
|
| 122 |
+
|
| 123 |
+
**Implementation Validation**: [β] All 8 checks passed
|
| 124 |
+
- Function coverage, parameter design, input validation, tutorial fidelity, real-world focus, no hardcoding, library compliance, exact function calls all correct
|
| 125 |
+
|
| 126 |
+
**Output Validation**: [β] All 5 checks passed
|
| 127 |
+
- Figure generation, data outputs, return format, file paths, reference links all correct
|
| 128 |
+
|
| 129 |
+
**Code Quality Validation**: [β] All 6 checks passed
|
| 130 |
+
- Error handling, type annotations, documentation, template compliance, import management, environment setup all correct
|
| 131 |
+
|
| 132 |
+
**Summary**: 3/3 tools passing all checks. No issues found. Implementation is production-ready.
|
| 133 |
+
|
| 134 |
+
## Implementation Choices
|
| 135 |
+
|
| 136 |
+
### Libraries Used
|
| 137 |
+
- **anndata**: Standard format for single-cell data (AnnData objects)
|
| 138 |
+
- **scanpy**: Standard toolkit for scRNA-seq analysis (HVG, normalization, PCA, UMAP)
|
| 139 |
+
- **scglue**: GLUE-specific functions (LSI, graph construction, gene annotation)
|
| 140 |
+
- **networkx**: Standard graph library for guidance graph representation
|
| 141 |
+
- **matplotlib**: Visualization library for UMAP plots
|
| 142 |
+
|
| 143 |
+
### Error Handling Approach
|
| 144 |
+
**Basic Input Validation Only**:
|
| 145 |
+
- Required parameter validation (data_path must be provided)
|
| 146 |
+
- File existence checks (FileNotFoundError if file not found)
|
| 147 |
+
- No intermediate processing validation (trust library error messages)
|
| 148 |
+
|
| 149 |
+
**Rationale**: Tutorial assumes valid input data. Error handling focused on user input mistakes, not data quality issues.
|
| 150 |
+
|
| 151 |
+
### Parameterization Rationale
|
| 152 |
+
|
| 153 |
+
**Why Parameterize `color_var`?**
|
| 154 |
+
- Tutorial uses `"cell_type"` which is a column specific to the tutorial dataset
|
| 155 |
+
- User datasets will have different column names for cell annotations
|
| 156 |
+
- Parameterizing enables tool to work with any AnnData object with different metadata columns
|
| 157 |
+
|
| 158 |
+
**Why Parameterize `gtf_by`?**
|
| 159 |
+
- Tutorial uses `"gene_name"` attribute in GTF, but GTF files can use different attributes
|
| 160 |
+
- Some GTF files use `"gene_id"`, `"transcript_name"`, or other attributes
|
| 161 |
+
- Parameterizing enables tool to work with different GTF annotation standards
|
| 162 |
+
|
| 163 |
+
**Why Keep Default `n_top_genes=2000`?**
|
| 164 |
+
- This is a standard value in single-cell RNA-seq analysis
|
| 165 |
+
- Tutorial explicitly sets this value, not using library default
|
| 166 |
+
- Value represents a scientific choice about feature selection stringency
|
| 167 |
+
|
| 168 |
+
**Why Keep Default `n_components=100`?**
|
| 169 |
+
- This is the standard dimensionality for GLUE model training
|
| 170 |
+
- Tutorial explicitly sets this value for downstream model compatibility
|
| 171 |
+
- Changing this value would require adjusting the GLUE model architecture
|
| 172 |
+
|
| 173 |
+
## Known Limitations
|
| 174 |
+
|
| 175 |
+
1. **Coordinate Extraction Assumption**: `glue_construct_regulatory_graph` assumes ATAC peak names follow the format `"chr:start-end"`. If user data uses different formats (e.g., `"chr_start_end"` or `"chr:start:end"`), the coordinate extraction will fail. Users must ensure their peak names follow the expected format or pre-process their data.
|
| 176 |
+
|
| 177 |
+
2. **GTF Compatibility**: Gene annotation requires GTF file with specific attributes. Not all GTF formats are compatible. Users must ensure their GTF file contains the required attributes (default: `"gene_name"`).
|
| 178 |
+
|
| 179 |
+
3. **Memory Requirements**: LSI and PCA operations on large datasets can be memory-intensive. Users with datasets >100k cells may encounter memory issues on standard workstations.
|
| 180 |
+
|
| 181 |
+
4. **Visualization Dependency**: UMAP visualizations require the `color_var` column to exist in the AnnData object. If the column is missing, the tool will fail. Users must ensure their data contains the specified annotation column.
|
| 182 |
+
|
| 183 |
+
5. **File Format Constraints**: Tools only accept h5ad format for input/output. Users with data in other formats (csv, mtx, loom) must convert to h5ad before using these tools.
|
| 184 |
+
|
| 185 |
+
## Testing Recommendations
|
| 186 |
+
|
| 187 |
+
1. **Test with tutorial data**: Verify tools reproduce exact tutorial results with Chen-2019 dataset
|
| 188 |
+
2. **Test with different organisms**: Verify GTF annotation works with different reference genomes
|
| 189 |
+
3. **Test with different annotation columns**: Verify `color_var` parameter works with different metadata
|
| 190 |
+
4. **Test with edge cases**:
|
| 191 |
+
- Very small datasets (<100 cells)
|
| 192 |
+
- Very large datasets (>100k cells)
|
| 193 |
+
- Datasets with missing or malformed peak coordinates
|
| 194 |
+
- GTF files with different attribute names
|
| 195 |
+
|
| 196 |
+
## Revision History
|
| 197 |
+
|
| 198 |
+
### Initial Implementation
|
| 199 |
+
- 4 tools: `glue_read_paired_data`, `glue_preprocess_scrna`, `glue_preprocess_scatac`, `glue_construct_guidance_graph`
|
| 200 |
+
|
| 201 |
+
### Revision 1 (2026-02-14)
|
| 202 |
+
**Changes Made**:
|
| 203 |
+
1. **Removed `glue_read_paired_data` tool**: Classified as NOT Applicable to New Data (only loads tutorial data without analytical transformation)
|
| 204 |
+
2. **Renamed `glue_construct_guidance_graph` to `glue_construct_regulatory_graph`**: Better matches tutorial section title "Construct prior regulatory graph"
|
| 205 |
+
3. **Updated documentation**: Corrected tool count from 4 to 3 tools
|
| 206 |
+
|
| 207 |
+
**Rationale**: Enforce strict adherence to "Applicable to New Data" classification. Data loading without analytical transformation should not be a standalone tool.
|
| 208 |
+
|
| 209 |
+
**Result**: All 3 remaining tools pass quality review with all checks passing.
|
tools/training.py
ADDED
|
@@ -0,0 +1,525 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
"""
|
| 2 |
+
GLUE model training workflow for multi-omics data integration.
|
| 3 |
+
|
| 4 |
+
This MCP Server provides 4 tools:
|
| 5 |
+
1. glue_configure_datasets: Configure RNA-seq and ATAC-seq datasets for GLUE model training
|
| 6 |
+
2. glue_train_model: Train GLUE model for multi-omics integration
|
| 7 |
+
3. glue_check_integration_consistency: Evaluate integration quality with consistency scores
|
| 8 |
+
4. glue_generate_embeddings: Generate cell and feature embeddings from trained GLUE model
|
| 9 |
+
|
| 10 |
+
All tools extracted from `gao-lab/GLUE/docs/training.ipynb`.
|
| 11 |
+
"""
|
| 12 |
+
|
| 13 |
+
import os
|
| 14 |
+
from datetime import datetime
|
| 15 |
+
from itertools import chain
|
| 16 |
+
from pathlib import Path
|
| 17 |
+
# Standard imports
|
| 18 |
+
from typing import Annotated, Any, Literal
|
| 19 |
+
|
| 20 |
+
# Domain-specific imports
|
| 21 |
+
import anndata as ad
|
| 22 |
+
import matplotlib.pyplot as plt
|
| 23 |
+
import networkx as nx
|
| 24 |
+
import numpy as np
|
| 25 |
+
import pandas as pd
|
| 26 |
+
import scanpy as sc
|
| 27 |
+
import scglue
|
| 28 |
+
import seaborn as sns
|
| 29 |
+
from fastmcp import FastMCP
|
| 30 |
+
from matplotlib import rcParams
|
| 31 |
+
|
| 32 |
+
# Project structure
|
| 33 |
+
PROJECT_ROOT = Path(__file__).parent.parent.parent.resolve()
|
| 34 |
+
DEFAULT_INPUT_DIR = PROJECT_ROOT / "tmp" / "inputs"
|
| 35 |
+
DEFAULT_OUTPUT_DIR = PROJECT_ROOT / "tmp" / "outputs"
|
| 36 |
+
|
| 37 |
+
INPUT_DIR = Path(os.environ.get("TRAINING_INPUT_DIR", DEFAULT_INPUT_DIR))
|
| 38 |
+
OUTPUT_DIR = Path(os.environ.get("TRAINING_OUTPUT_DIR", DEFAULT_OUTPUT_DIR))
|
| 39 |
+
|
| 40 |
+
# Ensure directories exist
|
| 41 |
+
INPUT_DIR.mkdir(parents=True, exist_ok=True)
|
| 42 |
+
OUTPUT_DIR.mkdir(parents=True, exist_ok=True)
|
| 43 |
+
|
| 44 |
+
# Timestamp for unique outputs
|
| 45 |
+
timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
|
| 46 |
+
|
| 47 |
+
# MCP server instance
|
| 48 |
+
training_mcp = FastMCP(name="training")
|
| 49 |
+
|
| 50 |
+
# Set plot parameters
|
| 51 |
+
plt.rcParams["figure.dpi"] = 300
|
| 52 |
+
plt.rcParams["savefig.dpi"] = 300
|
| 53 |
+
scglue.plot.set_publication_params()
|
| 54 |
+
rcParams["figure.figsize"] = (4, 4)
|
| 55 |
+
|
| 56 |
+
|
| 57 |
+
@training_mcp.tool
|
| 58 |
+
def glue_configure_datasets(
|
| 59 |
+
# Primary data inputs
|
| 60 |
+
rna_path: Annotated[
|
| 61 |
+
str | None, "Path to preprocessed RNA-seq data file with extension .h5ad"
|
| 62 |
+
] = None,
|
| 63 |
+
atac_path: Annotated[
|
| 64 |
+
str | None, "Path to preprocessed ATAC-seq data file with extension .h5ad"
|
| 65 |
+
] = None,
|
| 66 |
+
guidance_path: Annotated[
|
| 67 |
+
str | None, "Path to guidance graph file with extension .graphml.gz"
|
| 68 |
+
] = None,
|
| 69 |
+
# Configuration parameters with tutorial defaults
|
| 70 |
+
prob_model: Annotated[
|
| 71 |
+
Literal["NB", "ZINB", "ZIP"], "Probabilistic generative model"
|
| 72 |
+
] = "NB",
|
| 73 |
+
use_highly_variable: Annotated[bool, "Use only highly variable features"] = True,
|
| 74 |
+
rna_use_layer: Annotated[
|
| 75 |
+
str | None, "RNA data layer to use (None uses .X)"
|
| 76 |
+
] = "counts",
|
| 77 |
+
rna_use_rep: Annotated[str, "RNA preprocessing embedding to use"] = "X_pca",
|
| 78 |
+
atac_use_rep: Annotated[str, "ATAC preprocessing embedding to use"] = "X_lsi",
|
| 79 |
+
out_prefix: Annotated[str | None, "Output file prefix"] = None,
|
| 80 |
+
) -> dict:
|
| 81 |
+
"""
|
| 82 |
+
Configure RNA-seq and ATAC-seq datasets for GLUE model training.
|
| 83 |
+
Input is preprocessed RNA/ATAC h5ad files and guidance graph, output is configured h5ad files and HVF-filtered guidance graph.
|
| 84 |
+
"""
|
| 85 |
+
# Input file validation
|
| 86 |
+
if rna_path is None:
|
| 87 |
+
raise ValueError("Path to RNA-seq data file must be provided")
|
| 88 |
+
if atac_path is None:
|
| 89 |
+
raise ValueError("Path to ATAC-seq data file must be provided")
|
| 90 |
+
if guidance_path is None:
|
| 91 |
+
raise ValueError("Path to guidance graph file must be provided")
|
| 92 |
+
|
| 93 |
+
# File existence validation
|
| 94 |
+
rna_file = Path(rna_path)
|
| 95 |
+
if not rna_file.exists():
|
| 96 |
+
raise FileNotFoundError(f"RNA-seq file not found: {rna_path}")
|
| 97 |
+
|
| 98 |
+
atac_file = Path(atac_path)
|
| 99 |
+
if not atac_file.exists():
|
| 100 |
+
raise FileNotFoundError(f"ATAC-seq file not found: {atac_path}")
|
| 101 |
+
|
| 102 |
+
guidance_file = Path(guidance_path)
|
| 103 |
+
if not guidance_file.exists():
|
| 104 |
+
raise FileNotFoundError(f"Guidance graph file not found: {guidance_path}")
|
| 105 |
+
|
| 106 |
+
# Load data
|
| 107 |
+
rna = ad.read_h5ad(rna_path)
|
| 108 |
+
atac = ad.read_h5ad(atac_path)
|
| 109 |
+
guidance = nx.read_graphml(guidance_path)
|
| 110 |
+
|
| 111 |
+
# Configure datasets
|
| 112 |
+
scglue.models.configure_dataset(
|
| 113 |
+
rna,
|
| 114 |
+
prob_model,
|
| 115 |
+
use_highly_variable=use_highly_variable,
|
| 116 |
+
use_layer=rna_use_layer,
|
| 117 |
+
use_rep=rna_use_rep,
|
| 118 |
+
)
|
| 119 |
+
|
| 120 |
+
scglue.models.configure_dataset(
|
| 121 |
+
atac, prob_model, use_highly_variable=use_highly_variable, use_rep=atac_use_rep
|
| 122 |
+
)
|
| 123 |
+
|
| 124 |
+
# Extract subgraph with highly variable features
|
| 125 |
+
guidance_hvf = guidance.subgraph(
|
| 126 |
+
chain(
|
| 127 |
+
rna.var.query("highly_variable").index,
|
| 128 |
+
atac.var.query("highly_variable").index,
|
| 129 |
+
)
|
| 130 |
+
).copy()
|
| 131 |
+
|
| 132 |
+
# Note: anndata drops None values during save/load, but scglue's configure_dataset
|
| 133 |
+
# creates these fields. We preserve them by converting None to a special string marker.
|
| 134 |
+
for adata in [rna, atac]:
|
| 135 |
+
if "__scglue__" in adata.uns:
|
| 136 |
+
config = adata.uns["__scglue__"]
|
| 137 |
+
# Convert None values to string markers that will survive serialization
|
| 138 |
+
for key in [
|
| 139 |
+
"batches",
|
| 140 |
+
"use_batch",
|
| 141 |
+
"use_cell_type",
|
| 142 |
+
"cell_types",
|
| 143 |
+
"use_dsc_weight",
|
| 144 |
+
"use_layer",
|
| 145 |
+
]:
|
| 146 |
+
if key in config and config[key] is None:
|
| 147 |
+
config[key] = "__none__"
|
| 148 |
+
|
| 149 |
+
# Save configured datasets and HVF guidance graph
|
| 150 |
+
if out_prefix is None:
|
| 151 |
+
out_prefix = f"glue_configured_{timestamp}"
|
| 152 |
+
|
| 153 |
+
rna_output = OUTPUT_DIR / f"{out_prefix}_rna_configured.h5ad"
|
| 154 |
+
atac_output = OUTPUT_DIR / f"{out_prefix}_atac_configured.h5ad"
|
| 155 |
+
guidance_hvf_output = OUTPUT_DIR / f"{out_prefix}_guidance_hvf.graphml.gz"
|
| 156 |
+
|
| 157 |
+
rna.write(str(rna_output), compression="gzip")
|
| 158 |
+
atac.write(str(atac_output), compression="gzip")
|
| 159 |
+
nx.write_graphml(guidance_hvf, str(guidance_hvf_output))
|
| 160 |
+
|
| 161 |
+
# Return standardized format
|
| 162 |
+
return {
|
| 163 |
+
"message": f"Configured datasets with {len(rna.var.query('highly_variable'))} RNA and {len(atac.var.query('highly_variable'))} ATAC HVFs",
|
| 164 |
+
"reference": "https://github.com/gao-lab/GLUE/blob/master/docs/training.ipynb",
|
| 165 |
+
"artifacts": [
|
| 166 |
+
{
|
| 167 |
+
"description": "Configured RNA-seq data",
|
| 168 |
+
"path": str(rna_output.resolve()),
|
| 169 |
+
},
|
| 170 |
+
{
|
| 171 |
+
"description": "Configured ATAC-seq data",
|
| 172 |
+
"path": str(atac_output.resolve()),
|
| 173 |
+
},
|
| 174 |
+
{
|
| 175 |
+
"description": "HVF-filtered guidance graph",
|
| 176 |
+
"path": str(guidance_hvf_output.resolve()),
|
| 177 |
+
},
|
| 178 |
+
],
|
| 179 |
+
}
|
| 180 |
+
|
| 181 |
+
|
| 182 |
+
@training_mcp.tool
|
| 183 |
+
def glue_train_model(
|
| 184 |
+
# Primary data inputs
|
| 185 |
+
rna_path: Annotated[
|
| 186 |
+
str | None, "Path to configured RNA-seq data file with extension .h5ad"
|
| 187 |
+
] = None,
|
| 188 |
+
atac_path: Annotated[
|
| 189 |
+
str | None, "Path to configured ATAC-seq data file with extension .h5ad"
|
| 190 |
+
] = None,
|
| 191 |
+
guidance_hvf_path: Annotated[
|
| 192 |
+
str | None,
|
| 193 |
+
"Path to HVF-filtered guidance graph file with extension .graphml.gz",
|
| 194 |
+
] = None,
|
| 195 |
+
# Training parameters
|
| 196 |
+
training_dir: Annotated[
|
| 197 |
+
str | None, "Directory to store model snapshots and training logs"
|
| 198 |
+
] = None,
|
| 199 |
+
out_prefix: Annotated[str | None, "Output file prefix"] = None,
|
| 200 |
+
) -> dict:
|
| 201 |
+
"""
|
| 202 |
+
Train GLUE model for multi-omics integration.
|
| 203 |
+
Input is configured RNA/ATAC h5ad files and HVF guidance graph, output is trained GLUE model.
|
| 204 |
+
"""
|
| 205 |
+
# Input file validation
|
| 206 |
+
if rna_path is None:
|
| 207 |
+
raise ValueError("Path to configured RNA-seq data file must be provided")
|
| 208 |
+
if atac_path is None:
|
| 209 |
+
raise ValueError("Path to configured ATAC-seq data file must be provided")
|
| 210 |
+
if guidance_hvf_path is None:
|
| 211 |
+
raise ValueError("Path to HVF-filtered guidance graph file must be provided")
|
| 212 |
+
|
| 213 |
+
# File existence validation
|
| 214 |
+
rna_file = Path(rna_path)
|
| 215 |
+
if not rna_file.exists():
|
| 216 |
+
raise FileNotFoundError(f"RNA-seq file not found: {rna_path}")
|
| 217 |
+
|
| 218 |
+
atac_file = Path(atac_path)
|
| 219 |
+
if not atac_file.exists():
|
| 220 |
+
raise FileNotFoundError(f"ATAC-seq file not found: {atac_path}")
|
| 221 |
+
|
| 222 |
+
guidance_hvf_file = Path(guidance_hvf_path)
|
| 223 |
+
if not guidance_hvf_file.exists():
|
| 224 |
+
raise FileNotFoundError(
|
| 225 |
+
f"Guidance HVF graph file not found: {guidance_hvf_path}"
|
| 226 |
+
)
|
| 227 |
+
|
| 228 |
+
# Load data
|
| 229 |
+
rna = ad.read_h5ad(rna_path)
|
| 230 |
+
atac = ad.read_h5ad(atac_path)
|
| 231 |
+
guidance_hvf = nx.read_graphml(guidance_hvf_path)
|
| 232 |
+
|
| 233 |
+
# Convert string markers back to None for scglue compatibility
|
| 234 |
+
for adata in [rna, atac]:
|
| 235 |
+
if "__scglue__" in adata.uns:
|
| 236 |
+
config = adata.uns["__scglue__"]
|
| 237 |
+
for key in [
|
| 238 |
+
"batches",
|
| 239 |
+
"use_batch",
|
| 240 |
+
"use_cell_type",
|
| 241 |
+
"cell_types",
|
| 242 |
+
"use_dsc_weight",
|
| 243 |
+
"use_layer",
|
| 244 |
+
]:
|
| 245 |
+
if key in config and config[key] == "__none__":
|
| 246 |
+
config[key] = None
|
| 247 |
+
|
| 248 |
+
# Set training directory
|
| 249 |
+
if training_dir is None:
|
| 250 |
+
if out_prefix is None:
|
| 251 |
+
out_prefix = f"glue_model_{timestamp}"
|
| 252 |
+
training_dir = str(OUTPUT_DIR / f"{out_prefix}_training")
|
| 253 |
+
|
| 254 |
+
# Create training directory
|
| 255 |
+
Path(training_dir).mkdir(parents=True, exist_ok=True)
|
| 256 |
+
|
| 257 |
+
# Train GLUE model
|
| 258 |
+
glue = scglue.models.fit_SCGLUE(
|
| 259 |
+
{"rna": rna, "atac": atac}, guidance_hvf, fit_kws={"directory": training_dir}
|
| 260 |
+
)
|
| 261 |
+
|
| 262 |
+
# Save trained model
|
| 263 |
+
if out_prefix is None:
|
| 264 |
+
out_prefix = f"glue_model_{timestamp}"
|
| 265 |
+
|
| 266 |
+
model_output = OUTPUT_DIR / f"{out_prefix}.dill"
|
| 267 |
+
glue.save(str(model_output))
|
| 268 |
+
|
| 269 |
+
# Return standardized format
|
| 270 |
+
return {
|
| 271 |
+
"message": "GLUE model training completed successfully",
|
| 272 |
+
"reference": "https://github.com/gao-lab/GLUE/blob/master/docs/training.ipynb",
|
| 273 |
+
"artifacts": [
|
| 274 |
+
{"description": "Trained GLUE model", "path": str(model_output.resolve())},
|
| 275 |
+
{
|
| 276 |
+
"description": "Training logs directory",
|
| 277 |
+
"path": str(Path(training_dir).resolve()),
|
| 278 |
+
},
|
| 279 |
+
],
|
| 280 |
+
}
|
| 281 |
+
|
| 282 |
+
|
| 283 |
+
@training_mcp.tool
|
| 284 |
+
def glue_check_integration_consistency(
|
| 285 |
+
# Primary data inputs
|
| 286 |
+
model_path: Annotated[
|
| 287 |
+
str | None, "Path to trained GLUE model file with extension .dill"
|
| 288 |
+
] = None,
|
| 289 |
+
rna_path: Annotated[
|
| 290 |
+
str | None, "Path to configured RNA-seq data file with extension .h5ad"
|
| 291 |
+
] = None,
|
| 292 |
+
atac_path: Annotated[
|
| 293 |
+
str | None, "Path to configured ATAC-seq data file with extension .h5ad"
|
| 294 |
+
] = None,
|
| 295 |
+
guidance_hvf_path: Annotated[
|
| 296 |
+
str | None,
|
| 297 |
+
"Path to HVF-filtered guidance graph file with extension .graphml.gz",
|
| 298 |
+
] = None,
|
| 299 |
+
out_prefix: Annotated[str | None, "Output file prefix"] = None,
|
| 300 |
+
) -> dict:
|
| 301 |
+
"""
|
| 302 |
+
Evaluate integration quality with consistency scores across metacell granularities.
|
| 303 |
+
Input is trained model, RNA/ATAC data, and HVF guidance graph, output is consistency scores table and plot.
|
| 304 |
+
"""
|
| 305 |
+
# Input file validation
|
| 306 |
+
if model_path is None:
|
| 307 |
+
raise ValueError("Path to trained GLUE model file must be provided")
|
| 308 |
+
if rna_path is None:
|
| 309 |
+
raise ValueError("Path to configured RNA-seq data file must be provided")
|
| 310 |
+
if atac_path is None:
|
| 311 |
+
raise ValueError("Path to configured ATAC-seq data file must be provided")
|
| 312 |
+
if guidance_hvf_path is None:
|
| 313 |
+
raise ValueError("Path to HVF-filtered guidance graph file must be provided")
|
| 314 |
+
|
| 315 |
+
# File existence validation
|
| 316 |
+
model_file = Path(model_path)
|
| 317 |
+
if not model_file.exists():
|
| 318 |
+
raise FileNotFoundError(f"Model file not found: {model_path}")
|
| 319 |
+
|
| 320 |
+
rna_file = Path(rna_path)
|
| 321 |
+
if not rna_file.exists():
|
| 322 |
+
raise FileNotFoundError(f"RNA-seq file not found: {rna_path}")
|
| 323 |
+
|
| 324 |
+
atac_file = Path(atac_path)
|
| 325 |
+
if not atac_file.exists():
|
| 326 |
+
raise FileNotFoundError(f"ATAC-seq file not found: {atac_path}")
|
| 327 |
+
|
| 328 |
+
guidance_hvf_file = Path(guidance_hvf_path)
|
| 329 |
+
if not guidance_hvf_file.exists():
|
| 330 |
+
raise FileNotFoundError(
|
| 331 |
+
f"Guidance HVF graph file not found: {guidance_hvf_path}"
|
| 332 |
+
)
|
| 333 |
+
|
| 334 |
+
# Load data
|
| 335 |
+
glue = scglue.models.load_model(model_path)
|
| 336 |
+
rna = ad.read_h5ad(rna_path)
|
| 337 |
+
atac = ad.read_h5ad(atac_path)
|
| 338 |
+
guidance_hvf = nx.read_graphml(guidance_hvf_path)
|
| 339 |
+
|
| 340 |
+
# Convert string markers back to None for scglue compatibility
|
| 341 |
+
for adata in [rna, atac]:
|
| 342 |
+
if "__scglue__" in adata.uns:
|
| 343 |
+
config = adata.uns["__scglue__"]
|
| 344 |
+
for key in [
|
| 345 |
+
"batches",
|
| 346 |
+
"use_batch",
|
| 347 |
+
"use_cell_type",
|
| 348 |
+
"cell_types",
|
| 349 |
+
"use_dsc_weight",
|
| 350 |
+
"use_layer",
|
| 351 |
+
]:
|
| 352 |
+
if key in config and config[key] == "__none__":
|
| 353 |
+
config[key] = None
|
| 354 |
+
|
| 355 |
+
# Compute integration consistency
|
| 356 |
+
dx = scglue.models.integration_consistency(
|
| 357 |
+
glue, {"rna": rna, "atac": atac}, guidance_hvf
|
| 358 |
+
)
|
| 359 |
+
|
| 360 |
+
# Save consistency scores
|
| 361 |
+
if out_prefix is None:
|
| 362 |
+
out_prefix = f"glue_consistency_{timestamp}"
|
| 363 |
+
|
| 364 |
+
consistency_table = OUTPUT_DIR / f"{out_prefix}_scores.csv"
|
| 365 |
+
dx.to_csv(str(consistency_table), index=False)
|
| 366 |
+
|
| 367 |
+
# Generate consistency plot
|
| 368 |
+
plt.figure(figsize=(4, 4))
|
| 369 |
+
ax = sns.lineplot(x="n_meta", y="consistency", data=dx)
|
| 370 |
+
ax.axhline(y=0.05, c="darkred", ls="--")
|
| 371 |
+
plt.xlabel("Number of metacells")
|
| 372 |
+
plt.ylabel("Consistency score")
|
| 373 |
+
plt.tight_layout()
|
| 374 |
+
|
| 375 |
+
consistency_plot = OUTPUT_DIR / f"{out_prefix}_plot.png"
|
| 376 |
+
plt.savefig(str(consistency_plot), dpi=300, bbox_inches="tight")
|
| 377 |
+
plt.close()
|
| 378 |
+
|
| 379 |
+
# Return standardized format
|
| 380 |
+
return {
|
| 381 |
+
"message": f"Integration consistency computed (range: {dx['consistency'].min():.3f}-{dx['consistency'].max():.3f})",
|
| 382 |
+
"reference": "https://github.com/gao-lab/GLUE/blob/master/docs/training.ipynb",
|
| 383 |
+
"artifacts": [
|
| 384 |
+
{
|
| 385 |
+
"description": "Consistency scores table",
|
| 386 |
+
"path": str(consistency_table.resolve()),
|
| 387 |
+
},
|
| 388 |
+
{
|
| 389 |
+
"description": "Consistency plot",
|
| 390 |
+
"path": str(consistency_plot.resolve()),
|
| 391 |
+
},
|
| 392 |
+
],
|
| 393 |
+
}
|
| 394 |
+
|
| 395 |
+
|
| 396 |
+
@training_mcp.tool
|
| 397 |
+
def glue_generate_embeddings(
|
| 398 |
+
# Primary data inputs
|
| 399 |
+
model_path: Annotated[
|
| 400 |
+
str | None, "Path to trained GLUE model file with extension .dill"
|
| 401 |
+
] = None,
|
| 402 |
+
rna_path: Annotated[
|
| 403 |
+
str | None, "Path to configured RNA-seq data file with extension .h5ad"
|
| 404 |
+
] = None,
|
| 405 |
+
atac_path: Annotated[
|
| 406 |
+
str | None, "Path to configured ATAC-seq data file with extension .h5ad"
|
| 407 |
+
] = None,
|
| 408 |
+
guidance_hvf_path: Annotated[
|
| 409 |
+
str | None,
|
| 410 |
+
"Path to HVF-filtered guidance graph file with extension .graphml.gz",
|
| 411 |
+
] = None,
|
| 412 |
+
# Visualization parameters with tutorial defaults
|
| 413 |
+
color_vars: Annotated[list, "Variables to color UMAP by"] = ["cell_type", "domain"],
|
| 414 |
+
out_prefix: Annotated[str | None, "Output file prefix"] = None,
|
| 415 |
+
) -> dict:
|
| 416 |
+
"""
|
| 417 |
+
Generate cell and feature embeddings from trained GLUE model and visualize alignment.
|
| 418 |
+
Input is trained model and RNA/ATAC data, output is h5ad files with embeddings and UMAP visualization.
|
| 419 |
+
"""
|
| 420 |
+
# Input file validation
|
| 421 |
+
if model_path is None:
|
| 422 |
+
raise ValueError("Path to trained GLUE model file must be provided")
|
| 423 |
+
if rna_path is None:
|
| 424 |
+
raise ValueError("Path to configured RNA-seq data file must be provided")
|
| 425 |
+
if atac_path is None:
|
| 426 |
+
raise ValueError("Path to configured ATAC-seq data file must be provided")
|
| 427 |
+
if guidance_hvf_path is None:
|
| 428 |
+
raise ValueError("Path to HVF-filtered guidance graph file must be provided")
|
| 429 |
+
|
| 430 |
+
# File existence validation
|
| 431 |
+
model_file = Path(model_path)
|
| 432 |
+
if not model_file.exists():
|
| 433 |
+
raise FileNotFoundError(f"Model file not found: {model_path}")
|
| 434 |
+
|
| 435 |
+
rna_file = Path(rna_path)
|
| 436 |
+
if not rna_file.exists():
|
| 437 |
+
raise FileNotFoundError(f"RNA-seq file not found: {rna_path}")
|
| 438 |
+
|
| 439 |
+
atac_file = Path(atac_path)
|
| 440 |
+
if not atac_file.exists():
|
| 441 |
+
raise FileNotFoundError(f"ATAC-seq file not found: {atac_path}")
|
| 442 |
+
|
| 443 |
+
guidance_hvf_file = Path(guidance_hvf_path)
|
| 444 |
+
if not guidance_hvf_file.exists():
|
| 445 |
+
raise FileNotFoundError(
|
| 446 |
+
f"Guidance HVF graph file not found: {guidance_hvf_path}"
|
| 447 |
+
)
|
| 448 |
+
|
| 449 |
+
# Load data
|
| 450 |
+
glue = scglue.models.load_model(model_path)
|
| 451 |
+
rna = ad.read_h5ad(rna_path)
|
| 452 |
+
atac = ad.read_h5ad(atac_path)
|
| 453 |
+
guidance_hvf = nx.read_graphml(guidance_hvf_path)
|
| 454 |
+
|
| 455 |
+
# Convert string markers back to None for scglue compatibility
|
| 456 |
+
for adata in [rna, atac]:
|
| 457 |
+
if "__scglue__" in adata.uns:
|
| 458 |
+
config = adata.uns["__scglue__"]
|
| 459 |
+
for key in [
|
| 460 |
+
"batches",
|
| 461 |
+
"use_batch",
|
| 462 |
+
"use_cell_type",
|
| 463 |
+
"cell_types",
|
| 464 |
+
"use_dsc_weight",
|
| 465 |
+
"use_layer",
|
| 466 |
+
]:
|
| 467 |
+
if key in config and config[key] == "__none__":
|
| 468 |
+
config[key] = None
|
| 469 |
+
|
| 470 |
+
# Generate cell embeddings
|
| 471 |
+
rna.obsm["X_glue"] = glue.encode_data("rna", rna)
|
| 472 |
+
atac.obsm["X_glue"] = glue.encode_data("atac", atac)
|
| 473 |
+
|
| 474 |
+
# Generate feature embeddings
|
| 475 |
+
feature_embeddings = glue.encode_graph(guidance_hvf)
|
| 476 |
+
feature_embeddings = pd.DataFrame(feature_embeddings, index=glue.vertices)
|
| 477 |
+
|
| 478 |
+
rna.varm["X_glue"] = feature_embeddings.reindex(rna.var_names).to_numpy()
|
| 479 |
+
atac.varm["X_glue"] = feature_embeddings.reindex(atac.var_names).to_numpy()
|
| 480 |
+
|
| 481 |
+
# Create combined dataset for visualization
|
| 482 |
+
combined = ad.concat([rna, atac])
|
| 483 |
+
|
| 484 |
+
# Generate UMAP visualization
|
| 485 |
+
sc.pp.neighbors(combined, use_rep="X_glue", metric="cosine")
|
| 486 |
+
sc.tl.umap(combined)
|
| 487 |
+
sc.pl.umap(combined, color=color_vars, wspace=0.65)
|
| 488 |
+
|
| 489 |
+
# Save UMAP plot
|
| 490 |
+
if out_prefix is None:
|
| 491 |
+
out_prefix = f"glue_embeddings_{timestamp}"
|
| 492 |
+
|
| 493 |
+
umap_plot = OUTPUT_DIR / f"{out_prefix}_umap.png"
|
| 494 |
+
plt.savefig(str(umap_plot), dpi=300, bbox_inches="tight")
|
| 495 |
+
plt.close()
|
| 496 |
+
|
| 497 |
+
# Save h5ad files with embeddings
|
| 498 |
+
rna_output = OUTPUT_DIR / f"{out_prefix}_rna_emb.h5ad"
|
| 499 |
+
atac_output = OUTPUT_DIR / f"{out_prefix}_atac_emb.h5ad"
|
| 500 |
+
guidance_hvf_output = OUTPUT_DIR / f"{out_prefix}_guidance_hvf.graphml.gz"
|
| 501 |
+
|
| 502 |
+
rna.write(str(rna_output), compression="gzip")
|
| 503 |
+
atac.write(str(atac_output), compression="gzip")
|
| 504 |
+
nx.write_graphml(guidance_hvf, str(guidance_hvf_output))
|
| 505 |
+
|
| 506 |
+
# Return standardized format
|
| 507 |
+
return {
|
| 508 |
+
"message": f"Generated embeddings for {rna.n_obs} RNA and {atac.n_obs} ATAC cells",
|
| 509 |
+
"reference": "https://github.com/gao-lab/GLUE/blob/master/docs/training.ipynb",
|
| 510 |
+
"artifacts": [
|
| 511 |
+
{
|
| 512 |
+
"description": "RNA data with embeddings",
|
| 513 |
+
"path": str(rna_output.resolve()),
|
| 514 |
+
},
|
| 515 |
+
{
|
| 516 |
+
"description": "ATAC data with embeddings",
|
| 517 |
+
"path": str(atac_output.resolve()),
|
| 518 |
+
},
|
| 519 |
+
{
|
| 520 |
+
"description": "HVF guidance graph",
|
| 521 |
+
"path": str(guidance_hvf_output.resolve()),
|
| 522 |
+
},
|
| 523 |
+
{"description": "UMAP visualization", "path": str(umap_plot.resolve())},
|
| 524 |
+
],
|
| 525 |
+
}
|
tools/training_summary.md
ADDED
|
@@ -0,0 +1,133 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Training Tutorial - Tool Extraction Summary
|
| 2 |
+
|
| 3 |
+
## Source Information
|
| 4 |
+
- **Tutorial**: GLUE model training workflow
|
| 5 |
+
- **Source URL**: https://github.com/gao-lab/GLUE/blob/master/docs/training.ipynb
|
| 6 |
+
- **Notebook**: notebooks/training/training_execution_final.ipynb
|
| 7 |
+
- **Output File**: src/tools/training.py
|
| 8 |
+
|
| 9 |
+
## Extracted Tools
|
| 10 |
+
|
| 11 |
+
### 1. glue_configure_datasets
|
| 12 |
+
**Purpose**: Configure RNA-seq and ATAC-seq datasets for GLUE model training
|
| 13 |
+
|
| 14 |
+
**When to use**: First step in GLUE workflow after preprocessing; prepares datasets for model training
|
| 15 |
+
|
| 16 |
+
**Inputs**:
|
| 17 |
+
- `rna_path`: Preprocessed RNA-seq h5ad file
|
| 18 |
+
- `atac_path`: Preprocessed ATAC-seq h5ad file
|
| 19 |
+
- `guidance_path`: Guidance graph file
|
| 20 |
+
- Configuration parameters (prob_model, use_highly_variable, etc.)
|
| 21 |
+
|
| 22 |
+
**Outputs**:
|
| 23 |
+
- Configured RNA h5ad file
|
| 24 |
+
- Configured ATAC h5ad file
|
| 25 |
+
- HVF-filtered guidance graph
|
| 26 |
+
|
| 27 |
+
**Tutorial Section**: "Configure data"
|
| 28 |
+
|
| 29 |
+
---
|
| 30 |
+
|
| 31 |
+
### 2. glue_train_model
|
| 32 |
+
**Purpose**: Train GLUE model for multi-omics integration
|
| 33 |
+
|
| 34 |
+
**When to use**: After configuring datasets; core model training step
|
| 35 |
+
|
| 36 |
+
**Inputs**:
|
| 37 |
+
- `rna_path`: Configured RNA-seq h5ad file
|
| 38 |
+
- `atac_path`: Configured ATAC-seq h5ad file
|
| 39 |
+
- `guidance_hvf_path`: HVF-filtered guidance graph
|
| 40 |
+
- `training_dir`: Directory for model snapshots and logs (optional)
|
| 41 |
+
|
| 42 |
+
**Outputs**:
|
| 43 |
+
- Trained GLUE model (.dill file)
|
| 44 |
+
- Training logs directory
|
| 45 |
+
|
| 46 |
+
**Tutorial Section**: "Train GLUE model"
|
| 47 |
+
|
| 48 |
+
---
|
| 49 |
+
|
| 50 |
+
### 3. glue_check_integration_consistency
|
| 51 |
+
**Purpose**: Evaluate integration quality with consistency scores
|
| 52 |
+
|
| 53 |
+
**When to use**: After model training to validate integration quality
|
| 54 |
+
|
| 55 |
+
**Inputs**:
|
| 56 |
+
- `model_path`: Trained GLUE model file
|
| 57 |
+
- `rna_path`: Configured RNA-seq h5ad file
|
| 58 |
+
- `atac_path`: Configured ATAC-seq h5ad file
|
| 59 |
+
- `guidance_hvf_path`: HVF-filtered guidance graph
|
| 60 |
+
|
| 61 |
+
**Outputs**:
|
| 62 |
+
- Consistency scores table (CSV)
|
| 63 |
+
- Consistency plot (PNG)
|
| 64 |
+
|
| 65 |
+
**Tutorial Section**: "Check integration diagnostics"
|
| 66 |
+
|
| 67 |
+
**Interpretation**: Consistency scores above 0.05 indicate reliable integration
|
| 68 |
+
|
| 69 |
+
---
|
| 70 |
+
|
| 71 |
+
### 4. glue_generate_embeddings
|
| 72 |
+
**Purpose**: Generate cell and feature embeddings from trained GLUE model and visualize alignment
|
| 73 |
+
|
| 74 |
+
**When to use**: After successful model training and validation; produces final embeddings for downstream analysis
|
| 75 |
+
|
| 76 |
+
**Inputs**:
|
| 77 |
+
- `model_path`: Trained GLUE model file
|
| 78 |
+
- `rna_path`: Configured RNA-seq h5ad file
|
| 79 |
+
- `atac_path`: Configured ATAC-seq h5ad file
|
| 80 |
+
- `guidance_hvf_path`: HVF-filtered guidance graph
|
| 81 |
+
- `color_vars`: Variables to color UMAP by (default: ["cell_type", "domain"])
|
| 82 |
+
|
| 83 |
+
**Outputs**:
|
| 84 |
+
- RNA h5ad with cell and feature embeddings
|
| 85 |
+
- ATAC h5ad with cell and feature embeddings
|
| 86 |
+
- HVF guidance graph
|
| 87 |
+
- UMAP visualization (PNG)
|
| 88 |
+
|
| 89 |
+
**Tutorial Section**: "Apply model for cell and feature embedding"
|
| 90 |
+
|
| 91 |
+
---
|
| 92 |
+
|
| 93 |
+
## Typical Workflow
|
| 94 |
+
|
| 95 |
+
```
|
| 96 |
+
1. glue_configure_datasets
|
| 97 |
+
β (produces configured h5ad files + HVF guidance graph)
|
| 98 |
+
|
| 99 |
+
2. glue_train_model
|
| 100 |
+
β (produces trained model)
|
| 101 |
+
|
| 102 |
+
3. glue_check_integration_consistency
|
| 103 |
+
β (validates integration quality)
|
| 104 |
+
|
| 105 |
+
4. glue_generate_embeddings
|
| 106 |
+
β (produces final embeddings for downstream analysis)
|
| 107 |
+
```
|
| 108 |
+
|
| 109 |
+
## Key Design Decisions
|
| 110 |
+
|
| 111 |
+
1. **Parameter Preservation**: All function calls exactly match the tutorial - no additional parameters added
|
| 112 |
+
2. **Structure Preservation**: Data structures like lists are preserved exactly as in tutorial
|
| 113 |
+
3. **Input Design**: All tools use file paths as primary inputs for maximum reusability
|
| 114 |
+
4. **Workflow Integration**: Tools designed for sequential execution matching tutorial flow
|
| 115 |
+
5. **Output Completeness**: All code-generated figures and essential data are saved automatically
|
| 116 |
+
|
| 117 |
+
## Quality Validation
|
| 118 |
+
|
| 119 |
+
All 4 tools passed comprehensive quality review on first iteration:
|
| 120 |
+
- β Tool design validation
|
| 121 |
+
- β Input/output validation
|
| 122 |
+
- β Tutorial logic adherence validation
|
| 123 |
+
- β Implementation quality checks
|
| 124 |
+
- β Syntax and import verification
|
| 125 |
+
|
| 126 |
+
## Testing Readiness
|
| 127 |
+
|
| 128 |
+
The implementation is production-ready and follows all extraction guidelines:
|
| 129 |
+
- Conservative approach with exact tutorial fidelity
|
| 130 |
+
- Scientific rigor maintained throughout
|
| 131 |
+
- Real-world applicability for user data
|
| 132 |
+
- No mock data or demonstration code
|
| 133 |
+
- Ready for testing phase
|