set_user_data

Applicability

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

Function Description

Sets user information.

Prototype

set_user_data(self, user_data: bytearray, offset: int = 0)

Parameters

Parameter	Data Type	Description
user_data	bytearray	User-defined data.
offset	int	Offset of the user data, which must comply with the following restriction: Value range: [0, 64); size + offset ≤ 64

Parameter

Data Type

Description

user_data

bytearray

User-defined data.

offset

int

Offset of the user data, which must comply with the following restriction:

Value range: [0, 64); size + offset ≤ 64

Returns

None is returned in normal scenarios.

The dataflow.DfException exception is reported in abnormal scenarios. For details, see DataFlow Error Codes.

Examples

import dataflow as df
flow_info = FlowInfo(...)
user_data_str = "UserData123"
user_data_array = bytearray(user_data_str, 'utf-8')
flow_info.set_user_data(user_data_array)

Constraints

None

Parent topic: dataflow.FlowInfo