Skip to content

Main

Main entry-point.

main #

main(dict_config: DictConfig) -> dict

Main entry point for training a model.

run #

run(
    experiment: Experiment,
) -> tuple[str, float | None, dict]

Run the experiment: training followed by evaluation.

Returns the metrics of the evaluation.

evaluation #

evaluation(
    experiment: Experiment,
) -> tuple[str, float | None, dict]

Return the classification error.

By default, if validation is to be performed, returns the validation error. Returns the training error when trainer.overfit_batches != 0 (e.g. when debugging or testing). Otherwise, if trainer.limit_val_batches == 0, returns the test error.