scvi.train.TrainerConfig

class scvi.train.TrainerConfig(accelerator=None, devices=None, benchmark=True, check_val_every_n_epoch=None, max_epochs=400, default_root_dir=None, enable_checkpointing=False, checkpointing_monitor='validation_loss', num_sanity_val_steps=0, enable_model_summary=False, early_stopping=False, early_stopping_monitor='elbo_validation', early_stopping_min_delta=0.0, early_stopping_patience=45, early_stopping_warmup_epochs=0, early_stopping_mode='min', enable_progress_bar=True, progress_bar_refresh_rate=1, simple_progress_bar=True, logger=None, log_every_n_steps=10, learning_rate_monitor=False, log_save_dir=None, extra_kwargs=<factory>)

Config for Trainer.

Attributes table

accelerator
benchmark
check_val_every_n_epoch
checkpointing_monitor
default_root_dir
devices
early_stopping
early_stopping_min_delta
early_stopping_mode
early_stopping_monitor
early_stopping_patience
early_stopping_warmup_epochs
enable_checkpointing
enable_model_summary
enable_progress_bar
learning_rate_monitor
log_every_n_steps
log_save_dir
logger
max_epochs
num_sanity_val_steps
progress_bar_refresh_rate
simple_progress_bar
extra_kwargs

Methods table

to_kwargs()

Attributes

TrainerConfig.accelerator: str | Accelerator | None = None

TrainerConfig.benchmark: bool = True

TrainerConfig.check_val_every_n_epoch: int | None = None

TrainerConfig.checkpointing_monitor: str = 'validation_loss'

TrainerConfig.default_root_dir: str | None = None

TrainerConfig.devices: list[int] | str | int | None = None

TrainerConfig.early_stopping: bool = False

TrainerConfig.early_stopping_min_delta: float = 0.0

TrainerConfig.early_stopping_mode: Literal['min', 'max'] = 'min'

TrainerConfig.early_stopping_monitor: Literal['elbo_validation', 'reconstruction_loss_validation', 'kl_local_validation'] = 'elbo_validation'

TrainerConfig.early_stopping_patience: int = 45

TrainerConfig.early_stopping_warmup_epochs: int = 0

TrainerConfig.enable_checkpointing: bool = False

TrainerConfig.enable_model_summary: bool = False

TrainerConfig.enable_progress_bar: bool = True

TrainerConfig.learning_rate_monitor: bool = False

TrainerConfig.log_every_n_steps: int = 10

TrainerConfig.log_save_dir: str | None = None

TrainerConfig.logger: Logger | None | bool = None

TrainerConfig.max_epochs: int = 400

TrainerConfig.num_sanity_val_steps: int = 0

TrainerConfig.progress_bar_refresh_rate: int = 1

TrainerConfig.simple_progress_bar: bool = True

TrainerConfig.extra_kwargs: dict[str, Any]

Methods

TrainerConfig.to_kwargs()

Return type:

dict[str, Any]