FedscGen: privacy-preserving federated batch effect correction of single-cell RNA sequencing data
FedscGen is a federated learning framework for privacy-aware batch effect correction in single-cell RNA sequencing (scRNA-seq) data. It enables multiple institutions to collaboratively train a shared variational autoencoder (VAE) model without exchanging raw data. Each site trains a local model and securely shares only model parameters with a central coordinator, which aggregates them to update the global model. After training, the shared model is used to extract latent representations of cells across sites. For each shared cell type, dominant batches are identified, and corresponding mean latent features are calculated and aggregated in a privacy-preserving manner. These latent shifts are then used to locally correct batch effects, allowing new or existing clients to harmonize their datasets while maintaining full control over their data.
🔧 Setup Environment
To reproduce the results of the paper, please follow the instructions to create two Conda environments:
fedscgen: Python environment for FedscGen.r_eval: R + Python environment for benchmarking.
Set up a Python environment for FedscGen:
conda env create -f environment.yml
conda activate fedscgen
export SKLEARN_ALLOW_DEPRECATED_SKLEARN_PACKAGE_INSTALL=True
pip install crypten==0.4.1
Set up an R environment for running kBET and LISI for evaluation:
conda env create -f r_eval.yml
conda activate r_eval
Rscript install_libraries.R
Dataset and Models
For reproducibility, please ensure the preprocessed datasets are downloaded and extracted to the data/datasets directory. Optionally, the initial models can also be downloaded to the models/ directory.
📊 Reproduce Results
All models are initialized using a fixed seed for reproducibility.
Navigate to the experiments/ directory and run experiments.sh
while providing a comma-separated list of GPU indices to use for training. For example, to use GPUs 0 and 1:
conda activate fedscgen
cd experiments
chmod +x experiment.sh
./experiment.sh 0,1
Once the experiments are complete, run the evaluation metrics by navigating to the metrics/ directory and executing evaluate.sh:
conda activate r_eval
cd metrics
chmod +x evaluation.sh
./evaluation.sh
All results will be saved in the results/ directory. Both scripts will automatically fully utilize the available system resources.
app
FedscGen is implemented for real-world federated collaboration as a FeatureCloud app with automated deployment.
- Explore the app: FedscGen App on FeatureCloud
- Source code: fc-fedscgen GitHub Repository
License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
Metadata
Release files for fedscgen 0.1.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 |
|---|---|---|---|---|
| fedscgen-0.1.1.tar.gz | 32.3 kB | Without provenance | Details for fedscgen-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| fedscgen-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for fedscgen-0.1.1-py3-none-any.whl |
Total release size: 62.5 kB
Release files / fedscgen-0.1.1.tar.gz
| Download URL | fedscgen-0.1.1.tar.gz |
|---|---|
| Size | 32.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
59289830decb52dd96a97ec96dee7ad20b719d6d77b05681498b369ceb469bee
|
|
BLAKE2b-256 checksum How to use checksums |
010ceddac7f033485ad3a01793b80a72dcf159c0c05ebc3694d09fbc809cbf38
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.7
|
Release files / fedscgen-0.1.1-py3-none-any.whl
| Download URL | fedscgen-0.1.1-py3-none-any.whl |
|---|---|
| Size | 30.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d702f9bc0eada268e86e6f2e84a5f2fa428eb0298fbd6614f1aef92c7592b94e
|
|
BLAKE2b-256 checksum How to use checksums |
195072809a255afd3b5392170ba7f0f9310053a7b2f6697282986b01022d8bf8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.7
|
Security for fedscgen 0.1.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.