ksuit.utils.training.counter¶

Classes¶

UpdateCounter is used to track the current update, epoch, and sample

class ksuit.utils.training.counter.UpdateCounter(start_iteration, end_iteration, updates_per_epoch, effective_batch_size)¶

UpdateCounter is used to track the current update, epoch, and sample number during training.

Initializes UpdateCounter.

Parameters:

start_iteration (ksuit.utils.training.training_iteration.TrainingIteration) – The iteration (measured in either epochs, updates, or samples) at which the training will start. If the training is resumed the values will be updated accordingly.
end_iteration (ksuit.utils.training.training_iteration.TrainingIteration) – The iteration (measured in either epochs, updates, or samples) at which the training will end.
updates_per_epoch (int) – Number of updates per epoch.
effective_batch_size (int) – Effective batch size.

property is_full_epoch: bool¶

Returns True if the current update is a full epoch.

property epoch_as_float: float¶

Returns the current epoch as a float value.

property epoch: int | None¶

Returns the current epoch.

property update: int | None¶

Returns the current update.

property sample: int | None¶

Returns the current sample.

property is_finished: bool¶

Returns True if the end checkpoint is reached.

next_epoch()¶

Increments the current epoch by 1.

next_update()¶

Increments the current update by 1.

add_samples(num_samples)¶

Adds samples to the current sample count.