scvi.criticism.create_criticism_report#
- scvi.criticism.create_criticism_report(model, adata=None, skip_metrics=(), n_samples=5, label_key=None, save_folder=None)[source]#
Helper function to compute and store criticism metrics for a model.
- Parameters:
model (
BaseModelClass) – Model to compute metrics on.adata (
AnnData|MuData|None(default:None)) – AnnOrMuData to compute metrics on.skip_metrics (
list(default:())) – List of metrics to skip. Can be one of [“cv_cell”, “cv_gene”, “diff_exp”].n_samples (
int(default:5)) – Number of samples to use for posterior predictive check.label_key (
str|None(default:None)) – Key in adata.obs to use as cell type labels. If None, will use the original label key from the model.save_folder (
str|None(default:None)) – Path to folder for storing the metrics. Preferred to store in save_path folder of model.
- Return type: