aclrtSetStreamFailureMode

Applicability

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

Description

Specifies the task scheduling mode to determine whether to continue the next task after a task fails, when multiple tasks are delivered to a stream.

Prototype

      
           aclError aclrtSetStreamFailureMode(aclrtStream stream, uint64_t mode)

Parameters

Parameter	Input/Output	Description
stream	Input	Stream to be operated. For details about the type definition, see aclrtStream. Products differ in their support for default streams (setting this parameter to NULL): Atlas 350 Accelerator Card: not supported Atlas A3 training product / Atlas A3 inference product : supported Atlas A2 training product / Atlas A2 inference product : supported Atlas 200I/500 A2 inference product : not supported Atlas inference product : not supported Atlas training product : not supported
mode	Input	When multiple tasks are delivered to a stream, you can use this parameter to specify the task scheduling mode to determine whether to continue the next task after a task fails. Value range: ACL_CONTINUE_ON_FAILURE: default value. If a task fails, the system continues to execute the next task. ACL_STOP_ON_FAILURE: If a task fails, the subsequent tasks are not executed. This mode is also called stop-on-failure. After the stop-on-failure mode is triggered, new tasks cannot be delivered.

Parameter

Input/Output

Description

stream

Input

Stream to be operated. For details about the type definition, see aclrtStream.

Products differ in their support for default streams (setting this parameter to NULL):

Atlas 350 Accelerator Card: not supported

Atlas A3 training product / Atlas A3 inference product : supported

Atlas A2 training product / Atlas A2 inference product : supported

Atlas 200I/500 A2 inference product : not supported

Atlas inference product : not supported

Atlas training product : not supported

mode

Input

When multiple tasks are delivered to a stream, you can use this parameter to specify the task scheduling mode to determine whether to continue the next task after a task fails.

Value range:

ACL_CONTINUE_ON_FAILURE: default value. If a task fails, the system continues to execute the next task.
ACL_STOP_ON_FAILURE: If a task fails, the subsequent tasks are not executed. This mode is also called stop-on-failure. After the stop-on-failure mode is triggered, new tasks cannot be delivered.

Returns

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

Restrictions

This API can be called only once for a specified stream to set the task scheduling mode.
If the stop-on-failure mode is set for a stream, the stop-on-failure mode also applies to other streams in the context of the stream. This restriction applies to the following product models:
Atlas A3 training product / Atlas A3 inference product

Atlas A2 training product / Atlas A2 inference product

Atlas 200I/500 A2 inference product

Atlas inference product

Atlas training product

API Call Example

For the API call example, see Task Stopping Upon Failure.

Parent topic: Stream Management