Generic helpers

xpmir.experiments.helpers.PaperExperiment: alias of ConfigurationBase

class xpmir.experiments.helpers.NeuralIRExperiment(*, id: str = '???', file: str = 'experiment', module: str | None = None, pythonpath: List[str] | None = None, parent: str | None = None, title: str = '', subtitle: str = '', paper: str = '', description: str = '', add_timestamp: bool = False, gpu: bool = True, use_best_device: bool = False, seed: int = 0)[source]

Bases: ConfigurationBase

Settings most neural IR experiments

gpu: bool: Use GPU for computation

seed: int: The seed used for experiments

use_best_device: bool: Use best GPU device

class xpmir.experiments.helpers.LauncherSpecification(*, requirements: str)[source]

Bases: object

Launcher specification

This allows requesting computational resources such as 2 GPUs with more than 12Go of memory)