The current run¶

get_run ¶

get_run() -> Run

The run most recently made by :func:init or :meth:Run.attach in this process.

A disabled run when there is none, so code that logs through it still runs where nothing was started. A finished run is returned as it is, and warns when it is used, which is more use than silence.

shortcuts ¶

Log through the current run, for code that cannot pass a Run around.

A helper deep in a training codebase can call visin.log_epoch(...) without being handed the run: these functions use the run most recently made by visin.init or Run.attach (see :func:visin.get_run). With none, they do nothing, like a disabled run. They take exactly what the Run methods take; see those for the arguments.

log_epoch ¶

log_epoch(*args: Any, **kwargs: Any) -> str | None

:meth:Run.log_epoch on the current run.

log_test_results ¶

log_test_results(*args: Any, **kwargs: Any) -> str | None

:meth:Run.log_test_results on the current run.

log_benchmark ¶

log_benchmark(*args: Any, **kwargs: Any) -> None

:meth:Run.log_benchmark on the current run.

log_config ¶

log_config(*args: Any, **kwargs: Any) -> None

:meth:Run.log_config on the current run.

log_model ¶

log_model(*args: Any, **kwargs: Any) -> str | None

:meth:Run.log_model on the current run.

save_model ¶

save_model(*args: Any, **kwargs: Any) -> str | None

:meth:Run.save_model on the current run.

upload_visualization ¶

upload_visualization(*args: Any, **kwargs: Any) -> None

:meth:Run.upload_visualization on the current run.

update ¶

update(*args: Any, **kwargs: Any) -> None

:meth:Run.update on the current run.

finish ¶

finish(*args: Any, **kwargs: Any) -> None

:meth:Run.finish on the current run.