aclrtSetStreamFailureMode

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	√
Atlas inference products	√
Atlas training products	√

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. The task scheduling mode of the default stream (that is, this parameter is set to NULL) cannot be specified.
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. Format range is as follows: 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.

The task scheduling mode of the default stream (that is, this parameter is set to NULL) cannot be specified.

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.

Format range is as follows:

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; else, 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 products/Atlas A3 inference products

Atlas A2 training products/Atlas A2 inference products

Atlas 200I/500 A2 inference products

Atlas inference products

Atlas training products

Parent topic: Stream Management