TemporalVAE
Temporal mapping of single cells from time-series atlas with time-predicting VAE
Reproducibility
For reproducibility of the manuscript's analyses, the scripts for generating figures are available at TemporalVAE-reproducibility folder/submodule.
Installation
Quick install can be achieved via pip (python >=3.8; 3.10 to 3.12 were tested)
Step 0: create a conda environment and activate it:
conda create -n tvae python=3.12
conda activate tvae
# Optional: add jupyter lab kernal
pip install ipykernel
python -m ipykernel install --user --name tvae --display-name "tvae"
Step 1: install TemporalVAE from GitHub:
# for published version
pip install -U TemporalVAE
# or developing version
pip install -U git+https://github.com/StatBiomed/TemporalVAE
Quick Usage
Reference examples can be found at examples folder, including
-
training: hEmbryo8_training.ipynb
-
cross-validation: hEmbryo8_Xiang_CV.ipynb
-
predicting: [TO BE ADDED]
Future plan for easier use
Here are the future plan for easier use (TO IMPLEMENT):
- Import TemporalVAE and create an object of the class TVAE.
import TemporalVAE as tvae
tvae_model = tvae.TVAE()
tvae_model.fit(X_atlas, t_atlas)
# predict query or training data
Z_query, y_query = tvae_model.predict(X_query)
Z_atlas, y_atlas = tvae_model.predict(X_atlas)
- Map to the same UMAP as the reference data
import UMAP
umap_model = UMAP.umap()
umap_model.fit(Z_atlas)
atlas_umap = umap_model.transform(Z_atlas)
query_umap = umap_model.transform(Z_query)
Reference
Liu Y., Cai F., Barile M., Chang Y., Cao D., and Huang Y. "TemporalVAE: atlas-assisted temporal mapping of time-series single-cell transcriptomes during embryogenesis." Nature Cell Biology, 2025 (in press).
Metadata
Release files for TemporalVAE 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| temporalvae-1.0.1.tar.gz | 3.4 MB | Without provenance | Details for temporalvae-1.0.1.tar.gz |
Release files / temporalvae-1.0.1.tar.gz
| Download URL | temporalvae-1.0.1.tar.gz |
|---|---|
| Size | 3.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0954118dfbf881f4ea7545835e729c733a189358902ebec1faf5671b96a387f1
|
|
BLAKE2b-256 checksum How to use checksums |
88743134136d853edd644b7037ced3a140df8b515f4a2ffa50d4ac8c3db96dcb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.11
|
Security for TemporalVAE 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.