tft_init_controller

Function

Initializes the MindIO TFT Controller module.

Format

mindio_ttp.framework_ttp.tft_init_controller(rank: int, world_size: int, enable_local_copy: bool, enable_arf=False, enable_zit=False)

Parameters

Parameter

Mandatory/Optional

Description

Value

rank

Mandatory

Rank ID of the NPU on which a training job is being executed.

int, [-1, world_size). The value is -1 when Controller is started by MindCluster in the Torch Agent process.

world_size

Mandatory

Number of NPUs that participate in training jobs in a cluster.

int, [1, 100000].

enable_local_copy

Mandatory

Whether to enable local copy. The optimizer needs to be backed up before it is updated.

  • False: disabled
  • True: enabled

enable_arf

Optional

Whether to enable MindIO ARF.

  • False: disabled
  • True: enabled

The default value is False.

enable_zit

Optional

Whether to enable MindIO ZIT.

  • False: disabled
  • True: enabled

The default value is False.

Return Value

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