Function: set_stamp_trace_message

Applicability

Product

Supported (√/x)

Atlas A3 training products / Atlas A3 inference products

Atlas A2 training products / Atlas A2 inference products

Atlas training products

Atlas inference products

Atlas 200I/500 A2 inference products

Function Usage

Sets string description in an msproftx event stamp, which is parsed and exported in the msprof_tx summary data of the Profiling tool.

Prototype

  • C Prototype
    1
    aclError aclprofSetStampTraceMessage(void *stamp, const char *msg, uint32_t msgLen)
    
  • Python Function
    1
    ret = acl.prof.set_stamp_trace_message(stamp, msg, msg_len)
    

Parameter Description

Parameter

Description

stamp

Int, stamp pointer address, indicating the msproftx event stamp. Specifies the pointer address of the Function: create_stamp API.

msg

Int, string content address.

msg_len

Int, length of a string.

Return Value Description

Return Value

Description

ret

Int, error code.

  • 0 indicates success.
  • Other values indicate failure.

Restrictions

This API must be called between Function: create_stamp and Function: destroy_stamp.

Reference

For the API call example, see Profile Data Collection.