Supported methods¶
The canonical list of what --method accepts, what each value resolves to, and which
tasks support it. scfoundry list methods prints the same information from the registry
that ships with the package.
Task support matrix¶
Method |
Category |
GPU |
|
|
|
|
|---|---|---|---|---|---|---|
|
zero-shot |
yes |
✓ |
✓ |
✓ |
— |
|
zero-shot |
yes |
✓ |
✓ |
✓ |
✓ |
|
zero-shot |
yes |
✓ |
✓ |
✓ |
✓ |
|
zero-shot |
yes |
✓ |
✓ |
✓ |
✓ |
|
zero-shot |
yes |
✓ |
✓ |
✓ |
✓ |
|
zero-shot |
no |
✓ |
✓ |
✓ |
— |
|
zero-shot |
yes |
✓ |
✓ |
✓ |
✓ |
|
zero-shot |
yes |
✓ |
✓ |
✓ |
✓ |
|
zero-shot |
yes |
✓ |
✓ |
✓ |
✓ (linear probing) |
|
zero-shot |
yes |
✓ |
✓ |
✓ |
✓ |
|
zero-shot |
yes |
✓ |
✓ |
✓ |
✓ |
|
zero-shot |
yes |
✓ |
✓ |
✓ |
— |
|
zero-shot |
yes |
✓ |
✓ |
✓ |
— |
|
zero-shot |
yes |
✓ |
✓ |
✓ |
— |
|
zero-shot |
yes |
✓ |
✓ |
— |
— |
|
reference |
no |
— |
✓ |
— |
— |
|
reference |
yes |
✓ |
✓ |
✓ |
— |
|
integration |
yes |
— |
✓ |
— |
— |
|
integration |
yes |
— |
✓ |
— |
— |
|
integration |
no |
— |
✓ |
— |
— |
|
integration |
no |
— |
✓ |
— |
— |
|
integration |
no |
— |
✓ |
— |
— |
Three categories:
zero-shot — pretrained foundation models with frozen weights. What the benchmark ranks.
reference —
pca, the classical yardstick, andscvi, zero-shot projection onto the pretrained CELLxGENE Census scVI: a pretrained model rather than a baseline, kept apart from the transformer scFMs the paper counts.integration — methods trained on the input using its batch labels. Accepted by
embedonly, and ranked separately in every result table.
finetune lists only methods whose official adaptation updates weights; the models whose
authors adapt them with a classifier on frozen embeddings (genept, scimilarity,
scprint, uce) are covered by transfer --classifier mlp. scCello’s official recipe is
linear probing on the frozen encoder and is kept under finetune for that reason.
Cell2Sentence fine-tuning is not yet supported, and novae — a spatial model — only
embeds.
Models and containers¶
Method |
Name |
Category |
Container image |
Default checkpoint ( |
Upstream version |
|---|---|---|---|---|---|
|
Cell2Sentence |
zero-shot |
|
|
v1.2.0 |
|
CELLama |
zero-shot |
|
|
v0.1.0 |
|
CellFM |
zero-shot |
|
|
commit |
|
CellPLM |
zero-shot |
|
|
v0.1.0 |
|
Geneformer |
zero-shot |
|
|
V2-316M |
|
GenePT-w |
zero-shot |
|
|
commit |
|
LangCell |
zero-shot |
|
|
commit |
|
scBERT |
zero-shot |
|
|
v1.0.0 |
|
scCello |
zero-shot |
|
|
commit |
|
scFoundation |
zero-shot |
|
|
commit |
|
scGPT |
zero-shot |
|
|
v0.2.4 |
|
SCimilarity |
zero-shot |
|
|
v0.4.1 (model v1.1) |
|
scPRINT |
zero-shot |
|
|
2.3.8 (checkpoint |
|
UCE |
zero-shot |
|
|
commit |
|
Novae (spatial) |
zero-shot |
|
|
|
|
PCA |
reference |
|
none |
scanpy HVG(2000) → scale → PCA(50) |
|
scVI (Census) |
reference |
|
|
Census 2024-07-01 Homo sapiens |
|
scGPT (integrated) |
integration |
|
|
scGPT_human fine-tuned with DSBN + DAB + GEPC + ECS |
|
scVI (de novo) |
integration |
|
none (trained on the input) |
scvi-tools |
|
Harmony |
integration |
|
none |
Seurat v5 |
|
Seurat CCA |
integration |
|
none |
Seurat v5 |
|
Seurat RPCA |
integration |
|
none |
Seurat v5 |
Every image is pulled automatically on first use and cached under
cache/.shared/nxf_singularity/ in the workspace. Upstream versions are the revision each
container was built from — cite the upstream project, not this table, when you report
results. Links are on the citation page.
Three entries do not follow the --model pattern:
genept—--modelis a selector, not a path. OnlyGenePT/ada-002(1536-d) andGenePT/model-3-large(3072-d) are recognised.langcell— the checkpoint path is fixed toLangCell/ckpt; there is no--model.scvi— the pretrained Census model is selected with--scvi_model.
Method-specific parameters¶
Parameters that exist for one method only, forwarded as --name value. Shared parameters
are in the parameter reference.
Method |
Parameter |
Default |
Effect |
|---|---|---|---|
|
|
|
Number of expression bins used to discretise counts. |
|
|
|
Transformer layers to use from the checkpoint. |
|
|
|
Gene-selection strategy for building the input sequence. |
|
|
|
Maximum genes per cell. |
|
|
|
Cells per intermediate checkpoint during inference. |
|
|
|
Pooling over token embeddings. |
|
|
|
Fine-tuning learning rate, schedule and gradient clipping ( |
|
|
|
Highest-expressed genes used to build each cell’s sentence. |
|
|
|
Same, when re-embedding with the fine-tuned backbone. |
|
|
|
Whether to run inference on the GPU. |
|
|
|
Pretrained Census model. |
|
|
|
Whether to run inference on the GPU. |
|
|
|
Latent dimensions; training epochs ( |
|
|
|
Fine-tuning epochs, batch size and highly variable genes. |
|
|
|
Highly variable genes and principal components computed before integration. |
|
|
|
Highly variable genes retained; principal components, and therefore output dimensions. |
Default batch sizes¶
Inference batch size for embed (and the embedding step of transfer). The variation is
real — models differ by orders of magnitude in memory per cell.
|
Methods |
Note |
|---|---|---|
|
|
Lightweight encoder over a fixed gene panel. |
|
|
Small models. |
|
|
The transformer default. |
|
|
Long sequences and a large model. |
|
|
A 410M-parameter autoregressive language model. |
not used |
|
These declare no |
Fine-tuning uses separate parameters with their own per-method defaults — see Fine-tune.
The PCA reference¶
Worth documenting precisely, because it is the yardstick every foundation model is measured against:
normalize_total(target_sum=1e4)
log1p
highly_variable_genes(n_top_genes=2000, flavor="seurat")
subset to HVGs
scale(max_value=10)
pca(n_comps=50, svd_solver="arpack", random_state=0)
This is the standard Scanpy workflow with default settings, deliberately unoptimised. It needs no checkpoint and runs on the CPU in seconds.
See also
Parameter reference — every parameter, grouped by task.
Output reference — where each task writes.
Adding a method — wrapping a model that is not listed here.