BSVAE Documentation
BSVAE is a CLI-first workflow for feature-level module discovery in omics data. It combines a Gaussian-mixture variational autoencoder with tools for model selection, network extraction, module assignment, latent analysis, and synthetic benchmarking.
Main Commands
Command |
Purpose |
|---|---|
|
Train a |
|
Select the number of modules with held-out validation and optional stability replicates |
|
Extract networks, modules, latents, and latent-analysis outputs from a trained model |
|
Generate synthetic datasets, build scenario grids, and benchmark recovery |
Data Orientation
Most commands expect an expression matrix in features x samples orientation:
rows are feature IDs
columns are sample IDs
CSV and TSV files use the first column as the feature index
Supported inputs:
.csv/.csv.gz.tsv/.tsv.gz.h5/.hdf5.h5adwith optionalanndata
Start Here
- Installation
- Quick Start
- Tutorial
- 1. Confirm The Data Layout
- 2. Run A Minimal Training Job
- 3. Select The Number Of Modules
- 4. Train A Final Model Directly
- 5. Extract Feature Networks
- 6. Extract Modules
- 7. Export Latents
- 8. Analyze The Latent Space
- 9. Generate Synthetic Data And Benchmark Recovery
- 10. Common Problems
- 11. Legacy Configuration Note
- Command-Line Interface
- Network And Latent Workflows
- Usage Guide
- Hyperparameters
- High-Performance Computing
- Frequently Asked Questions
- Contributing
- Model API
- Utility API