Class Timestamp

composer/core/time.py:461–1025

Timestamp represents a snapshot of the current training progress. The timestamp measures training progress in terms of iterations, epochs, batches, samples, tokens, and wall clock time. Timestamps are not updated in-place. See the :doc:`Time Guide ` for more details on t

class Timestamp(Serializable):
    """Timestamp represents a snapshot of the current training progress.

    The timestamp measures training progress in terms of iterations, epochs, batches, samples, tokens, and wall clock time.
    Timestamps are not updated in-place.

    See the :doc:`Time Guide </trainer/time>` for more details on tracking time during training.

    Args:
        iteration (int | Time[int], optional): The iteration.
        epoch (int | Time[int], optional): The epoch.
        batch (int | Time[int], optional): the batch.
        sample (int | Time[int], optional): The sample.
        token (int | Time[int], optional): The token.
        epoch_in_iteration (int | Time[int], optional): The epoch in the iteration.
        token_in_iteration (int | Time[int], optional): The token in the iteration.
        batch_in_epoch (int | Time[int], optional): The batch in the epoch.
        sample_in_epoch (int | Time[int], optional): The sample in the epoch.
        token_in_epoch (int | Time[int], optional): The token in the epoch.
        total_wct (datetime.timedelta, optional): The total wall-clock duration.
        iteration_wct (datetime.timedelta, optional): The wall-clock duration of the current iteration.
        epoch_wct (datetime.timedelta, optional): The wall-clock duration of the current epoch.
        batch_wct (datetime.timedelta, optional): The wall-clock duration of the last batch.
    """

    def __init__(
        self,
        iteration: Union[int, Time[int]] = 0,
        epoch: Union[int, Time[int]] = 0,
        batch: Union[int, Time[int]] = 0,
        sample: Union[int, Time[int]] = 0,
        token: Union[int, Time[int]] = 0,
        epoch_in_iteration: Union[int, Time[int]] = 0,
        token_in_iteration: Union[int, Time[int]] = 0,
        batch_in_epoch: Union[int, Time[int]] = 0,
        sample_in_epoch: Union[int, Time[int]] = 0,
        token_in_epoch: Union[int, Time[int]] = 0,
        total_wct: Optional[datetime.timedelta] = None,
        iteration_wct: Optional[datetime.timedelta] = None,
        epoch_wct: Optional[datetime.timedelta] = None,
        batch_wct: Optional[datetime.timedelta] = None,
    ):
        iteration = Time.from_input(iteration, TimeUnit.ITERATION)
        if iteration.unit != TimeUnit.ITERATION:
            raise ValueError(f'The `iteration` argument has units of {iteration.unit}; not {TimeUnit.ITERATION}.')
        self._iteration = iteration

        epoch = Time.from_input(epoch, TimeUnit.EPOCH)
        if epoch.unit != TimeUnit.EPOCH:
            raise ValueError(f'The `epoch` argument has units of {epoch.unit}; not {TimeUnit.EPOCH}.')
        self._epoch = epoch

        batch = Time.from_input(batch, TimeUnit.BATCH)
        if batch.unit != TimeUnit.BATCH:
            raise ValueError(f'The `batch` argument has units of {batch.unit}; not {TimeUnit.BATCH}.')
        self._batch = batch

        sample = Time.from_input(sample, TimeUnit.SAMPLE)