scvi._settings.ScviConfig

class scvi._settings.ScviConfig(verbosity=20, progress_bar_style='tqdm', batch_size=128, seed=0, logging_dir='./scvi_log/', dl_num_workers=0, dl_pin_memory_gpu_training=True)[source]

Config manager for scvi-tools.

Examples

To set the seed

>>> scvi.settings.seed = 1

To set the batch size for functions like SCVI.get_latent_representation

>>> scvi.settings.batch_size = 1024

To set the progress bar style, choose one of “rich”, “tqdm”

>>> scvi.settings.progress_bar_style = "rich"

To set the verbosity

>>> import logging
>>> scvi.settings.verbosity = logging.INFO

To set the number of threads PyTorch will use

>>> scvi.settings.num_threads = 2

Attributes

batch_size

Minibatch size for loading data into the model.

dl_num_workers

Number of workers for PyTorch data loaders (Default is 0).

dl_pin_memory_gpu_training

Set pin_memory in data loaders when using a GPU for training.

logging_dir

Directory for training logs (default ‘./scvi_log/’).

num_threads

Number of threads PyTorch will use.

progress_bar_style

Library to use for progress bar.

seed

Random seed for torch and numpy.

verbosity

Verbosity level (default logging.INFO).

Methods

reset_logging_handler()

Resets “scvi” log handler to a basic RichHandler().