scvi.autotune.run_autotune

scvi.autotune.run_autotune(model_cls, data, metrics, mode, search_space, num_samples, scheduler='asha', searcher='hyperopt', seed=None, resources=None, experiment_name=None, logging_dir=None, scheduler_kwargs=None, searcher_kwargs=None)

BETA Run a hyperparameter sweep.

Parameters:

• model_cls (BaseModelClass) – Model class on which to tune hyperparameters.

• data (Union[AnnData, MuData, LightningDataModule]) – AnnData or MuData that has been setup with model_cls or a LightningDataModule (EXPERIMENTAL).

• metrics (str | list[str]) – Either a single metric or a list of metrics to track during the experiment. If a list is provided, the primary metric will be the first element in the list.

• mode (Literal['min', 'max']) – Optimization mode for the primary metric. One of "min" or "max".

• search_space (dict[str, dict[Literal['model_args', 'train_args'], dict[str, Any]]]) –

  Dictionary of hyperparameter names and their respective search spaces. See the API for available search specifications. Must only contain the following top-level keys:

  • "model_args": parameters to pass to the model constructor.

  • "train_args": parameters to pass to the model’s train method.

  Passed into Tuner as param_space.

• num_samples (int) – Total number of hyperparameter configurations to sample from the search space. Passed into TuneConfig.

• scheduler (Literal['asha', 'hyperband', 'median', 'fifo'] (default: 'asha')) –

  Ray Tune scheduler to use. One of the following:

  • "asha": AsyncHyperBandScheduler

  • "hyperband": HyperBandScheduler

  • "median": MedianStoppingRule

  • "fifo": FIFOScheduler

  Configured with reasonable defaults, which can be overridden with scheduler_kwargs.

• searcher (Literal['hyperopt', 'random'] (default: 'hyperopt')) –

  Ray Tune search algorithm to use. One of the following:

  • "hyperopt": HyperOptSearch

  • "random": BasicVariantGenerator

  Configured with reasonable defaults, which can be overridden with searcher_kwargs.

• seed (int | None (default: None)) – Random seed to use for the experiment. Propagated to seed and search algorithms. If not provided, defaults to seed.

• resources (dict[Literal['cpu', 'gpu', 'memory'], float] | None (default: None)) –

  Dictionary of resources to allocate per trial in the experiment. Available keys include:

  • "cpu": number of CPU cores

  • "gpu": number of GPUs

  • "memory": amount of memory

  Passed into with_resources().

• experiment_name (str | None (default: None)) – Name of the experiment, used for logging purposes. Defaults to a unique ID concatenated to the model class name.

• logging_dir (str | None (default: None)) – Base directory to store experiment logs. Defaults to :attr:scvi.settings.logging_dir.

• scheduler_kwargs (dict | None (default: None)) – Additional keyword arguments to pass to the scheduler.

• searcher_kwargs (dict | None (default: None)) – Additional keyword arguments to pass to the search algorithm.

Return type:

AutotuneExperiment

Returns:

AutotuneExperiment object containing the results of the hyperparameter sweep in result_grid.

Notes

Lifecycle: beta

See also

AutotuneExperiment