tft_start_updating_os

Function

Updates the optimizer state to Updating before the update process begins.

Format

mindio_ttp.framework_ttp.tft_start_updating_os(backup_step: int)

Parameters

Parameter

Mandatory/Optional

Description

Value

backup_step

Mandatory

Backup step.

-1 or a natural number. The value range is [-1, 9223372036854775807).

  • -1: indicates that the backup step is not used.
  • Natural number: step corresponding to the backup optimizer state data before the optimizer is updated.

Return Value

No return value. If an error occurs, an error log is recorded and an exception is thrown.