Function: set_stamp_trace_message

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

Atlas inference product

Atlas 200I/500 A2 inference product

Description

Sets string description in a 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)
    

Parameters

Parameter

Description

stamp

Int, stamp pointer address, indicating the msproftx event stamp. This specifies the pointer to the Function: create_stamp API.

msg

Int, string content address.

msg_len

Int, length of a string.

Return Value

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.