SetSkipBufferWindowCopy

Function Usage

Sets the location where the communication algorithm obtains the input data.

Prototype

1
uint32_t SetSkipBufferWindowCopy(uint8_t skipBufferWindowCopy)

Parameters

Table 1 Parameters

Parameter

Input/Output

Description

skipBufferWindowCopy

Input

Location where the communication algorithm obtains the input data, which is of the uint8_t type.

For the Atlas A2 training product/Atlas A2 inference product, the parameter values are as follows:

  • 0: The communication input is not stored in the windows. If this API is not called to set the location of the communication input, the communication input is not stored in the windows by default. The windows are the shared buffers that can be accessed by other ranks.
  • 1: The communication input is not stored in Windows. The function is the same whether this parameter is set to 1 or 0.
  • 2: The communication input is stored in Windows, which applies only to the AllReduce and AlltoAll algorithms.

For the Atlas A3 training product/Atlas A3 inference product, this parameter is reserved and does not take effect after being configured.

Returns

  • 0: Setting succeeded.
  • Other values: Setting failed.

Restrictions

None

Examples

For details about the calling example of this API, see Examples.