aclrtSetStreamOverflowSwitch

Applicability

Product	Supported
Atlas A3 training products/Atlas A3 inference products	√
Atlas A2 training products/Atlas A2 inference products	√
Atlas 200I/500 A2 inference products	x
Atlas inference products	x
Atlas training products	x

Description

Enables or disables the overflow/underflow detection function for a specified stream when the upper-layer training framework (such as PyTorch) is connected in saturation mode. After the function is disabled, you cannot use the overflow/underflow detection operator to check whether a task overflows or underflows.

Prototype

aclError aclrtSetStreamOverflowSwitch(aclrtStream stream, uint32_t flag)

Parameters

Parameter	Input/Output	Description
stream	Input	Stream to be operated. If NULL is passed, the default stream will be operated.
flag	Input	Overflow/Underflow detection switch. The options are as follows: 0: disabled. 1: enabled.

Parameter

Input/Output

Description

stream

Input

Stream to be operated.

If NULL is passed, the default stream will be operated.

flag

Input

Overflow/Underflow detection switch. The options are as follows:

0: disabled.
1: enabled.

Returns

0 on success; else, failure. For details, see aclError.

Restrictions

Before calling this API, you can call aclrtSetDeviceSatMode to set the saturation mode.
The setting takes effect only for tasks created after this API call.

Parent topic: Stream Management