94 lines (85 with data), 9.0 kB
a
¶Åña* ã @ s\ d Z ddlZddlZddlmZ ddlmZ ddlm Z ddl
m Z m Z G dd de
ZdS ) aC
Authors: Pinar Demetci, Rebecca Santorella
Principal Investigator: Ritambhara Singh, Ph.D. from Brown University
12 February 2020
Updated: 27 November 2020
SCOT algorithm (version 1): Single Cell alignment using Optimal Transport
Correspondence: pinar_demetci@brown.edu, rebecca_santorella@brown.edu, ritambhara@brown.edu
é N)Údijkstra)Ú
csr_matrix)Úkneighbors_graph)ÚStandardScalerÚ normalizec
@ sn e Zd ZdZdd Zdd Zd dd Zd d d
Zdd Zd ddZ d ddZ
d!ddZ d"ddZ d#dd Z
dS )$ÚSCOTa
SCOT algorithm for unsupervised alignment of single-cell multi-omic data.
https://www.biorxiv.org/content/10.1101/2020.04.28.066787v2 (original preprint)
https://www.liebertpub.com/doi/full/10.1089/cmb.2021.0446 (Journal of Computational Biology publication through RECOMB 2021 conference)
Input: domain1, domain2 in form of numpy arrays/matrices, where the rows correspond to samples and columns correspond to features.
Returns: aligned domain 1, aligned domain 2 in form of numpy arrays/matrices projected on domain 1
Example use:
# Given two numpy matrices, domain1 and domain2, where the rows are cells and columns are different genomic features:
scot= SCOT(domain1, domain2)
aligned_domain1, aligned_domain2 = scot.align(k=20, e=1e-3)
#If you can't pick the parameters k and e, you can try out our unsupervised self-tuning heuristic by running:
scot= SCOT(domain1, domain2)
aligned_domain1, aligned_domain2 = scot.align(selfTune=True)
Required parameters:
- k: Number of neighbors to be used when constructing kNN graphs. Default= min(min(n_1, n_2), 50), where n_i, for i=1,2 corresponds to the number of samples in the i^th domain.
- e: Regularization constant for the entropic regularization term in entropic Gromov-Wasserstein optimal transport formulation. Default= 1e-3
Optional parameters:
- normalize= Determines whether to normalize input data ahead of alignment. True or False (boolean parameter). Default = True.
- norm= Determines what sort of normalization to run, "l2", "l1", "max", "zscore". Default="l2"
- mode: "connectivity" or "distance". Determines whether to use a connectivity graph (adjacency matrix of 1s/0s based on whether nodes are connected) or a distance graph (adjacency matrix entries weighted by distances between nodes). Default="connectivity"
- metric: Sets the metric to use while constructing nearest neighbor graphs. some possible choices are "correlation", "minkowski". "correlation" is Pearson's correlation and "minkowski" is equivalent to Euclidean distance in its default form (). Default= "correlation".
- verbose: Prints loss while optimizing the optimal transport formulation. Default=True
- XontoY: Determines the direction of barycentric projection. True or False (boolean parameter). If True, projects domain1 onto domain2. If False, projects domain2 onto domain1. Default=True.
Note: If you want to specify the marginal distributions of the input domains and not use uniform distribution, please set the attributes p and q to the distributions of your choice (for domain 1, and 2, respectively)
after initializing a SCOT class instance and before running alignment and set init_marginals=False in .align() parameters
c C sF || _ || _d | _d | _d | _d | _d | _d | _d | _d | _ d | _
d S )N) ÚXÚyÚpÚqÚCxÚCyÚcouplingÚgwdistÚflagÚ X_alignedÚ y_aligned)ÚselfZdomain1Zdomain2© r úB/Users/pinardemetci/Documents/newSCOT/SCOT/examples/../src/scot.pyÚ__init__; s z
SCOT.__init__c C s, t | jjd ¡| _t | jjd ¡| _d S )Nr )ÚotZunifr Úshaper
r r )r r r r Úinit_marginalsM s zSCOT.init_marginalsÚl2Tc C s |dv sJ d|dks |d kr&d}nd}|dkrXt }| | j¡| | j¡ | _| _n&t| j||dt| j||d | _| _d S )N)Úl1r ÚmaxÚzscorezåNorm argument has to be either one of 'max', 'l1', 'l2' or 'zscore'. If you would like to perform another type of normalization, please give SCOT the normalize data and set the argument normalize=False when running the algorithm.Té r r )ÚnormÚaxis)r Z
fit_transformr r r )r r ZbySampler Zscalerr r r r R s zSCOT.normalizeÚ connectivityÚ correlationc C sZ |dv sJ d|dkr d}nd}t | j||||d| _t | j||||d| _| j| jfS )N)r! ZdistancezENorm argument has to be either one of 'connectivity', or 'distance'. r! TF)ÚmodeÚmetricÚ include_self)r r ÚXgraphr Úygraph)r Úkr# r$ r% r r r Úconstruct_grapha s zSCOT.construct_graphc C s t t| jddd}t t| jddd}t ||tjk ¡}t ||tjk ¡}||||k< ||||k< || ¡ | _|| ¡ | _ | j| j fS )NF)ZcsgraphZdirectedZreturn_predecessors)
r r r& r' ÚnpZnanmaxÚinfr r r
)r ZX_shortestPathZy_shortestPathZX_maxZy_maxr r r Úinit_distancesm s zSCOT.init_distancesc
C s t jj| j| j| j| jd|d|d\| _}|d | _t
| j¡ ¡ st | jj dd ¡st | jj dd ¡st t | jdk rd | _
nd| _
| jS )
NZ square_lossT)Zloss_funÚepsilonÚlogÚverboseZgw_distr ©r r gffffffî?F)r ZgromovZentropic_gromov_wassersteinr r
r
r r r r* ZisnanÚanyÚsumr )r Úer/ r. r r r Úfind_correspondences~ s *
NzSCOT.find_correspondencesc C s |r@| j | _tj| jdd}t | j| j ¡|d d
d f | _n@| j| _tj| jdd}t t | j¡| j¡|d d
d f | _| j| jfS )Nr r0 ) r r r* r2 r Úmatmulr r Z transpose)r ÚXontoYZweightsr r r Úbarycentric_projection s $(zSCOT.barycentric_projectionNçü©ñÒMbP?Fc
C sÊ |r| j |d |
r | ¡ | r.| ¡ \} } n|d krdtt| jjd d t| jjd d fd}| j|ddd | ¡ | j
||d | j d kr t d
d S | j
|d \} } | | | _| _| j| jfS ) N©r r gÉ?é2 r! r" ©r# r$ ©r3 r/ FzCONVERGENCE ERROR: Optimization procedure runs into numerical errors with the hyperparameters specified. Please try aligning with higher values of epsilon.)r6 )r r Úunsupervised_scotÚminÚintr r r r) r, r4 r Úprintr7 r r )
r r( r3 r# r$ r/ r r r6 ZselfTuner r r r r r Úalign s" .
z
SCOT.alignc C s: |r| j |d |r | ¡ t|t| } t | ¡}
t | ¡} t | ¡} d}
d}d\}}d\}}|D ]¬}| j|||d | ¡ |D ]}t|d| td|d| | j|dd | j r|rà||
|< || |< | j
| |< t| j
| j
|
k r| ¡ \}}| j
}
|| }}|d }qqf|r(||| |
| fS |||
||fS d
S ) zÃ
Performs a hyperparameter sweep for given values of k and epsilon
Default: return the parameters corresponding to the lowest GW distance
(Optional): return all k, epsilon, and GW values
r9 r )NNr; ú/z Aligning k: z and e: Fr< N) r r Úlenr* Zzerosr) r, r@ r4 r r r7 )r ÚksÚesÚ
all_valuesr# r$ r r r ÚtotalZk_sweepZe_sweepZgw_sweepZgminÚcounterr r Úe_bestÚk_bestr( r3 r r r Ú search_scot± sB
zSCOT.search_scotc C s® t | jjd | jjd }t |d d}d}d}t dd|¡}|dkrVt dd |¡}nt |d |d
|¡}| t¡}| j ||d ||d d \} }
} } }
t
d
| |
f | |
fS )z|
Unsupervised hyperparameter tuning algorithm to find an alignment
by using the GW distance as a measure of alignment
r é r: é éÿÿÿÿéýÿÿÿéú é éd é F)rF r r r zAlignment completed. Hyperparameters selected from the unsupervised hyperparameter sweep are: %d for number of neighbors k and %f for epsilon) r> r r r r* ZlogspaceZlinspaceZastyper? rK r@ )r r r ÚnZk_startZnum_epsZnum_krE rD r r Zg_bestrJ rI r r r r= ê s
zSCOT.unsupervised_scot)r T)r! r" )T)T)
Nr8 r! r" TTr TFT)Fr! r" Tr T)Fr )Ú__name__Ú
__module__Ú __qualname__Ú__doc__r r r r) r, r4 r7 rA rK r= r r r r r s "
9r )rX Znumpyr* r Zscipy.sparse.csgraphr Z scipy.sparser Zsklearn.neighborsr Zsklearn.preprocessingr r Úobjectr r r r r Ú<module> s
Datasets
Models
