vis4d.zoo.base.runtime

Default runtime configuration for the project.

Functions

get_default_callbacks_cfg(output_dir[, ...])

Get default callbacks config.

get_default_cfg(exp_name[, work_dir])

Set default config for the project.
get_default_callbacks_cfg(output_dir, checkpoint_period=1, epoch_based=True, refresh_rate=50)[source]

Get default callbacks config.

It will return a list of callbacks config including:

  • LoggingCallback

  • CheckpointCallback

Parameters:

  • output_dir (str | FieldReference) – Output directory.

  • checkpoint_period (int, optional) – Checkpoint period. Defaults to 1.

  • epoch_based (bool, optional) – Whether to use epoch based logging.

  • refresh_rate (int, optional) – Refresh rate for the logging. Defaults to 50.

Returns:

List of callbacks config.

Return type:

list[ConfigDict]

get_default_cfg(exp_name, work_dir='vis4d-workspace')[source]

Set default config for the project.

Parameters:

  • exp_name (str) – Experiment name.

  • work_dir (str, optional) – Working directory. Defaults to “vis4d-workspace”.

Returns:

Config for the project.

Return type:

ExperimentConfig