ml.utils.timer

Defines a timer context manager for timing code blocks.

This also provides a simple spinner for long-running tasks.

ml.utils.timer.allow_spinners() → bool

class ml.utils.timer.Spinner(text: str | None = None)

Bases: object

set_text(text: str) → Spinner

start() → None

stop() → None

close() → None

ml.utils.timer.spinner() → Spinner

class ml.utils.timer.Timer(description: str, min_seconds_to_print: float = 5.0, logger: Logger | None = None, spinner: bool = False)

Bases: ContextManager

Defines a simple timer for logging an event.

property elapsed_time: float

class ml.utils.timer.spinnerator(items: Sequence[T] | Iterable[T], desc: str | None = None, total: int | None = None, logger: Logger | None = None)

Bases: Generic[T]

Defines a spinning iterator which uses the built-in spinner.

property desc: str

classmethod range(start: int | None, stop: int | None = None, step: int = 1, desc: str | None = None, logger: Logger | None = None) → spinnerator[int]

update(n: int = 1) → None

ml.utils.timer.timeout(seconds: int, error_message: str = 'Timer expired') → Callable[[Callable[[P], T]], Callable[[P], T]]

Decorator for timing out long-running functions.

Note that this function won’t work on Windows.

Parameters:

• seconds – Timeout after this many seconds

• error_message – Error message to pass to TimeoutError

Returns:

Decorator function