Function: set_stream_overflow_switch

Applicability

Product	Supported
Atlas 350 Accelerator Card	√
Atlas A3 training product/Atlas A3 inference product	√
Atlas A2 training product/Atlas A2 inference product	√
Atlas training product	x
Atlas inference product	x
Atlas 200I/500 A2 inference product	x

Description

Enables or disables the overflow 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 detection operator to check whether a task overflows.

Prototype

C Prototype

aclError aclrtSetStreamOverflowSwitch(aclrtStream stream, uint32_t flag)

Python Function

ret = acl.rt.set_stream_overflow_switch(stream, flag)

Parameters

Parameter	Description
stream	Int, pointer address of the specified stream. If 0 is passed, the default stream will be operated.
flag	Int, overflow detection switch. The options are as follows: 0: disabled 1: enabled

Parameter

Description

stream

Int, pointer address of the specified stream. If 0 is passed, the default stream will be operated.

flag

Int, overflow detection switch. The options are as follows:

0: disabled
1: enabled

Return Value

Return Value	Description
ret	Int, error code. 0 on success; else, failure.

Restrictions

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

Parent topic: Streams Management