kd.train.Setup

class kauldron.train.Setup(

*,

tags: str | list[str] = <factory>,

tqdm_info: kauldron.train.setup_utils.TqdmInfo = <factory>,

eval_only: bool = False,

preemptable_eval: bool = False,

)

Bases: object

Setup/environment options.

tags

Custom XManager tags.

Type:

str | list[str]

tqdm_info

Customize the tqdm bar.

Type:

kauldron.train.setup_utils.TqdmInfo

add_flatboard

Whether to create the flatboard dashboards.

flatboard_build_context

Shared info to build the flatboard dashboards. This object is created once globally and shared between all the metrics Writer, to ensure all dashboards are written to the same collection.

eval_only

Whether the job is a eval-only job.

Type:

bool

preemptable_eval

If True, makes eval preemptible.

Type:

bool

tags: str | list[str]

tqdm_info: kauldron.train.setup_utils.TqdmInfo

eval_only: bool = False

preemptable_eval: bool = False

run(trainer: trainer_lib.Trainer) → None

Perform the initial setup.

log_status(msg: str) → None